#include <UString.h>

Classes
class	IteratorBase

class	ReverseIteratorBase

Public Types
typedef UChar	value_type

using	Iterator = IteratorBase< std::string::iterator >

using	ConstIterator = IteratorBase< std::string::const_iterator >

using	ReverseIterator = ReverseIteratorBase< Iterator >

using	ConstReverseIterator = ReverseIteratorBase< ConstIterator >

using	iterator = Iterator

using	const_iterator = ConstIterator

using	reverse_iterator = ReverseIterator

using	const_reverse_iterator = ConstReverseIterator

Public Member Functions
	UString ()

	UString (const UString &other) USTRING_NOEXCEPT

	UString (const char *cstr) USTRING_NOEXCEPT

	UString (const std::string &str) USTRING_NOEXCEPT

	UString (UChar ch) USTRING_NOEXCEPT

UString &	insert (const UString &other, std::size_t pos)

UString &	assign (const UString &other)

UString &	assign (const char *other)

UString &	operator= (const UString &other)

UString &	operator= (const char *other)

UString &	append (UChar ch)

UString &	append (const UString &str)

UString &	append (const char *str)

UString &	operator+= (const char *str)

UString &	operator+= (const UString &str)

void	push_back (UChar ch)

void	push_back (const UString &str)

UString &	prepend (UChar ch)

UString &	prepend (const UString &str)

UString &	prepend (const char *str)

void	push_front (UChar ch)

void	push_front (const UString &str)

bool	operator== (const UString &other) const

bool	operator== (const char *other) const

bool	operator!= (const UString &other) const

bool	operator!= (const char *other) const

std::string	toStdString () const

std::u16string	toStdU16String () const

std::u32string	toStdU32String () const

UString &	toUpper ()

UString &	toLower ()

UString &	toTitleCase ()

const UChar	at (std::size_t idx) const

const UChar	operator[] (std::size_t idx) const

UString	subStr (std::size_t start, std::size_t len=npos) const

std::size_t	find (UChar ch, std::size_t start=0) const

std::size_t	find (const UString &what, std::size_t start=0) const

std::size_t	findLastOf (UChar ch, std::size_t pos=npos) const

std::size_t	findLastOf (const UString &what, std::size_t pos=npos) const

UString &	replace (std::size_t start, std::size_t len, const UString &with)

UString &	replaceAll (const UString &what, const UString &with, std::size_t start=0)

UString &	replaceFirst (const UString &what, const UString &with, std::size_t start=0)

UString &	replaceLast (const UString &what, const UString &with, std::size_t end=npos)

UString &	erase (const Iterator &start, const Iterator &stop)

UString &	clear ()

UString &	erase (std::size_t start, std::size_t num=1)

Iterator	begin ()

Iterator	end ()

ConstIterator	begin () const

ConstIterator	end () const

ReverseIterator	rbegin ()

ReverseIterator	rend ()

ConstReverseIterator	rbegin () const

ConstReverseIterator	rend () const

std::size_t	length () const

std::size_t	size () const

std::size_t	maxSize () const

Static Public Member Functions
static UString	fromStdU16String (const std::u16string &str)

static UString	fromStdU32String (const std::u32string &str)

Static Public Attributes
static const size_t	npos = std::string::npos

Detailed Description

UTF-8 Encoded String

Constructor & Destructor Documentation

UString::UString ( )

inline

Default constructor which creates an empty string.

UString::UString ( const UString & other )

Construct a UString as a copy of another UString.

Parameters

other UString to copy

UString::UString ( const char * cstr )

Construct a UString as a copy of another UString.

Parameters

cstr	C-string to copy.

UString::UString ( const std::string & str )

Construct a UString from a std::string

Parameters

str	std::string to copy.

UString::UString ( UChar ch )

explicit

Construct a UString as a copy of a C string.

Parameters

ch	UChar character to assign

Member Function Documentation

UString& UString::append ( UChar ch )

Append a character to the current string

Parameters

ch	Character to append

Returns: Reference to this object

UString& UString::append ( const UString & str )

Append a string to the current string

Parameters

str	String to append

Returns: Reference to this object

UString& UString::append ( const char * str )

Append a C-string to the current string

Parameters

