StormByte::String::String Class Reference

Owned UTF-8 text composed of StormByte::CString. More...

#include <StormByte/string/string.hxx>

Public Types
using	value_type = char
	Byte type.
using	const_iterator = const char *
	Contiguous observer.
using	const_reverse_iterator = std::reverse_iterator< const_iterator >
	Reverse observer.

Public Member Functions
void	swap (String &other) noexcept
	Swaps buffers with other.
Life
	String () noexcept
	Null text.
	String (const char *str) noexcept
	Copies a C string.
	String (std::string_view str) noexcept
	Copies a view into an owned NUL-terminated buffer.
	String (CString text) noexcept
	Takes an owned buffer.
	String (const WString &other) noexcept
	UTF-8 from wide text.
	String (const String &other) noexcept
	Copy constructor.
	String (String &&other) noexcept
	Move constructor.
	~String () noexcept=default
	Releases the buffer.
String &	operator= (const String &other) noexcept
	Copy assignment.
String &	operator= (String &&other) noexcept
	Move assignment.
Range
const_iterator	begin () const noexcept
	First character, or null.
const_iterator	end () const noexcept
	One past the last character, or null.
const_iterator	cbegin () const noexcept
	First character, or null.
const_iterator	cend () const noexcept
	One past the last character, or null.
const_reverse_iterator	rbegin () const noexcept
	Reverse begin.
const_reverse_iterator	rend () const noexcept
	Reverse end.
const_reverse_iterator	crbegin () const noexcept
	Reverse begin.
const_reverse_iterator	crend () const noexcept
	Reverse end.
const char *	data () const noexcept
	Contiguous pointer; null when the buffer is null.
std::size_t	size () const noexcept
	Byte count; 0 when null or empty.
std::size_t	length () const noexcept
	Same as size.
bool	empty () const noexcept
	Whether size is zero.
char	operator[] (std::size_t index) const noexcept
	Byte at index.
	operator bool () const noexcept
	Whether a buffer is held.
Conversions
	operator std::string_view () const noexcept
	Non-owning view of the text.
	operator std::string () const
	Copy of the text in the caller’s heap.
	operator const char * () const noexcept
	View of the owned buffer.
	operator WString () const noexcept
	Wide text (UTF-8 decoded in the module).
const CString &	Bytes () const noexcept
	Owned bytes.
Comparison
bool	operator== (const String &other) const noexcept
	Content equality.
bool	operator!= (const String &other) const noexcept
	Content inequality.
bool	operator== (const char *str) const noexcept
	Content equality with a C string.
bool	operator!= (const char *str) const noexcept
	Content inequality with a C string.
std::strong_ordering	operator<=> (const String &other) const noexcept
	Content order.
std::strong_ordering	operator<=> (const char *str) const noexcept
	Content order against a C string.

Helpers
String	ToLower () const noexcept
	ASCII-letter lower case of this text.
String	ToUpper () const noexcept
	ASCII-letter upper case of this text.
String	SanitizeNewlines () const noexcept
	CR LF to LF on this text.
String	RemoveWhitespace () const noexcept
	Drops isspace bytes from this text.
bool	IsInteger () const noexcept
	Whether this text is an integer token.
std::vector< String >	Split () const noexcept
	Whitespace-separated tokens.
std::queue< String >	Explode (char delimiter) const noexcept
	Tokens on delimiter.
static String	ToLower (std::string_view str) noexcept
	ASCII-letter lower case; UTF-8 otherwise copied.
static String	ToUpper (std::string_view str) noexcept
	ASCII-letter upper case; UTF-8 otherwise copied.
static String	SanitizeNewlines (std::string_view str) noexcept
	Turns CR LF into LF.
static String	RemoveWhitespace (std::string_view str) noexcept
	Drops isspace bytes.
static bool	IsInteger (std::string_view str) noexcept
	Optional sign plus ASCII digits.
static void	Split (std::string_view str, std::vector< String > &out) noexcept
	Whitespace-separated tokens.
static void	Explode (std::string_view str, char delimiter, std::queue< String > &out) noexcept
	Tokens on delimiter.

Detailed Description

Owned UTF-8 text composed of StormByte::CString.

UTF-8 counterpart of WString.

Not a std::string. Iterators are constant and contiguous so algorithms that read a range of char work. In-place mutating algorithms do not: helpers return a new String.

operator std::string_view is implicit and inline. operator std::string is explicit and inline (caller heap).

Conversion to WString is explicit and runs in the module (UTF-8 → wide). Conversion from WString copies UTF-8 in the module.

ToUpper / ToLower map only ASCII A–Z / a–z. Other well-formed UTF-8 code points are copied. Ill-formed bytes are copied one-by-one so a sequence is never split in the middle of a valid character.

