libzypp: zyppng::IdString Class Reference

libzypp 17.38.6

zyppng::IdString Class Reference

Access to the sat-pools string space. More...

`#include <zypp/IdString.h>`

## Public Types
using | IdType = sat::detail::IdType

## Public Member Functions
constexpr | IdString ()
| Default ctor, empty string.
constexpr | IdString (IdType id_r)
| Ctor from id.
| IdString (const char *str_r)
| Ctor from string.
| IdString (const char *str_r, unsigned len_r)
| Ctor from string (pointer,length).
| IdString (const std::string &str_r)
| Ctor from string.
| IdString (boost::string_ref str_r)
| Ctor from boost::string_ref.
constexpr | operator bool () const
| Evaluate in a boolean context ( != `Null` ).
constexpr bool | empty () const
| Whether the string is empty.
unsigned | size () const
| The strings size.
const char * | c_str () const
| Conversion to const char *.
std::string | asString () const
| Conversion to std::string.
| operator std::string () const
| Explicit conversion to std::string.
bool | compareEQ (const IdString &rhs) const
| Fast compare equal.
int | compare (const IdString &rhs) const
| Compare IdString returning -1,0,1.
int | compare (const char *rhs) const
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
int | compare (const std::string &rhs) const
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
IdType | id () const
| Expert backdoor.

## Static Public Attributes
static const IdString | Null
| No or Null string ( Id `0` ).
static const IdString | Empty
| Empty string.

## Private Attributes
IdType | _id

## Detailed Description

Access to the sat-pools string space.

Construction from string will place a copy of the string in the string space, if it is not already present.

While comparison differs between IdString::Null and IdString::Empty ( `NULL` and `""` ), both are represented by an empty string `""`.

Definition at line 51 of file IdString.h.

## Member Typedef Documentation

## ◆ IdType

using zypp::IdString::IdType = sat::detail::IdType

Definition at line 57 of file IdString.h.

## Constructor & Destructor Documentation

## ◆ IdString() [1/6]

zypp::IdString::IdString | ( |  | ) |
| inlineconstexpr

Default ctor, empty string.

Definition at line 61 of file IdString.h.

## ◆ IdString() [2/6]

zypp::IdString::IdString | ( | IdType | id_r | ) |
| inlineexplicitconstexpr

Ctor from id.

Definition at line 64 of file IdString.h.

## ◆ IdString() [3/6]

zypp::IdString::IdString | ( | const char * | str_r | ) |
| explicit

Ctor from string.

Definition at line 32 of file IdString.cc.

## ◆ IdString() [4/6]

zypp::IdString::IdString | ( | const char * | str_r,
|  | unsigned | len_r )

Ctor from string (pointer,length).

Definition at line 36 of file IdString.cc.

## ◆ IdString() [5/6]

zypp::IdString::IdString | ( | const std::string & | str_r | ) |
| explicit

Ctor from string.

Definition at line 40 of file IdString.cc.

## ◆ IdString() [6/6]

zypp::IdString::IdString | ( | boost::string_ref | str_r | ) |
| explicit

Ctor from boost::string_ref.

Definition at line 44 of file IdString.cc.

## Member Function Documentation

## ◆ operator bool()

zypp::IdString::operator bool | ( |  | ) | const
| inlineexplicitconstexpr

Evaluate in a boolean context ( != `Null` ).

Definition at line 93 of file IdString.h.

## ◆ empty()

bool zypp::IdString::empty | ( |  | ) | const
| inlineconstexpr

Whether the string is empty.

This is true for Null and Empty.

Definition at line 99 of file IdString.h.

## ◆ size()

unsigned zypp::IdString::size | ( |  | ) | const

The strings size.

Definition at line 48 of file IdString.cc.

## ◆ c_str()

const char * zypp::IdString::c_str | ( |  | ) | const

Conversion to const char *.

Definition at line 51 of file IdString.cc.

## ◆ asString()

std::string zypp::IdString::asString | ( |  | ) | const
| inline

Conversion to std::string.

Definition at line 110 of file IdString.h.

## ◆ operator std::string()

zypp::IdString::operator std::string | ( |  | ) | const
| inlineexplicit

Explicit conversion to std::string.

Definition at line 114 of file IdString.h.

## ◆ compareEQ()

bool zypp::IdString::compareEQ | ( | const IdString & | rhs | ) | const
| inline

Fast compare equal.

Definition at line 129 of file IdString.h.

## ◆ compare() [1/3]

int zypp::IdString::compare | ( | const IdString & | rhs | ) | const

Compare IdString returning -1,0,1.

Definition at line 54 of file IdString.cc.

## ◆ compare() [2/3]

int zypp::IdString::compare | ( | const char * | rhs | ) | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 66 of file IdString.cc.

## ◆ compare() [3/3]

int zypp::IdString::compare | ( | const std::string & | rhs | ) | const
| inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 139 of file IdString.h.

## ◆ id()

IdType zypp::IdString::id | ( |  | ) | const
| inline

Expert backdoor.

Definition at line 144 of file IdString.h.

## Member Data Documentation

## ◆ Null

const IdString zypp::IdString::Null
| static

No or Null string ( Id `0` ).

Definition at line 86 of file IdString.h.

## ◆ Empty

const IdString zypp::IdString::Empty
| static

Empty string.

Definition at line 89 of file IdString.h.

## ◆ _id

IdType zypp::IdString::_id
| private

Definition at line 148 of file IdString.h.

The documentation for this class was generated from the following files:

- zypp/IdString.h
- zypp/IdString.cc