gbl::StringRef Class Reference

Public Member Functions
	StringRef (const char *pStr, std::size_t len=0) noexcept
	StringRef (const StringRef &rhs) noexcept
	StringRef (StringRef &&rhs) noexcept
StringRef	fromGblRef (GblStringRef *pRef) noexcept
GblStringRef *	toGblRef () noexcept
StringRef &	operator= (const char *pCStr) noexcept
StringRef &	operator= (const StringRef &rhs) noexcept
StringRef &	operator= (StringRef &&rhs) noexcept
	operator const char * () const noexcept
char	operator[] (std::size_t index) const
StringView	view (std::size_t offset=0, std::size_t len=0) const
std::size_t	refCount () const noexcept
std::size_t	length () const noexcept
bool	valid () const noexcept
bool	empty () const noexcept
bool	blank () const noexcept

Detailed Description

Definition at line 11 of file gimbal_string_ref.hpp.

Constructor & Destructor Documentation

StringRef() [1/3]

gbl::StringRef::StringRef ( const char *  pStr, std::size_t  len = 0  )

inlinenoexcept

Definition at line 19 of file gimbal_string_ref.hpp.

                                                         :
        pRef_(GblStringRef_create(pStr, len)) { }

StringRef() [2/3]

gbl::StringRef::StringRef ( const StringRef &  rhs )

inlinenoexcept

Definition at line 22 of file gimbal_string_ref.hpp.

                                            :
        pRef_(GblStringRef_ref(rhs.pRef_)) { }

StringRef() [3/3]

gbl::StringRef::StringRef ( StringRef &&  rhs )

inlinenoexcept

Definition at line 25 of file gimbal_string_ref.hpp.

                                       :
        pRef_(rhs.pRef_)
    {
        rhs.pRef_ = nullptr;
    }

~StringRef()

gbl::StringRef::~StringRef ( )

inlinenoexcept

Definition at line 43 of file gimbal_string_ref.hpp.

                          {
        GblStringRef_unref(pRef_);
    }

Member Function Documentation

fromGblRef()

StringRef gbl::StringRef::fromGblRef ( GblStringRef *  pRef )

inlinenoexcept

Definition at line 31 of file gimbal_string_ref.hpp.

                                                      {
        StringRef ref;
        ref.pRef_ = pRef;
        return ref;
    }

toGblRef()

GblStringRef * gbl::StringRef::toGblRef ( )

inlinenoexcept

Definition at line 37 of file gimbal_string_ref.hpp.

                                      {
        GblStringRef* pTemp = pRef_;
        pRef_ = nullptr;
        return pTemp;
    }

operator=() [1/3]

StringRef & gbl::StringRef::operator= ( const char *  pCStr )

inlinenoexcept

Definition at line 47 of file gimbal_string_ref.hpp.

                                                     {
        GblStringRef_unref(pRef_);
        GblStringRef_create(pCStr);
        return *this;
    }

operator=() [2/3]

StringRef & gbl::StringRef::operator= ( const StringRef &  rhs )

inlinenoexcept

Definition at line 53 of file gimbal_string_ref.hpp.

                                                        {
        GblStringRef_unref(pRef_);
        GblStringRef_ref(rhs.pRef_);
        return *this;
    }

operator=() [3/3]

StringRef & gbl::StringRef::operator= ( StringRef &&  rhs )

inlinenoexcept

Definition at line 59 of file gimbal_string_ref.hpp.

                                                   {
        GblStringRef_unref(pRef_);
        pRef_ = rhs.pRef_;
        rhs.pRef_ = nullptr;
        return *this;
    }

operator const char *()

gbl::StringRef::operator const char * ( ) const

inlinenoexcept

Definition at line 66 of file gimbal_string_ref.hpp.

                                          {
        return pRef_;
    }

operator[]()

char gbl::StringRef::operator[] ( std::size_t  index ) const

inline

Definition at line 70 of file gimbal_string_ref.hpp.

                                           {
        if(index >= length())
            throw std::out_of_range {
                "Attempt to index StringRef out-of-range!"
            };
 
        return pRef_[index];
    }

view()

StringView gbl::StringRef::view ( std::size_t  offset = 0, std::size_t  len = 0  ) const

inline

Definition at line 79 of file gimbal_string_ref.hpp.

                                                               {
        if(!len)
            len = length() - offset;
 
        if(offset + len > length())
            throw std::out_of_range {
                "Attempt to create out-of-range StringView from StringRef"
            };
 
 
        return GblStringView {
            .pData = pRef_ + offset,
            .nullTerminated = (offset + len == length()),
            .length = len
        };
    }

refCount()

std::size_t gbl::StringRef::refCount ( ) const

inlinenoexcept

Definition at line 96 of file gimbal_string_ref.hpp.

                                        {
        return GblStringRef_refCount(pRef_);
    }

length()

std::size_t gbl::StringRef::length ( ) const

inlinenoexcept

Definition at line 100 of file gimbal_string_ref.hpp.

                                      {
        return GblStringRef_length(pRef_);
    }

valid()

bool gbl::StringRef::valid ( ) const

inlinenoexcept

Definition at line 104 of file gimbal_string_ref.hpp.

                                {
        return GblStringRef_valid(pRef_);
    }

empty()

bool gbl::StringRef::empty ( ) const

inlinenoexcept

Definition at line 108 of file gimbal_string_ref.hpp.

                                {
        return GblStringRef_empty(pRef_);
    }

blank()

bool gbl::StringRef::blank ( ) const

inlinenoexcept

Definition at line 112 of file gimbal_string_ref.hpp.

                                {
        return GblStringRef_blank(pRef_);
    }

---

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

• gimbal_string_ref.hpp