Defined in string.hxx.

Member Typedef Documentation

const_iterator

using StormByte::String::String::const_iterator = const char*

Contiguous observer.

const_reverse_iterator

using StormByte::String::String::const_reverse_iterator = std::reverse_iterator<const_iterator>

Reverse observer.

value_type

using StormByte::String::String::value_type = char

Byte type.

Constructor & Destructor Documentation

String() [1/7]

StormByte::String::String::String ( )

noexcept

Null text.

String() [2/7]

StormByte::String::String::String ( const char *  str )

explicitnoexcept

Copies a C string.

Parameters

str	Source; may be null.

String() [3/7]

StormByte::String::String::String ( std::string_view  str )

explicitnoexcept

Copies a view into an owned NUL-terminated buffer.

Parameters

str

Source.

String() [4/7]

StormByte::String::String::String ( CString  text )

explicitnoexcept

Takes an owned buffer.

Parameters

text

Buffer.

String() [5/7]

StormByte::String::String::String ( const WString &  other )

explicitnoexcept

UTF-8 from wide text.

Parameters

other

Wide source.

String() [6/7]

StormByte::String::String::String ( const String &  other )

noexcept

Copy constructor.

Parameters

other

Text to copy.

String() [7/7]

StormByte::String::String::String ( String &&  other )

noexcept

Move constructor.

Parameters

other

Text to take. other becomes null.

~String()

StormByte::String::String::~String ( )

defaultnoexcept

Releases the buffer.

Member Function Documentation

begin()

const_iterator StormByte::String::String::begin ( ) const

inlinenoexcept

First character, or null.

Returns

Iterator.

Bytes()

const CString & StormByte::String::String::Bytes ( ) const

inlinenoexcept

Owned bytes.

Returns

Internal CString.

cbegin()

const_iterator StormByte::String::String::cbegin ( ) const

inlinenoexcept

First character, or null.

Returns

Iterator.

cend()

const_iterator StormByte::String::String::cend ( ) const

inlinenoexcept

One past the last character, or null.

Returns

Iterator.

crbegin()

const_reverse_iterator StormByte::String::String::crbegin ( ) const

inlinenoexcept

Reverse begin.

Returns

Reverse iterator.

crend()

const_reverse_iterator StormByte::String::String::crend ( ) const

inlinenoexcept

Reverse end.

Returns

Reverse iterator.

data()

const char * StormByte::String::String::data ( ) const

inlinenoexcept

Contiguous pointer; null when the buffer is null.

Returns

Pointer to the first byte.

empty()

bool StormByte::String::String::empty ( ) const

inlinenoexcept

Whether size is zero.

Returns

Emptiness. A null buffer is empty.

end()

const_iterator StormByte::String::String::end ( ) const

inlinenoexcept

One past the last character, or null.

Returns

Iterator.

Explode() [1/2]

std::queue< String > StormByte::String::String::Explode ( char  delimiter ) const

inlinenoexcept

Tokens on delimiter.

The queue is built in the caller.

Parameters

delimiter

Separator.

Returns

Tokens, including empty ones.

Explode() [2/2]

static void StormByte::String::String::Explode ( std::string_view  str, char  delimiter, std::queue< String > &  out  )

staticnoexcept

Tokens on delimiter.

out is the caller’s container.

Parameters

	str	Source.
	delimiter	Separator.
[out]	out	Tokens, including empty ones.

IsInteger() [1/2]

bool StormByte::String::String::IsInteger ( ) const

inlinenoexcept

Whether this text is an integer token.

Returns

Whether it matches IsInteger(std::string_view).

IsInteger() [2/2]

static bool StormByte::String::String::IsInteger ( std::string_view  str )

staticnoexcept

Optional sign plus ASCII digits.

Parameters

str

Source.

Returns

Whether str is an integer token.

length()

std::size_t StormByte::String::String::length ( ) const

inlinenoexcept

Same as size.

Returns

Length.

operator bool()

StormByte::String::String::operator bool ( ) const

inlineexplicitnoexcept

Whether a buffer is held.

Returns

false only for a null CString. "" is valid and empty.

operator const char *()

StormByte::String::String::operator const char * ( ) const

inlineexplicitnoexcept

View of the owned buffer.

Returns

Buffer, or null.

Note

Same lifetime as std::string::c_str().

operator std::string()

StormByte::String::String::operator std::string ( ) const

inlineexplicit

Copy of the text in the caller’s heap.

Returns

Empty string when the buffer is null.

operator std::string_view()

StormByte::String::String::operator std::string_view ( ) const

inlinenoexcept

Non-owning view of the text.

Returns

Empty view when the buffer is null.

Note