str	C-string string to append

Returns: Reference to this object

UString& UString::assign ( const UString & other )

Assigns other to this string

Parameters

other String to assign

Returns: Reference to this object

UString& UString::assign ( const char * other )

Assigns other to this string

Parameters

other String to assign

Returns: Reference to this object

const UChar UString::at ( std::size_t idx ) const

Get character at position idx

Returns: Character

Iterator UString::begin ( )

inline

Returns a iterator pointing to the beginning of the string

Returns: Iterator pointing to the start of the string

ConstIterator UString::begin ( ) const

inline

Returns a constant iterator pointing to the beginning of the string

Returns: Iterator pointing to the start of the string

UString& UString::clear ( )

Clear this string

Returns: Reference to this object

Iterator UString::end ( )

inline

Returns a iterator pointing to the end of the string

Returns: Iterator pointing to the end of the string

ConstIterator UString::end ( ) const

inline

Returns a constant iterator pointing to the beginning of the string

Returns: Iterator pointing to the start of the string

UString& UString::erase	(	const Iterator &	start,
		const Iterator &	stop
	)

Erase character(s) at given index

Parameters

start	Iterator reference to position to begin erasing
stop	Iterator reference to position to stop erasing

Returns: Reference to this object

UString& UString::erase	(	std::size_t	start,
		std::size_t	num = `1`
	)

Erase character(s) in given iterator range

Parameters

start	Index of character to start erasing
num	Number of characters to erase

Returns: Reference to this object

std::size_t UString::find	(	UChar	ch,
		std::size_t	start = `0`
	)		const

Find a UChar character

Parameters

ch	character to find
start	Position to begin searching from

Returns: Position of the character if found, npos if not.

std::size_t UString::find	(	const UString &	what,
		std::size_t	start = `0`
	)		const

Find a string

Parameters

what	String to search for
start	Position to begin searching from

Returns: Position of the first character of the string if found, npos if not.

std::size_t UString::findLastOf	(	UChar	ch,
		std::size_t	pos = `npos`
	)		const

Find the last instance of a UChar character

Parameters

ch	Character to search for
pos	Position of last character to include in search

Returns: Position of the character of the string if found, npos if not.

std::size_t UString::findLastOf	(	const UString &	what,
		std::size_t	pos = `npos`
	)		const

Find the last instance of a string

Parameters

what	String to search for
pos	Position of last character to include in search

Returns: Position of the character of the string if found, npos if not.

static UString UString::fromStdU16String ( const std::u16string & str )

static

Convert a string from UTF-16 and return a new UTF-8 encoded string

Parameters

str	UTF-16 encoded string to convert

Returns: UTF-16 encoded string

static UString UString::fromStdU32String ( const std::u32string & str )

static

Convert a string from UTF-32 and return a new UTF-8 encoded string

Parameters

str	UTF-32 encoded string to convert

Returns: New UTF-8 encoded string

UString& UString::insert	(	const UString &	other,
		std::size_t	pos
	)

Inserts other string into this one at the given position

If the given position is greater than the length of this string it will be appended.

Parameters

other	String to insert
pos	Position of the string to insert at

Returns: Reference to this object

std::size_t UString::length ( ) const

Returns the length of characters in the string

Returns: The length of characters in the string starting from zero

std::size_t UString::maxSize ( ) const

Returns the maximum length the string can reach

From CplusPlus.com: This is the maximum potential length the string can reach due to known system or library implementation limitations, but the object is not guaranteed to be able to reach that length: it can still fail to allocate storage at any point before that length is reached.

bool UString::operator!= ( const UString & other ) const

Check if this string not equals the other.

Returns: True if not equal, False if equal

bool UString::operator!= ( const char * other ) const

Check if this string not equals the other.

Returns: True if not equal, False if equal

UString& UString::operator+= ( const char * str )

Append a C-string to the current string

Parameters

str	C-string string to append

Returns: Reference to this object

UString& UString::operator+= ( const UString & str )

Append a string to the current string

Parameters

str	String to append

Returns: Reference to this object

UString& UString::operator= ( const UString & other )

Assigns other to this string

Parameters

other String to assign

Returns: Reference to this object

UString& UString::operator= ( const char * other )

