SC::StringViewData Struct Reference

An read-only view over a string (to avoid including Strings library) More...

#include <StringViewData.h>

Inheritance diagram for SC::StringViewData:

Public Member Functions
constexpr	StringViewData (StringEncoding encoding=StringEncoding::Ascii)
	Construct an empty StringView.
constexpr	StringViewData (Span< const char > text, bool nullTerm, StringEncoding encoding)
	Construct a StringView from a Span of bytes.
template<size_t N>
constexpr	StringViewData (const char(&str)[N])
	Constructs a StringView with a null terminated string terminal.
Span< const char >	toCharSpan () const
	Obtain a const char Span from this StringView.
constexpr bool	isEmpty () const
	Return true if StringView is empty.
constexpr bool	isNullTerminated () const
	Check if StringView is immediately followed by a null termination character.
constexpr size_t	sizeInBytes () const
	Get size of the StringView in bytes.
constexpr StringEncoding	getEncoding () const
	Get encoding of this StringView.
constexpr const char *	bytesWithoutTerminator () const
	Directly access the memory of this StringView.
auto	getNullTerminatedNative () const
	Directly access the memory of this null terminated-StringView.

Static Public Member Functions
static constexpr StringViewData	fromNullTerminated (const char *text, StringEncoding encoding)
	Constructs a StringView from a null terminated string.

Protected Attributes
union {
const char *   text
};
size_t	textSizeInBytes: sizeof(size_t) * 8 - NumOptionBits
size_t	encoding: 2
size_t	hasNullTerm: 1

Static Protected Attributes
static constexpr size_t	NumOptionBits = 3
static constexpr size_t	MaxLength = (~static_cast<size_t>(0)) >> NumOptionBits

Detailed Description

An read-only view over a string (to avoid including Strings library)

Constructor & Destructor Documentation

StringViewData() [1/3]

SC::StringViewData::StringViewData ( StringEncoding encoding = StringEncoding::Ascii )

inlineconstexpr

Construct an empty StringView.

StringViewData() [2/3]

SC::StringViewData::StringViewData ( Span< const char > text, bool nullTerm, StringEncoding encoding )

inlineconstexpr

Construct a StringView from a Span of bytes.

Parameters

text	The span containing the text EXCLUDING eventual null terminator
nullTerm	true if a null terminator code point is expected to be found after Span. On ASCII and UTF8 this is 1 byte, on UTF16 it must be 2 bytes.
encoding	The encoding of the text contained in this StringView

StringViewData() [3/3]

template<size_t N>

SC::StringViewData::StringViewData ( const char(&) str[N] )

inlineconstexpr

Constructs a StringView with a null terminated string terminal.

Member Function Documentation

bytesWithoutTerminator()

const char * SC::StringViewData::bytesWithoutTerminator ( ) const

inlinenodiscardconstexpr

Directly access the memory of this StringView.

fromNullTerminated()

static constexpr StringViewData SC::StringViewData::fromNullTerminated ( const char * text, StringEncoding encoding )

inlinestaticconstexpr

Constructs a StringView from a null terminated string.

getEncoding()

StringEncoding SC::StringViewData::getEncoding ( ) const

inlinenodiscardconstexpr

Get encoding of this StringView.

getNullTerminatedNative()

auto SC::StringViewData::getNullTerminatedNative ( ) const

inlinenodiscard

Directly access the memory of this null terminated-StringView.

Returns

Pointer to start of StringView memory. On Windows return type will be const wchar_t*. On other platforms return type will be const char*.

isEmpty()

bool SC::StringViewData::isEmpty ( ) const

inlinenodiscardconstexpr

Return true if StringView is empty.

isNullTerminated()

bool SC::StringViewData::isNullTerminated ( ) const

inlinenodiscardconstexpr

Check if StringView is immediately followed by a null termination character.

sizeInBytes()

size_t SC::StringViewData::sizeInBytes ( ) const

inlinenodiscardconstexpr

Get size of the StringView in bytes.

toCharSpan()

Span< const char > SC::StringViewData::toCharSpan ( ) const

inlinenodiscard

Obtain a const char Span from this StringView.

---

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

• StringViewData.h