Same lifetime as std::string::c_str().

operator WString()

StormByte::String::String::operator WString ( ) const

explicitnoexcept

Wide text (UTF-8 decoded in the module).

Returns

Owned WString.

operator!=() [1/2]

bool StormByte::String::String::operator!= ( const char *  str ) const

inlinenoexcept

Content inequality with a C string.

Parameters

str	May be null.

Returns

Whether the texts differ.

operator!=() [2/2]

bool StormByte::String::String::operator!= ( const String &  other ) const

inlinenoexcept

Content inequality.

Parameters

other

Other text.

Returns

Whether the texts differ.

operator<=>() [1/2]

std::strong_ordering StormByte::String::String::operator<=> ( const char *  str ) const

inlinenoexcept

Content order against a C string.

Parameters

str	May be null.

Returns

Ordering.

operator<=>() [2/2]

std::strong_ordering StormByte::String::String::operator<=> ( const String &  other ) const

inlinenoexcept

Content order.

Null is less than any text.

Parameters

other

Other text.

Returns

Ordering.

operator=() [1/2]

String & StormByte::String::String::operator= ( const String &  other )

noexcept

Copy assignment.

Parameters

other

Text to copy.

Returns

*this.

operator=() [2/2]

String & StormByte::String::String::operator= ( String &&  other )

noexcept

Move assignment.

Parameters

other

Text to take. other becomes null.

Returns

*this.

operator==() [1/2]

bool StormByte::String::String::operator== ( const char *  str ) const

inlinenoexcept

Content equality with a C string.

Parameters

str	May be null.

Returns

Whether the texts are equal.

operator==() [2/2]

bool StormByte::String::String::operator== ( const String &  other ) const

inlinenoexcept

Content equality.

Parameters

other

Other text.

Returns

Whether the texts are equal.

operator[]()

char StormByte::String::String::operator[] ( std::size_t  index ) const

inlinenoexcept

Byte at index.

Parameters

index

Position in [0, size()]. size() is the trailing NUL.

Returns

Character.

Note

Null or index > size() is undefined and asserts when assertions are on.

rbegin()

const_reverse_iterator StormByte::String::String::rbegin ( ) const

inlinenoexcept

Reverse begin.

Returns

Reverse iterator.

RemoveWhitespace() [1/2]

String StormByte::String::String::RemoveWhitespace ( ) const

inlinenoexcept

Drops isspace bytes from this text.

Returns

New text.

RemoveWhitespace() [2/2]

static String StormByte::String::String::RemoveWhitespace ( std::string_view  str )

staticnoexcept

Drops isspace bytes.

Parameters

str

Source.

Returns

New text.

rend()

const_reverse_iterator StormByte::String::String::rend ( ) const

inlinenoexcept

Reverse end.

Returns

Reverse iterator.

SanitizeNewlines() [1/2]

String StormByte::String::String::SanitizeNewlines ( ) const

inlinenoexcept

CR LF to LF on this text.

Returns

New text.

SanitizeNewlines() [2/2]

static String StormByte::String::String::SanitizeNewlines ( std::string_view  str )

staticnoexcept

Turns CR LF into LF.

Parameters

str

Source.

Returns

New text.

size()

std::size_t StormByte::String::String::size ( ) const

inlinenoexcept

Byte count; 0 when null or empty.

Returns

Length.

Split() [1/2]

std::vector< String > StormByte::String::String::Split ( ) const

inlinenoexcept

Whitespace-separated tokens.

The vector is built in the caller.

Returns

Tokens.

Split() [2/2]

static void StormByte::String::String::Split ( std::string_view  str, std::vector< String > &  out  )

staticnoexcept

Whitespace-separated tokens.

out is the caller’s container.

Parameters

	str	Source.
[out]	out	Tokens.

swap()

void StormByte::String::String::swap ( String &  other )

noexcept

Swaps buffers with other.

Parameters

other

Other text.

ToLower() [1/2]

String StormByte::String::String::ToLower ( ) const

inlinenoexcept

ASCII-letter lower case of this text.

Returns

New text.

ToLower() [2/2]

static String StormByte::String::String::ToLower ( std::string_view  str )

staticnoexcept

ASCII-letter lower case; UTF-8 otherwise copied.

Parameters

str

Source.

Returns

New text.

ToUpper() [1/2]

String StormByte::String::String::ToUpper ( ) const

inlinenoexcept

ASCII-letter upper case of this text.

Returns

New text.

ToUpper() [2/2]

static String StormByte::String::String::ToUpper ( std::string_view  str )

staticnoexcept

ASCII-letter upper case; UTF-8 otherwise copied.

Parameters

str

Source.

Returns

New text.

---

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

• lib/public/StormByte/string/string.hxx