Assigns other to this string

Parameters

other String to assign

Returns: Reference to this object

bool UString::operator== ( const UString & other ) const

Check if this string equals the other.

Returns: True if equal, False if not

bool UString::operator== ( const char * other ) const

Check if this string equals the other.

Returns: True if equal, False if not

const UChar UString::operator[] ( std::size_t idx ) const

Get character at position idx

Returns: Character

UString& UString::prepend ( UChar ch )

Prepend a character to the current string

Parameters

ch	Character to prepend

Returns: Reference to this object

UString& UString::prepend ( const UString & str )

Prepend a string to the current string

Parameters

str	String to prepend

Returns: Reference to this object

UString& UString::prepend ( const char * str )

Prepend a C-string to the current string

Parameters

str	C-string to prepend

Returns: Reference to this object

void UString::push_back ( UChar ch )

Append a string to the current string

This is provided for STL compatibility and simply calls append()

Parameters

str	String to append

void UString::push_back ( const UString & str )

Append a string to the current string

This is provided for STL compatibility and simply calls append()

Parameters

str	String to append

void UString::push_front ( UChar ch )

Prepend a UChar to the current string

This is provieded for STL compatibility and simply calls prepend()

Parameters

ch	Character to append

void UString::push_front ( const UString & str )

Prepend a UString to the current string

This is provieded for STL compatibility and simply calls prepend()

Parameters

str	UString to append

ReverseIterator UString::rbegin ( )

inline

Returns a reverse iterator pointing to the reverse beginning of the string

Returns: Iterator pointing to the reverse beginning of the string

ConstReverseIterator UString::rbegin ( ) const

inline

Returns a constant reverse iterator pointing to the reverse beginning of the string

Returns: Iterator pointing to the reverse beginning of the string

ReverseIterator UString::rend ( )

inline

Returns a reverse iterator pointing to the reverse end of the string

Returns: Iterator pointing to the reverse end of the string

ConstReverseIterator UString::rend ( ) const

inline

Returns a constant reverse iterator pointing to the reverse end of the string

Returns: Iterator pointing to the reverse end of the string

UString& UString::replace	(	std::size_t	start,
		std::size_t	len,
		const UString &	with
	)

Replace part of this string with another string

Parameters

start	Start of the section to replace
len	Number of characters to replace counting from start
with	String to replace cut subsection with

Returns: Reference to this object

UString& UString::replaceAll	(	const UString &	what,
		const UString &	with,
		std::size_t	start = `0`
	)

Replace all instances of a string with another

Parameters

what	String to search for
with	String to use for replacement
start	The position to begin searching at

Returns: Reference to this object

UString& UString::replaceFirst	(	const UString &	what,
		const UString &	with,
		std::size_t	start = `0`
	)

Replace first instance of a string with another

Parameters

what	String to search for
with	String to use for replacement
start	The position to begin searching at

Returns: Reference to this object

UString& UString::replaceLast	(	const UString &	what,
		const UString &	with,
		std::size_t	end = `npos`
	)

Replace last instance of a string with another

Parameters

what	String to search for
with	String to use for replacement
end	The position to end our search at or npos

Returns: Reference to this object

std::size_t UString::size ( ) const

Returns the size of the string in bytes

Returns: The size of the string in bytes

UString UString::subStr	(	std::size_t	start,
		std::size_t	len = `npos`
	)		const

Create a new string using a sub-section of this string

Parameters

start	Position to start copying characters from
len	Number of characters to copy or until the end if len is npos

Returns: New string containing characters copied

UString& UString::toLower ( )

Convert any uppercase characters in the string to lower

Returns: Reference to this object

std::string UString::toStdString ( ) const

Convert to std::string.

Returns: std::string

std::u16string UString::toStdU16String ( ) const

Convert to UTF-16 and return it as a std::u16string

Returns: std::u16string

std::u32string UString::toStdU32String ( ) const

Convert to UTF-32 std::u32string.

Returns: std::u32string

UString& UString::toTitleCase ( )

Convert string to titleCase

Returns: Reference to this object

UString& UString::toUpper ( )

Convert any lowercase characters in the string to upper

Returns: Reference to this object

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

Include/UString/UString.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation