cosmos::SysString Struct Reference

Wrapper type around a C-style string for use with system APIs. More...

#include <SysString.hxx>

Public Member Functions
	SysString (const std::string &str)
	SysString (const char *str)
const char *	raw () const
size_t	length () const
bool	empty () const
std::string	str () const
std::string_view	view () const
	operator std::string () const
	operator std::string_view () const
SysString &	operator= (const char *str)
SysString &	operator= (const std::string &str)
bool	operator== (const SysString &other) const
bool	operator!= (const SysString &other) const

Protected Attributes
const char *	m_ptr = nullptr

Detailed Description

Wrapper type around a C-style string for use with system APIs.

This type is used in place of a plain const char* to pass string data to system APIs and vice versa.

This type can be constructed from a plain const char* or from a std::string. It cannot be constructed from a std::string_view(), since this would need to create a copy. std::string_view needs not to be null terminated, but system APIs require null terminated strings. To pass a std::string_view you need to explicitly convert it into a std::string instead. This is similar to the behaviour of STL APIs where an implicit conversion from std::string_view to std::string is not available.

This is only a lightweight container that is mostly intended for passing strings back and forth to lower level APIs. There is no ownership tracking here, the object only carries a flat copy of whatever string was passed into it. So take care not to use an instance of this type after the backing object has lost validity.

Definition at line 33 of file SysString.hxx.

Constructor & Destructor Documentation

SysString() [1/2]

cosmos::SysString::SysString ( const std::string & str )

inline

Definition at line 37 of file SysString.hxx.

                                        :
                        m_ptr{str.c_str()} {}

SysString() [2/2]

cosmos::SysString::SysString ( const char * str )

inline

Definition at line 40 of file SysString.hxx.

                                   :
                        m_ptr{str} {}

Member Function Documentation

empty()

bool cosmos::SysString::empty ( ) const

inline

Definition at line 51 of file SysString.hxx.

                           {
                return !m_ptr || m_ptr[0] == '\0';
        }

length()

size_t cosmos::SysString::length ( ) const

inline

Definition at line 47 of file SysString.hxx.

                              {
                return view().length();
        }

operator std::string()

cosmos::SysString::operator std::string ( ) const

inline

Definition at line 63 of file SysString.hxx.

                                   {
                return str();
        }

operator std::string_view()

cosmos::SysString::operator std::string_view ( ) const

inline

Definition at line 67 of file SysString.hxx.

                                        {
                return view();
        }

operator!=()

bool cosmos::SysString::operator!= ( const SysString & other ) const

inline

Definition at line 91 of file SysString.hxx.

                                                      {
                return !(*this == other);
        }

operator=() [1/2]

SysString & cosmos::SysString::operator= ( const char * str )

inline

Definition at line 71 of file SysString.hxx.

                                              {
                m_ptr = str;
                return *this;
        }

operator=() [2/2]

SysString & cosmos::SysString::operator= ( const std::string & str )

inline

Definition at line 76 of file SysString.hxx.

                                                   {
                m_ptr = str.c_str();
                return *this;
        }

operator==()

bool cosmos::SysString::operator== ( const SysString & other ) const

inline

Definition at line 81 of file SysString.hxx.

                                                      {
                if (m_ptr == other.m_ptr)
                        return true;
 
                if (!m_ptr || !other.m_ptr)
                        return false;
 
                return std::strcmp(m_ptr, other.m_ptr) == 0;
        }

raw()

const char * cosmos::SysString::raw ( ) const

inline

Definition at line 43 of file SysString.hxx.

                                {
                return m_ptr ? m_ptr : "";
        }

str()

std::string cosmos::SysString::str ( ) const

inline

Definition at line 55 of file SysString.hxx.

                              {
                return m_ptr ? std::string{m_ptr} : std::string{};
        }

view()

std::string_view cosmos::SysString::view ( ) const

inline

Definition at line 59 of file SysString.hxx.

                                    {
                return m_ptr ? std::string_view{m_ptr} : std::string_view{};
        }

Member Data Documentation

m_ptr

const char* cosmos::SysString::m_ptr = nullptr

protected

Definition at line 97 of file SysString.hxx.

---

The documentation for this struct was generated from the following file:

• include/SysString.hxx