This class represents the Arp String. The implementation is based on std::string. More...

#include <String.hpp>

Public Types
using	CharType = char
	The character type.

using	Allocator = std::allocator< CharType >
	The characters allocator type.

using	AllocatorTraits = std::allocator_traits< Allocator >
	The allocator traits type.

using	Char8uType = Arp::Base::Core::char8u
	The UTF8 character type.

using	BaseString = BasicString< CharType, Allocator >
	The type of the basic string.

using	StdString = BaseString::StdString
	The type of the basic std string.

using	Reference = typename BaseString::reference
	The reference type of this type.

using	ConstReference = typename BaseString::const_reference
	The const reference type of this type.

using	Iterator = typename BaseString::iterator
	The iterator type of this type.

using	ConstIterator = typename BaseString::const_iterator
	The const iterator type of this type.

using	ReverseIterator = typename BaseString::reverse_iterator
	The reverse iterator type of this type.

using	ConstReverseIterator = typename BaseString::const_reverse_iterator
	Used by Split() operations.

using	ThreeWayCompareResult = decltype(StdString()<=> StdString())
	Used by operator<=>

using	Tokens = std::vector< String >
	Used by initializing operations.

using	Bytes = std::vector< byte >

using	allocator_type = Allocator
	The allocator type of this type.

using	value_type = CharType
	The char type of this type.

using	size_type = typename BaseString::size_type
	The size type of this type.

using	difference_type = typename BaseString::difference_type
	The difference type of this type.

using	reference = typename BaseString::reference
	The reference type of this type.

using	const_reference = typename BaseString::const_reference
	The const reference type of this type.

using	pointer = typename AllocatorTraits::pointer
	The pointer type of this type.

using	const_pointer = typename AllocatorTraits::const_pointer
	The const pointer type of this type.

using	iterator = typename BaseString::iterator
	The iterator type of this type.

using	const_iterator = typename BaseString::const_iterator
	The const iterator type of this type.

using	reverse_iterator = typename BaseString::reverse_iterator
	The reverse iterator type of this type.

using	const_reverse_iterator = typename BaseString::const_reverse_iterator
	The const reverse iterator type of this type.

Public Member Functions
	String (void)
	The default constructor constructs an empty string instance.

	String (const String &arg)
	The copy constructor copies the as argument passed string deeply. More...

	String (String &&arg) noexcept
	This move constructor moves the as argument passed string to this string. More...

String &	operator= (const String &arg)
	This assignment operator copies the right-hand-side operand to this string. More...

String &	operator= (String &&arg) noexcept
	This move assignment operator moves the right-hand-side operand to this string. More...

	~String (void)
	The destructor deallocates all memory of this instance.

	String (const BaseString &arg)
	This constructor copies the as argument passed string. More...

	String (BaseString &&arg)
	This constructor moves the as argument passed string. More...

	String (const StdString &arg)
	This constructor copies the as argument passed string. More...

	String (StdString &&arg)
	This constructor moves the as argument passed string. More...

	String (const String &arg, size_type offset, size_type count=NPos)
	This constructor copies the as argument passed string partially. More...

	String (const CharType *pChars, size_type count)
	This constructor copies the as argument passed C-string. More...

	String (const CharType *pChars)
	This constructor copies the as argument passed C-string. More...

	String (const Char8uType *pChars)
	This constructor copies the as argument passed C-string. More...

	String (size_type count, CharType c)
	Fills the string with count consecutive copies of character c . More...

	String (std::initializer_list< CharType > arg)
	Copies each of the characters in initList , in the same order. More...

	String (Iterator first, Iterator last)
	Copies the sequence of characters in the range `[first,last)`, in the same order.. More...

	String (ConstIterator first, ConstIterator last)
	Copies the sequence of characters in the range `[first,last)`, in the same order.. More...

	String (const Bytes &bytes)
	Copies the as arguments passed bytes to this string. More...

	operator const CharType * (void) const
	Converts this string implicitly to a C-string. More...

	operator const StdString & (void) const
	Converts this string implicitly to a std string. More...

String &	operator= (std::initializer_list< CharType > right)
	This assignment operator copies each of the characters in the right-hand-side operand to this string, in the same order. More...

String &	operator= (const CharType *right)
	This assignment operator copies the right-hand-side operand to this string. More...

String &	operator= (CharType c)
	This assignment operator copies the right-hand-side operand to this string. More...

String &	operator+= (std::initializer_list< CharType > right)
	This assignment operator appends each of the characters in the right-hand-side operand to this string, in the same order. More...

String &	operator+= (const String &right)
	This assignment operator appends the right-hand-side operand to this string. More...

String &	operator+= (const CharType *right)
	This assignment operator appends the right-hand-side operand to this string. More...

String &	operator+= (CharType c)
	This assignment operator appends the right-hand-side operand to this string. More...

String &	Assign (const String &arg)
	This operation copies the argument to this string. More...

String &	Assign (String &&arg)
	This operation moves the as argument passed string to this string. More...

String &	Assign (const StdString &arg)
	This operation copies the argument to this string. More...

String &	Assign (StdString &&arg)
	This operation moves the argument to this string. More...

String &	Assign (std::initializer_list< CharType > arg)
	This operation copies each of the characters in the argument to this string, in the same order. More...

String &	Assign (const String &arg, size_type offset, size_type count=NPos)
	This operation copies the as argument passed string partially. More...

String &	Assign (const CharType *pChars, size_type count)
	This operation copies the as argument passed C-string partially. More...

String &	Assign (const CharType *pChars)
	This operation copies the as argument passed C-string. More...

String &	Assign (size_type count, CharType c)
	Fills this string with count consecutive copies of character c . More...

String &	Assign (Iterator first, Iterator last)
	Copies the sequence of characters in the range `[first,last)`, in the same order. More...

String &	Assign (ConstIterator first, ConstIterator last)
	Copies the sequence of characters in the range `[first,last)`, in the same order. More...

String &	Assign (const_pointer first, const_pointer last)
	Copies the sequence of characters in the range `[first,last)`, in the same order. More...

String &	Append (std::initializer_list< CharType > arg)
	This operation appends each of the characters in the argument to this string, in the same order. More...

String &	Append (const String &arg)
	This operation appends the argument to this string. More...

String &	Append (const String &arg, size_type offset, size_type count=NPos)
	This operation appends the as argument passed string partially. More...

String &	Append (const CharType *pChars, size_type count)
	This operation appends the as argument passed C-string partially. More...

String &	Append (const CharType *pChars)
	This operation appends the as argument passed C-string. More...

String &	Append (size_type count, CharType c)
	Appends to this string count consecutive copies of character c . More...

String &	Append (Iterator first, Iterator last)
	Appends the sequence of characters in the range `[first,last)`, in the same order. More...

String &	Append (ConstIterator first, ConstIterator last)
	Appends the sequence of characters in the range `[first,last)`, in the same order. More...

String &	Append (const_pointer first, const_pointer last)
	Appends the sequence of characters in the range `[first,last)`, in the same order. More...

String &	Insert (size_type offset, const String &arg)
	This operation inserts the argument at the given position. More...

String &	Insert (size_type offset, const String &arg, size_type argOffset, size_type count=NPos)
	This operation inserts the as argument passed string partially. More...

String &	Insert (size_type offset, const CharType *pChars, size_type count)
	This operation inserts the as argument passed string partially. More...

String &	Insert (size_type offset, const CharType *pChars)
	This operation inserts the as argument passed string. More...

String &	Insert (size_type offset, size_type count, CharType c)
	Inserts count consecutive copies of character c at position offset . More...

Iterator	Insert (ConstIterator where, CharType c)
	Inserts character c at position where . More...

Iterator	Insert (ConstIterator where, size_type count, CharType c)
	Inserts character c at position where . More...

Iterator	Insert (ConstIterator where, Iterator first, Iterator last)
	Inserts a range of chars `[first;last)` at position where . More...

Iterator	Insert (ConstIterator where, ConstIterator first, ConstIterator last)
	Inserts a range of chars `[first;last)` at position where . More...

Iterator	Insert (ConstIterator where, const_pointer first, const_pointer last)
	Inserts a range of chars `[first;last)` at position where . More...

Iterator	Insert (ConstIterator where, std::initializer_list< CharType > chars)
	This operation inserts each of the characters in the argument to this string, in the same order. More...

String &	Erase (size_type offset=0)
	This operation erases chars from this string. More...

String &	Erase (size_type offset, size_type count)
	This operation erases chars from this string. More...

Iterator	Erase (ConstIterator where)
	This operation erases chars from this string. More...

Iterator	Erase (ConstIterator first, ConstIterator last)
	Erases a range of chars `[first;last)`. More...

String &	Replace (ConstIterator first, ConstIterator last, std::initializer_list< CharType > chars)
	Replaces a range of chars `[first;last)`. More...

String &	Replace (size_type offset, size_type length, const String &arg)
	Replaces a range of chars. More...

String &	Replace (size_type offset, size_type length, const String &arg, size_type offsetArg, size_type count=NPos)
	Replaces a range of chars. More...

String &	Replace (size_type offset, size_type length, const CharType *pChars, size_type count)
	Replaces a range of chars. More...

String &	Replace (size_type offset, size_type length, const CharType *pChars)
	Replaces a range of chars. More...

String &	Replace (size_type offset, size_type length, size_type count, CharType c)
	Replaces a range of chars by a character. More...

String &	Replace (ConstIterator first, ConstIterator last, const String &arg)
	Replaces a range of chars `[first;last)`. More...

String &	Replace (ConstIterator first, ConstIterator last, const CharType *pChars, size_type count)
	Replaces a range of chars `[first;last)`. More...

String &	Replace (ConstIterator first, ConstIterator last, const CharType *pChars)
	Replaces a range of chars `[first;last)`. More...

String &	Replace (ConstIterator first, ConstIterator last, size_type count, CharType c)
	Replaces a range of chars `[first;last)`. More...

String &	Replace (ConstIterator first, ConstIterator last, Iterator first2, Iterator last2)
	Replaces a range of chars `[first;last)`. More...

String &	Replace (ConstIterator first, ConstIterator last, ConstIterator first2, ConstIterator last2)
	Replaces a range of chars `[first;last)`. More...

String &	Replace (ConstIterator first, ConstIterator last, const_pointer first2, const_pointer last2)
	Replaces a range of chars `[first;last)`. More...

String &	Replace (ConstIterator first, ConstIterator last, pointer first2, pointer last2)
	Replaces a range of chars `[first;last)`. More...

Iterator	begin (void)
	Returns the begin iterator of this string. More...

ConstIterator	begin (void) const

Iterator	end (void)
	Returns the end iterator of this string. More...

ConstIterator	end (void) const

void	ShrinkToFit (void)
	May reduce the capacity of this string to its size.

void	PushBack (CharType c)
	Appends the character c to this string. More...

void	PopBack (void)
	Removes the character at the end of this string. More...

Iterator	Begin (void)
	Returns the begin iterator of this string. More...

ConstIterator	Begin (void) const

Iterator	End (void)
	Returns the end iterator of this string. More...

ConstIterator	End (void) const

ReverseIterator	ReverseBegin (void)
	Returns the begin iterator of this string for reverse iterating. More...

ConstReverseIterator	ReverseBegin (void) const

ReverseIterator	ReverseEnd (void)
	Returns the end iterator of this string for reverse iterating. More...

ConstReverseIterator	ReverseEnd (void) const

ConstIterator	ConstBegin (void) const
	Returns the begin iterator of this const string. More...

ConstIterator	ConstEnd (void) const
	Returns the end iterator of this const string. More...

ConstReverseIterator	ConstReverseBegin (void) const
	Returns the begin iterator of this const string for reverse iterating. More...

ConstReverseIterator	ConstReverseEnd (void) const
	Returns the end iterator of this const string for reverse iterating. More...

Reference	Front (void)
	Returns a reference to the first character in the string. More...

ConstReference	Front (void) const

Reference	Back (void)
	Returns a reference to the last character in the string. More...

ConstReference	Back (void) const

Reference	At (size_type offset)
	Returns a const reference to the character at position offset . More...

ConstReference	At (size_type offset) const
	Returns a const reference to the character at position offset . More...

Reference	operator[] (size_type offset)
	Returns a reference to the character at position offset . More...

ConstReference	operator[] (size_type offset) const
	Returns a const reference to the character at position offset . More...

size_type	Length (void) const
	Returns the number of char elements in this string. More...

size_type	Size (void) const
	Returns the number of char elements in this string. More...

size_type	MaxSize (void) const
	Returns the number maximum size any string might have.

size_type	Capacity (void) const
	Returns the capacity of this string. More...

bool	IsEmpty (void) const
	Determines if this string is empty. More...

void	Resize (size_type newSize)
	Resizes this string to the specified new size. More...

void	Resize (size_type newSize, CharType c)
	Resizes this string to the specified new size. More...

void	Reserve (size_type newCapacity=0)
	Reserves memory up to the specified newCapacity . More...

void	Clear (void)
	Clears the content of this string, but does not modify the capacity.

size_type	Find (const String &pattern, size_type offset=0) const
	Finds the first substring which equal to pattern . More...

size_type	Find (const CharType *pChars, size_type offset, size_type count) const
	Finds the first substring which equal to pChars . More...

size_type	Find (const CharType *pChars, size_type offset=0) const
	Finds the first substring which equal to pChars . More...

size_type	Find (CharType c, size_type offset=0) const
	Finds the first char which equal to c . More...

size_type	ReverseFind (const String &pattern, size_type offset=NPos) const
	Finds the last substring which equal to pattern . More...

size_type	ReverseFind (const CharType *pChars, size_type offset, size_type count) const
	Finds the last substring which equal to pChars . More...

size_type	ReverseFind (const CharType *pChars, size_type offset=NPos) const
	Finds the last substring which equal to pChars . More...

size_type	ReverseFind (CharType c, size_type offset=NPos) const
	Finds the last char which equal to c . More...

size_type	FindFirstOf (const String &chars, size_type offset=0) const
	Finds the first occurrence of any character in chars . More...

size_type	FindFirstOf (const CharType *pChars, size_type offset, size_type count) const
	Finds the first occurrence of any character in pChars . More...

size_type	FindFirstOf (const CharType *pChars, size_type offset=0) const
	Finds the first occurrence of any character in pChars . More...

size_type	FindFirstOf (CharType c, size_type offset=0) const
	Finds the first occurrence of character c . More...

size_type	FindLastOf (const String &chars, size_type offset=NPos) const
	Finds the last occurrence of any character in chars . More...

size_type	FindLastOf (const CharType *pChars, size_type offset, size_type count) const
	Finds the last occurrence of any character in pChars . More...

size_type	FindLastOf (const CharType *pChars, size_type offset=NPos) const
	Finds the last occurrence of any character in pChars . More...

size_type	FindLastOf (CharType c, size_type offset=NPos) const
	Finds the last occurrence of character c . More...

size_type	FindFirstNotOf (const String &chars, size_type offset=0) const
	Finds the first occurrence of any character which is not in chars . More...

size_type	FindFirstNotOf (const CharType *pChars, size_type offset, size_type count) const
	Finds the first occurrence of any character which is not in pChars . More...

size_type	FindFirstNotOf (const CharType *pChars, size_type offset=0) const
	Finds the first occurrence of any character which is not in pChars . More...

size_type	FindFirstNotOf (CharType c, size_type offset=0) const
	Finds the first occurrence of any character which is not equal to c . More...

size_type	FindLastNotOf (const String &chars, size_type offset=NPos) const
	Finds the last occurrence of any character which is not in chars . More...

size_type	FindLastNotOf (const CharType *pChars, size_type offset, size_type count) const
	Finds the last occurrence of any character which is not in pChars . More...

size_type	FindLastNotOf (const CharType *pChars, size_type offset=NPos) const
	Finds the last occurrence of any character which is not in pChars . More...

size_type	FindLastNotOf (CharType c, size_type offset=NPos) const
	Finds the last occurrence of any character which is not equal to c . More...

bool	StartsWith (const CharType *pChars) const
	Determines if this string starts with the pChars C-string. More...

bool	StartsWith (const String &pattern) const
	Determines if this string starts with the pattern string. More...

bool	EndsWith (const CharType *pChars) const
	Determines if this string ends with the pChars C-string. More...

bool	EndsWith (const String &pattern) const
	Determines if this string starts with the pattern string. More...

int	Compare (const String &other) const
	Compares this string to the other string lexicographical. More...

int	Compare (size_type offset, size_type count, const String &other) const
	Compares this string to the other string lexicographical. More...

int	Compare (size_type offset, size_type count, const String &other, size_type offsetOther, size_type countOther=NPos) const
	Compares a substring of this string to a substring of the other string lexicographical. More...

int	Compare (const CharType *pOther) const
	Compares this string to the pOther string lexicographical. More...

int	Compare (size_type offset, size_type count, const CharType *pOther) const
	Compares this string to the pOther string lexicographical. More...

int	Compare (size_type offset, size_type count, const CharType *pOther, size_type countOther) const
	Compares a substring of this string to a substring of the pOther string lexicographical. More...

Allocator	GetAllocator (void) const
	Gets the allocator of this string. More...

const CharType *	CStr (void) const
	Gets the character data of this string. More...

String	Substr (size_type offset=0, size_type count=NPos) const
	Gets a substring of this string. More...

void	Swap (String &other)
	Swaps the content of this string with the content of the other string. More...

Bytes	ToBytes (void) const
	Copies this string to a byte array. More...

String &	ReplaceAll (const String &pattern, const String &replacement)
	Replaces a given pattern by a replacement string. More...

const StdString &	GetStdString (void) const
	Gets the `std::string` of this string. More...

StdString &	GetStdString (void)

String	TrimLeft (void) const
	Removes all whites spaces at the begin of the string. More...

String	TrimLeft (CharType trim) const
	Removes all characters specified by trim at the begin of the string. More...

String	TrimRight (void) const
	Removes all whites spaces at the end of the string. More...

String	TrimRight (CharType trim) const
	Removes all characters specified by trim at the end of the string. More...

String	Trim (void) const
	Removes all whites spaces from at the begin and end of the string. More...

String	Trim (CharType trim) const
	Removes all characters specified by trim at the begin and the end of the string. More...

Tokens	Split (CharType delimiter, bool trimTokens=true, bool removeEmptyTokens=true) const
	Splits this string into tokens using the specified delimiter characters (multiple). More...

Tokens	Split (std::span< const CharType > delimiters, bool trimTokens=true, bool removeEmptyTokens=true) const
	Splits this string into tokens using the specified delimiter characters (multiple). More...

Tokens	SplitByWord (const String &delimiter, bool trimTokens=true, bool removeEmptyTokens=true) const
	Splits this string into tokens using the specified (single) delimiter string. More...

const StdString &	GetBaseString (void) const
	DEPRECATED More...

bool	StartWith (const CharType *pChars) const
	Determines if this string starts with the pChars C-string. More...

bool	StartWith (const String &pattern) const
	Determines if this string starts with the pattern string. More...

bool	EndWith (const CharType *pChars) const
	Determines if this string ends with the pChars C-string. More...

bool	EndWith (const String &pattern) const
	Determines if this string starts with the pattern string. More...

Static Public Member Functions
template<typename... Args>
static String	Format (const String &format, const Args &... args)
	Formats the format string using the .NET/Python syntax with the given variadic arguments. More...

template<typename... Args>
static String	Format (const char *format, const Args &... args)
	Formats the format C-string using the .NET/Python syntax with the given variadic arguments. More...

template<typename... Args>
static String	FormatPrintf (const char *format, const Args &... args)
	Formats the format C-string using the `printf` syntax with the given variadic arguments. More...

Static Public Attributes
static const size_type	NPos = size_type(-1)

static const String	Empty

static const String	NewLine

Friends
ARP_STRING_EXPORT_DECL String	operator+ (const String &left, const String &right)
	Concatenates the right string to the left string. More...

ARP_STRING_EXPORT_DECL String	operator+ (const String &left, const String::CharType *right)
	Concatenates the right C-string to the left string. More...

ARP_STRING_EXPORT_DECL String	operator+ (const String &left, String::CharType right)
	Concatenates the right character to the left string. More...

ARP_STRING_EXPORT_DECL String	operator+ (const String::CharType *left, const String &right)
	Concatenates the right string to the left string. More...

ARP_STRING_EXPORT_DECL String	operator+ (String::CharType left, const String &right)
	Concatenates the right string to the left character. More...

ARP_STRING_EXPORT_DECL String	operator+ (String &&left, String &&right)
	Concatenates the right string to the left string. More...

ARP_STRING_EXPORT_DECL String	operator+ (String &&left, const String &right)
	Concatenates the right string to the left string. More...

ARP_STRING_EXPORT_DECL String	operator+ (String &&left, const String::CharType *right)
	Concatenates the right string to the left string. More...

ARP_STRING_EXPORT_DECL String	operator+ (String &&left, String::CharType right)
	Concatenates the right character to the left string. More...

ARP_STRING_EXPORT_DECL String	operator+ (const String &left, String &&right)
	Concatenates the right string to the left string. More...

ARP_STRING_EXPORT_DECL String	operator+ (const String::CharType *left, String &&right)
	Concatenates the right string to the left string. More...

ARP_STRING_EXPORT_DECL String	operator+ (String::CharType left, String &&right)
	Concatenates the right string to the left character. More...

Detailed Description

This class represents the Arp String. The implementation is based on std::string.

All std::string operations are implemented using Pascal casing. Furthermore, the functionality was extended by several operations:

Trimming characters and white spaces
Splitting by characters and words
Replacing all occurrences of a pattern by a substitute
Formatting using format syntax of Python/.NET based on libfmt
Conversion operation like from and to bytes

Constructor & Destructor Documentation

◆ String() [1/15]

ARP_STRING_INLINE Arp::Base::Core::String::String ( const String & arg )

default

The copy constructor copies the as argument passed string deeply.

Parameters

arg	The argument to copy.

◆ String() [2/15]

ARP_STRING_INLINE Arp::Base::Core::String::String ( String && arg )

defaultnoexcept

This move constructor moves the as argument passed string to this string.

Parameters

arg	The argument to move.

◆ String() [3/15]

ARP_STRING_INLINE Arp::Base::Core::String::String ( const BaseString & arg )

This constructor copies the as argument passed string.

Parameters

arg	The argument to copy.

◆ String() [4/15]

ARP_STRING_INLINE Arp::Base::Core::String::String ( BaseString && arg )

This constructor moves the as argument passed string.

Parameters

arg	The argument to move.

◆ String() [5/15]

ARP_STRING_INLINE Arp::Base::Core::String::String ( const StdString & arg )

This constructor copies the as argument passed string.

Parameters

arg	The argument to copy.

◆ String() [6/15]

ARP_STRING_INLINE Arp::Base::Core::String::String ( StdString && arg )

This constructor moves the as argument passed string.

Parameters

arg	The argument to move.

◆ String() [7/15]

ARP_STRING_INLINE Arp::Base::Core::String::String	(	const String &	arg,
		size_type	offset,
		size_type	count = `NPos`
	)

This constructor copies the as argument passed string partially.

Parameters

arg	The argument to copy partially.
offset	The offset of arg to copy the chars from.
count	The number of chars to copy from arg .

◆ String() [8/15]

ARP_STRING_INLINE Arp::Base::Core::String::String	(	const CharType *	pChars,
		size_type	count
	)

This constructor copies the as argument passed C-string.

Parameters

pChars	The C-string to copy.
count	The number of chars to copy from pChars .

◆ String() [9/15]

ARP_STRING_INLINE Arp::Base::Core::String::String ( const CharType * pChars )

This constructor copies the as argument passed C-string.

Parameters

pChars The C-string to copy.

◆ String() [10/15]

ARP_STRING_INLINE Arp::Base::Core::String::String ( const Char8uType * pChars )

This constructor copies the as argument passed C-string.

Parameters

pChars The UTF8 string to copy.

◆ String() [11/15]

ARP_STRING_INLINE Arp::Base::Core::String::String	(	size_type	count,
		CharType	c
	)

Fills the string with count consecutive copies of character c .

Parameters

count	The number of chars to fill this string with.
c	The char used to fill this string.

◆ String() [12/15]

ARP_STRING_INLINE Arp::Base::Core::String::String ( std::initializer_list< CharType > arg )

Copies each of the characters in initList , in the same order.

Parameters

arg	The initializer list of chars to copy.

◆ String() [13/15]

ARP_STRING_INLINE Arp::Base::Core::String::String	(	Iterator	first,
		Iterator	last
	)

Copies the sequence of characters in the range [first,last), in the same order..

Parameters

first	The begin iterator specifying the range of chars to copy.
last	The end iterator specifying the range of chars to copy.

◆ String() [14/15]

ARP_STRING_INLINE Arp::Base::Core::String::String	(	ConstIterator	first,
		ConstIterator	last
	)

Copies the sequence of characters in the range [first,last), in the same order..

Parameters

first	The begin Iterator specifying the range of chars to copy.
last	The end iterator specifying the range of chars to copy.

◆ String() [15/15]

ARP_STRING_INLINE Arp::Base::Core::String::String ( const Bytes & bytes )

explicit

Copies the as arguments passed bytes to this string.

Parameters

bytes The bytes to copy to this string.

Member Function Documentation

◆ Append() [1/9]

ARP_STRING_INLINE String & Arp::Base::Core::String::Append ( const CharType * pChars )

This operation appends the as argument passed C-string.

Parameters

pChars The argument to append.

◆ Append() [2/9]

ARP_STRING_INLINE String & Arp::Base::Core::String::Append	(	const CharType *	pChars,
		size_type	count
	)

This operation appends the as argument passed C-string partially.

Parameters

pChars	The argument to append partially.
count	The number of chars to append from pChars .

◆ Append() [3/9]

ARP_STRING_INLINE String & Arp::Base::Core::String::Append ( const String & arg )

This operation appends the argument to this string.

Parameters

arg	The argument to append.

Returns: A reference to this instance.

◆ Append() [4/9]

ARP_STRING_INLINE String & Arp::Base::Core::String::Append	(	const String &	arg,
		size_type	offset,
		size_type	count = `NPos`
	)

This operation appends the as argument passed string partially.

Parameters

arg	The argument to append partially.
offset	The offset of arg to append the chars from.
count	The number of chars to append from arg .

◆ Append() [5/9]

ARP_STRING_INLINE String & Arp::Base::Core::String::Append	(	const_pointer	first,
		const_pointer	last
	)

Appends the sequence of characters in the range [first,last), in the same order.

Parameters

first	The begin iterator specifying the range of chars to append.
last	The end iterator specifying the range of chars to append.

◆ Append() [6/9]

ARP_STRING_INLINE String & Arp::Base::Core::String::Append	(	ConstIterator	first,
		ConstIterator	last
	)

Appends the sequence of characters in the range [first,last), in the same order.

Parameters

first	The begin iterator specifying the range of chars to append.
last	The end iterator specifying the range of chars to append.

◆ Append() [7/9]

ARP_STRING_INLINE String & Arp::Base::Core::String::Append	(	Iterator	first,
		Iterator	last
	)

Appends the sequence of characters in the range [first,last), in the same order.

Parameters

first	The begin iterator specifying the range of chars to append.
last	The end iterator specifying the range of chars to append.

◆ Append() [8/9]

ARP_STRING_INLINE String & Arp::Base::Core::String::Append	(	size_type	count,
		CharType	c
	)

Appends to this string count consecutive copies of character c .

Parameters

count	The number of chars to append to this string.
c	The char used to append this string.

◆ Append() [9/9]

ARP_STRING_INLINE String & Arp::Base::Core::String::Append ( std::initializer_list< CharType > arg )

This operation appends each of the characters in the argument to this string, in the same order.

Parameters

arg	The initializer list of chars to append.

Returns: A reference to this instance.

◆ Assign() [1/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign ( const CharType * pChars )

This operation copies the as argument passed C-string.

Parameters

pChars The argument to copy.

◆ Assign() [2/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign	(	const CharType *	pChars,
		size_type	count
	)

This operation copies the as argument passed C-string partially.

Parameters

pChars	The argument to copy partially.
count	The number of chars to copy from pChars .

◆ Assign() [3/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign ( const StdString & arg )

This operation copies the argument to this string.

Parameters

arg	The argument to copy.

Returns: A reference to this instance.

◆ Assign() [4/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign ( const String & arg )

This operation copies the argument to this string.

Parameters

arg	The argument to copy.

Returns: A reference to this instance.

◆ Assign() [5/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign	(	const String &	arg,
		size_type	offset,
		size_type	count = `NPos`
	)

This operation copies the as argument passed string partially.

Parameters

arg	The argument to copy partially.
offset	The offset of arg to copy the chars from.
count	The number of chars to copy from arg .

◆ Assign() [6/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign	(	const_pointer	first,
		const_pointer	last
	)

Copies the sequence of characters in the range [first,last), in the same order.

Parameters

first	The begin iterator specifying the range of chars to copy.
last	The end iterator specifying the range of chars to copy.

◆ Assign() [7/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign	(	ConstIterator	first,
		ConstIterator	last
	)

Copies the sequence of characters in the range [first,last), in the same order.

Parameters

first	The begin iterator specifying the range of chars to copy.
last	The end iterator specifying the range of chars to copy.

◆ Assign() [8/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign	(	Iterator	first,
		Iterator	last
	)

Copies the sequence of characters in the range [first,last), in the same order.

Parameters

first	The begin iterator specifying the range of chars to copy.
last	The end iterator specifying the range of chars to copy.

◆ Assign() [9/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign	(	size_type	count,
		CharType	c
	)

Fills this string with count consecutive copies of character c .

Parameters

count	The number of chars to fill this string with.
c	The char used to fill this string.

◆ Assign() [10/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign ( std::initializer_list< CharType > arg )

This operation copies each of the characters in the argument to this string, in the same order.

Parameters

arg	The initializer list of chars to copy.

Returns: A reference to this instance.

◆ Assign() [11/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign ( StdString && arg )

This operation moves the argument to this string.

Parameters

arg	The argument to move.

Returns: A reference to this instance.

◆ Assign() [12/12]

ARP_STRING_INLINE String & Arp::Base::Core::String::Assign ( String && arg )

This operation moves the as argument passed string to this string.

Parameters

arg	The right-hand-side argument to move.

Returns: A reference to this instance.

◆ At() [1/2]

ARP_STRING_INLINE String::Reference Arp::Base::Core::String::At ( size_type offset )

Returns a const reference to the character at position offset .

Parameters

offset The index of the character to refer.

Exceptions

std::out_of_range If offset is out of range.

Returns: A reference to the character at position offset .

◆ At() [2/2]

ARP_STRING_INLINE String::ConstReference Arp::Base::Core::String::At ( size_type offset ) const

Returns a const reference to the character at position offset .

Parameters

offset The index of the character to refer.

Exceptions

std::out_of_range If offset is out of range.

Returns: A const reference to the character at position offset .

◆ Back()

ARP_STRING_INLINE String::ConstReference Arp::Base::Core::String::Back ( void )

Returns a reference to the last character in the string.

Returns a const reference to the last character in the string.

The behavior is undefined if this string is empty.

Returns: A reference to the last character in the string.

The behavior is undefined if this string is empty.

Returns: A const reference to the last character in the string.

◆ begin()

ARP_STRING_INLINE String::ConstIterator Arp::Base::Core::String::begin ( void )

Returns the begin iterator of this string.

Returns: The begin iterator of this string.

This implementation is intended to support range base for loops and is required by C++ compilers. Do not use this operation directly.

◆ Begin()

ARP_STRING_INLINE String::ConstIterator Arp::Base::Core::String::Begin ( void )

Returns the begin iterator of this string.

Returns: The begin iterator of this string.

◆ Capacity()

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::Capacity ( void ) const

Returns the capacity of this string.

The capacity of a string might differ from its size, because the string class acts like any other container class. If it is desired that a the capacity of string should be reduced to its size, call ShrinkToFit operation.

See also: ShrinkToFit

Use ShrinkToFit operation to reduce the capacity of a string to its size.

Returns: The capacity of this string.

◆ Compare() [1/6]

ARP_STRING_INLINE int Arp::Base::Core::String::Compare ( const CharType * pOther ) const

Compares this string to the pOther string lexicographical.

Parameters

pOther The other C-string to compare this string to.

Returns: A negative value if this string is less than the pOther , a positive value if this string is greater than the <paramref name= "pOther" / >, or zero if the strings are equal.

◆ Compare() [2/6]

ARP_STRING_INLINE int Arp::Base::Core::String::Compare ( const String & other ) const

Compares this string to the other string lexicographical.

Parameters

other The other string to compare this string to.

Returns: A negative value if this string is less than the other , a positive value if this string is greater than the <paramref name= "other" / >, or zero if the strings are equal.

◆ Compare() [3/6]

ARP_STRING_INLINE int Arp::Base::Core::String::Compare	(	size_type	offset,
		size_type	count,
		const CharType *	pOther
	)		const

Compares this string to the pOther string lexicographical.

Parameters

pOther	The other C-string to compare this string to.
offset	The position of the first character in this string to compare.
count	The number of characters of this string to compare.

Returns: A negative value if this string is less than the pOther , a positive value if this string is greater than the <paramref name= "pOther" / >, or zero if the strings are equal.

◆ Compare() [4/6]

ARP_STRING_INLINE int Arp::Base::Core::String::Compare	(	size_type	offset,
		size_type	count,
		const CharType *	pOther,
		size_type	countOther
	)		const

Compares a substring of this string to a substring of the pOther string lexicographical.

Parameters

pOther	The other C-string to compare this string to.
offset	The position of the first character in this string to compare.
count	The number of characters of this string to compare.
countOther	The number of characters of the other string to compare.

Returns: A negative value if the substring of this string is less than the substring of the pOther string, a positive value if the substring of this string is greater than the substring of the pOther string, or zero if the substrings are equal.

◆ Compare() [5/6]

ARP_STRING_INLINE int Arp::Base::Core::String::Compare	(	size_type	offset,
		size_type	count,
		const String &	other
	)		const

Compares this string to the other string lexicographical.

Parameters

other	The other string to compare this string to.
offset	The position of the first character in this string to compare.
count	The number of characters of this string to compare.

Returns: A negative value if this string is less than the other , a positive value if this string is greater than the <paramref name= "other" / >, or zero if the strings are equal.

◆ Compare() [6/6]

ARP_STRING_INLINE int Arp::Base::Core::String::Compare	(	size_type	offset,
		size_type	count,
		const String &	other,
		size_type	offsetOther,
		size_type	countOther = `NPos`
	)		const

Compares a substring of this string to a substring of the other string lexicographical.

Parameters

other	The other string to compare this string to.
offset	The position of the first character in this string to compare.
count	The number of characters of this string to compare.
offsetOther	The position of the first character in the other string to compare.
countOther	The number of characters of the other string to compare.

Returns: A negative value if the substring of this string is less than the substring of the other string, a positive value if the substring of this string is greater than the substring of the other string, or zero if the substrings are equal.

◆ ConstBegin()

ARP_STRING_INLINE String::ConstIterator Arp::Base::Core::String::ConstBegin ( void ) const

Returns the begin iterator of this const string.

Returns: The begin iterator of this const string.

◆ ConstEnd()

ARP_STRING_INLINE String::ConstIterator Arp::Base::Core::String::ConstEnd ( void ) const

Returns the end iterator of this const string.

Returns: The end iterator of this const string.

◆ ConstReverseBegin()

ARP_STRING_INLINE String::ConstReverseIterator Arp::Base::Core::String::ConstReverseBegin ( void ) const

Returns the begin iterator of this const string for reverse iterating.

Returns: The begin iterator for reverse iterating.

◆ ConstReverseEnd()

ARP_STRING_INLINE String::ConstReverseIterator Arp::Base::Core::String::ConstReverseEnd ( void ) const

Returns the end iterator of this const string for reverse iterating.

Returns: The end iterator for reverse iterating.

◆ CStr()

ARP_STRING_INLINE const String::CharType * Arp::Base::Core::String::CStr ( void ) const

Gets the character data of this string.

Returns: The C-string of this string.

◆ end()

ARP_STRING_INLINE String::ConstIterator Arp::Base::Core::String::end ( void )

Returns the end iterator of this string.

Returns: The end iterator of this string.

This implementation is intended to support range base for loops and is required by C++ compilers. Do not use this operation directly.

◆ End()

ARP_STRING_INLINE String::ConstIterator Arp::Base::Core::String::End ( void )

Returns the end iterator of this string.

Returns: The end iterator of this string.

◆ EndsWith() [1/2]

ARP_STRING_INLINE bool Arp::Base::Core::String::EndsWith ( const CharType * pChars ) const

Determines if this string ends with the pChars C-string.

Parameters

pChars The C-string to compare this string to.

Returns: true if this string ends with the pChars C-string, otherwise false.

◆ EndsWith() [2/2]

ARP_STRING_INLINE bool Arp::Base::Core::String::EndsWith ( const String & pattern ) const

Determines if this string starts with the pattern string.

Parameters

pattern The string to compare this string to.

Returns: true if this string starts with the pattern string, otherwise false.

◆ EndWith() [1/2]

bool Arp::Base::Core::String::EndWith ( const CharType * pChars ) const

Determines if this string ends with the pChars C-string.

Parameters

pChars The C-string to compare this string to.

Returns: true if this string ends with the pChars C-string, otherwise false.

◆ EndWith() [2/2]

bool Arp::Base::Core::String::EndWith ( const String & pattern ) const

Determines if this string starts with the pattern string.

Parameters

pattern The string to compare this string to.

Returns: true if this string starts with the pattern string, otherwise false.

◆ Erase() [1/4]

ARP_STRING_INLINE String::Iterator Arp::Base::Core::String::Erase	(	ConstIterator	first,
		ConstIterator	last
	)

Erases a range of chars [first;last).

Parameters

first	The begin iterator specifying the range of chars to insert.
last	The end iterator specifying the range of chars to insert.

Returns: An iterator which points to the first position behind erased chars, this is the end() iterator.

◆ Erase() [2/4]

ARP_STRING_INLINE String::Iterator Arp::Base::Core::String::Erase ( ConstIterator where )

This operation erases chars from this string.

Parameters

where The start position from where the chars are erased. If this is the begin iterator the entire string is cleared.

Returns: An iterator which points to the first position behind erased chars, this is the end() iterator.

◆ Erase() [3/4]

ARP_STRING_INLINE String & Arp::Base::Core::String::Erase	(	size_type	offset,
		size_type	count
	)

This operation erases chars from this string.

Parameters

offset	The start position from where the chars are erased.
count	The number of chars to erase.

Returns: A reference to this instance.

◆ Erase() [4/4]

ARP_STRING_INLINE String & Arp::Base::Core::String::Erase ( size_type offset = 0 )

This operation erases chars from this string.

Parameters

offset The start position from where the chars are erased. If this is 0 the entire string is cleared.

Returns: A reference to this instance.

◆ Find() [1/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::Find	(	CharType	c,
		size_type	offset = `0`
	)		const

Finds the first char which equal to c .

Parameters

c	The char to search for.
offset	The position at which to start the search.

Returns: The position of the first char matching c or NPos if the char could not be found.

◆ Find() [2/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::Find	(	const CharType *	pChars,
		size_type	offset,
		size_type	count
	)		const

Finds the first substring which equal to pChars .

Parameters

pChars	The C-string to search for.
offset	The position at which to start the search.
count	The length of the substring to search for.

Returns: The position of the first char of the found substring or NPos if the substring could not be found.

◆ Find() [3/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::Find	(	const CharType *	pChars,
		size_type	offset = `0`
	)		const

Finds the first substring which equal to pChars .

Parameters

pChars	The C-string to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found substring or NPos if the substring could not be found.

◆ Find() [4/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::Find	(	const String &	pattern,
		size_type	offset = `0`
	)		const

Finds the first substring which equal to pattern .

Parameters

pattern	The pattern to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found substring or NPos if the substring could not be found.

◆ FindFirstNotOf() [1/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindFirstNotOf	(	CharType	c,
		size_type	offset = `0`
	)		const

Finds the first occurrence of any character which is not equal to c .

Parameters

c	The character not to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if the char could not be found.

See also: Find(char, size_t)

This operation is equivalent to the corresponding Find operation

◆ FindFirstNotOf() [2/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindFirstNotOf	(	const CharType *	pChars,
		size_type	offset,
		size_type	count
	)		const

Finds the first occurrence of any character which is not in pChars .

Parameters

pChars	The characters not to search for.
offset	The position at which to start the search.
count	The length of the C-string identifying characters to search for.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindFirstNotOf() [3/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindFirstNotOf	(	const CharType *	pChars,
		size_type	offset = `0`
	)		const

Finds the first occurrence of any character which is not in pChars .

Parameters

pChars	The characters not to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindFirstNotOf() [4/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindFirstNotOf	(	const String &	chars,
		size_type	offset = `0`
	)		const

Finds the first occurrence of any character which is not in chars .

Parameters

chars	The characters not to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindFirstOf() [1/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindFirstOf	(	CharType	c,
		size_type	offset = `0`
	)		const

Finds the first occurrence of character c .

Parameters

c	The character to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if the char could not be found.

See also: Find(char, size_t)

This operation is equivalent to the corresponding Find operation

◆ FindFirstOf() [2/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindFirstOf	(	const CharType *	pChars,
		size_type	offset,
		size_type	count
	)		const

Finds the first occurrence of any character in pChars .

Parameters

pChars	The characters to search for.
offset	The position at which to start the search.
count	The length of the C-string identifying characters to search for.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindFirstOf() [3/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindFirstOf	(	const CharType *	pChars,
		size_type	offset = `0`
	)		const

Finds the first occurrence of any character in pChars .

Parameters

pChars	The characters to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindFirstOf() [4/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindFirstOf	(	const String &	chars,
		size_type	offset = `0`
	)		const

Finds the first occurrence of any character in chars .

Parameters

chars	The characters to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindLastNotOf() [1/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindLastNotOf	(	CharType	c,
		size_type	offset = `NPos`
	)		const

Finds the last occurrence of any character which is not equal to c .

Parameters

c	The character not to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if the char could not be found.

See also: Find(char, size_t)

This operation is equivalent to the corresponding Find operation

◆ FindLastNotOf() [2/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindLastNotOf	(	const CharType *	pChars,
		size_type	offset,
		size_type	count
	)		const

Finds the last occurrence of any character which is not in pChars .

Parameters

pChars	The characters not to search for.
offset	The position at which to start the search.
count	The length of the C-string identifying characters to search for.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindLastNotOf() [3/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindLastNotOf	(	const CharType *	pChars,
		size_type	offset = `NPos`
	)		const

Finds the last occurrence of any character which is not in pChars .

Parameters

pChars	The characters not to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindLastNotOf() [4/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindLastNotOf	(	const String &	chars,
		size_type	offset = `NPos`
	)		const

Finds the last occurrence of any character which is not in chars .

Parameters

chars	The characters not to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindLastOf() [1/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindLastOf	(	CharType	c,
		size_type	offset = `NPos`
	)		const

Finds the last occurrence of character c .

Parameters

c	The character to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if the char could not be found.

See also: ReverseFind(char, size_t)

This operation is equivalent to the corresponding ReverseFind operation.

◆ FindLastOf() [2/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindLastOf	(	const CharType *	pChars,
		size_type	offset,
		size_type	count
	)		const

Finds the last occurrence of any character in pChars .

Parameters

pChars	The characters to search for.
offset	The position at which to start the search.
count	The length of the C-string identifying characters to search for.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindLastOf() [3/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindLastOf	(	const CharType *	pChars,
		size_type	offset = `NPos`
	)		const

Finds the last occurrence of any character in pChars .

Parameters

pChars	The characters to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ FindLastOf() [4/4]

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::FindLastOf	(	const String &	chars,
		size_type	offset = `NPos`
	)		const

Finds the last occurrence of any character in chars .

Parameters

chars	The characters to search for.
offset	The position at which to start the search.

Returns: The position of the first char of the found char or NPos if none of the chars could not be found.

◆ Format() [1/2]

template<typename... Args>

String Arp::Base::Core::String::Format	(	const char *	format,
		const Args &...	args
	)

inlinestatic

Formats the format C-string using the .NET/Python syntax with the given variadic arguments.

Parameters

format	The C-string to format using .NET/Python syntax for placeholders like `{}`, `{1}` or `{2}`.
args	The variadic arguments to format into the format string.

Returns: The formatted string.

◆ Format() [2/2]

template<typename... Args>

String Arp::Base::Core::String::Format	(	const String &	format,
		const Args &...	args
	)

inlinestatic

Formats the format string using the .NET/Python syntax with the given variadic arguments.

Parameters

format	The string to format using .NET/Python syntax for placeholders like `{}`, `{1}` or `{2}`.
args	The variadic arguments to format into the format string.

Returns: The formatted string.

◆ FormatPrintf()

template<typename... Args>

String Arp::Base::Core::String::FormatPrintf	(	const char *	format,
		const Args &...	args
	)

inlinestatic

Formats the format C-string using the printf syntax with the given variadic arguments.

Parameters

format	The C-string to formating printf syntax for placeholders like `d`, `f` or `i`.
args	The variadic arguments to format into the format string.

Returns: The formatted string.

◆ Front()

ARP_STRING_INLINE String::ConstReference Arp::Base::Core::String::Front ( void )

Returns a reference to the first character in the string.

Returns a const reference to the first character in the string.

The behavior is undefined if this string is empty.

Returns: A reference to the first character in the string.

The behavior is undefined if this string is empty.

Returns: A const reference to the first character in the string.

◆ GetAllocator()

ARP_STRING_INLINE String::Allocator Arp::Base::Core::String::GetAllocator ( void ) const

Gets the allocator of this string.

Returns: The allocator of this string.

◆ GetBaseString()

ARP_STRING_INLINE const String::StdString & Arp::Base::Core::String::GetBaseString ( void ) const

DEPRECATED

Use String::GetImpl() instead.

◆ GetStdString()

ARP_STRING_INLINE String::StdString & Arp::Base::Core::String::GetStdString ( void ) const

Gets the std::string of this string.

Returns: The underlying std::string.

◆ Insert() [1/11]

ARP_STRING_INLINE String::Iterator Arp::Base::Core::String::Insert	(	ConstIterator	where,
		CharType	c
	)

Inserts character c at position where .

Parameters

where	The position where to insert the char.
c	The char to insert into this string.

Returns: An iterator which points to the position behind inserted character.

◆ Insert() [2/11]

ARP_STRING_INLINE String::Iterator Arp::Base::Core::String::Insert	(	ConstIterator	where,
		const_pointer	first,
		const_pointer	last
	)

Inserts a range of chars [first;last) at position where .

Parameters

where	The position where to insert the char.
first	The begin iterator specifying the range of chars to insert.
last	The end iterator specifying the range of chars to insert.

Returns: An iterator which points to the position behind inserted character.

◆ Insert() [3/11]

ARP_STRING_INLINE String::Iterator Arp::Base::Core::String::Insert	(	ConstIterator	where,
		ConstIterator	first,
		ConstIterator	last
	)

Inserts a range of chars [first;last) at position where .

Parameters

where	The position where to insert the char.
first	The begin iterator specifying the range of chars to insert.
last	The end iterator specifying the range of chars to insert.

Returns: An iterator which points to the position behind inserted character.

◆ Insert() [4/11]

ARP_STRING_INLINE String::Iterator Arp::Base::Core::String::Insert	(	ConstIterator	where,
		Iterator	first,
		Iterator	last
	)

Inserts a range of chars [first;last) at position where .

Parameters

where	The position where to insert the char.
first	The begin iterator specifying the range of chars to insert.
last	The end iterator specifying the range of chars to insert.

Returns: An iterator which points to the position behind inserted character.

◆ Insert() [5/11]

ARP_STRING_INLINE String::Iterator Arp::Base::Core::String::Insert	(	ConstIterator	where,
		size_type	count,
		CharType	c
	)

Inserts character c at position where .

Parameters

where	The position where to insert the char.
count	The number of chars to insert.
c	The char used to insert into this string.

Returns: An iterator which points to the position behind inserted character.

◆ Insert() [6/11]

ARP_STRING_INLINE String::Iterator Arp::Base::Core::String::Insert	(	ConstIterator	where,
		std::initializer_list< CharType >	chars
	)

This operation inserts each of the characters in the argument to this string, in the same order.

Parameters

where	The position to insert the character at.
chars	The initializer list of chars to insert.

Returns: An iterator which points to the position behind inserted characters.

◆ Insert() [7/11]

ARP_STRING_INLINE String & Arp::Base::Core::String::Insert	(	size_type	offset,
		const CharType *	pChars
	)

This operation inserts the as argument passed string.

Parameters

offset	The start position where to insert the chars.
pChars	The C-string to insert.

Returns: A reference to this instance.

◆ Insert() [8/11]

ARP_STRING_INLINE String & Arp::Base::Core::String::Insert	(	size_type	offset,
		const CharType *	pChars,
		size_type	count
	)

This operation inserts the as argument passed string partially.

Parameters

offset	The start position where to insert the chars.
pChars	The C-string to insert partially.
count	The number of chars to insert from pChars .

Returns: A reference to this instance.

◆ Insert() [9/11]

ARP_STRING_INLINE String & Arp::Base::Core::String::Insert	(	size_type	offset,
		const String &	arg
	)

This operation inserts the argument at the given position.

Parameters

arg	The argument to insert.
offset	The position to insert argument at.

Returns: A reference to this instance.

◆ Insert() [10/11]

ARP_STRING_INLINE String & Arp::Base::Core::String::Insert	(	size_type	offset,
		const String &	arg,
		size_type	argOffset,
		size_type	count = `NPos`
	)

This operation inserts the as argument passed string partially.

Parameters

offset	The start position where to insert the chars.
arg	The argument to insert partially.
argOffset	The offset of arg to insert the chars from.
count	The number of chars to insert from arg .

Returns: A reference to this instance.

◆ Insert() [11/11]

ARP_STRING_INLINE String & Arp::Base::Core::String::Insert	(	size_type	offset,
		size_type	count,
		CharType	c
	)

Inserts count consecutive copies of character c at position offset .

Parameters

offset	The start position where to insert the chars.
count	The number of chars to insert.
c	The char used to insert into this string.

Returns: A reference to this instance.

◆ IsEmpty()

ARP_STRING_INLINE bool Arp::Base::Core::String::IsEmpty ( void ) const

Determines if this string is empty.

Returns: true if this string is empty, otherwise false.

◆ Length()

ARP_STRING_INLINE String::size_type Arp::Base::Core::String::Length ( void ) const

Returns the number of char elements in this string.

This operation does not count the null terminator. Furthermore it does not return the number of characters for other encodings than ASCII encoding. E.g. if the encoding is UTF8, the number of characters might differs from the length or size of the string.

See also: Size

Returns the same value than the Size operation.

Returns: The number of char elements in this string.

◆ operator const CharType *()

ARP_STRING_INLINE Arp::Base::Core::String::operator const String::CharType * ( void ) const

Converts this string implicitly to a C-string.

Returns: The C-string of this string.

◆ operator const StdString &()

ARP_STRING_INLINE Arp::Base::Core::String::operator const String::StdString & ( void ) const

Converts this string implicitly to a std string.

Returns: The basic std string.

◆ operator+=() [1/4]

ARP_STRING_INLINE String & Arp::Base::Core::String::operator+= ( CharType c )

This assignment operator appends the right-hand-side operand to this string.

Parameters

c	The character to append.

Returns: A reference to this instance.

◆ operator+=() [2/4]

ARP_STRING_INLINE String & Arp::Base::Core::String::operator+= ( const CharType * right )

This assignment operator appends the right-hand-side operand to this string.

Parameters

right The argument to append.

Returns: A reference to this instance.

◆ operator+=() [3/4]

ARP_STRING_INLINE String & Arp::Base::Core::String::operator+= ( const String & right )

This assignment operator appends the right-hand-side operand to this string.

Parameters

right The argument to append.

Returns: A reference to this instance.

◆ operator+=() [4/4]

ARP_STRING_INLINE String & Arp::Base::Core::String::operator+= ( std::initializer_list< CharType > right )

This assignment operator appends each of the characters in the right-hand-side operand to this string, in the same order.

Parameters

right The initializer list of chars to append.

Returns: A reference to this instance.

◆ operator=() [1/5]

ARP_STRING_INLINE String & Arp::Base::Core::String::operator= ( CharType c )

This assignment operator copies the right-hand-side operand to this string.

Parameters

c	The character to copy.

Returns: A reference to this instance.

◆ operator=() [2/5]

ARP_STRING_INLINE String & Arp::Base::Core::String::operator= ( const CharType * right )

This assignment operator copies the right-hand-side operand to this string.

Parameters

right The argument to copy.

Returns: A reference to this instance.

◆ operator=() [3/5]

ARP_STRING_INLINE String & Arp::Base::Core::String::operator= ( const String & arg )

default

This assignment operator copies the right-hand-side operand to this string.

Parameters

arg	The argument to copy.

Returns: A reference to this instance.

◆ operator=() [4/5]

ARP_STRING_INLINE String & Arp::Base::Core::String::operator= ( std::initializer_list< CharType > right )

This assignment operator copies each of the characters in the right-hand-side operand to this string, in the same order.

Parameters

right The initializer list of chars to copy.

Returns: A reference to this instance.

◆ operator=() [5/5]

ARP_STRING_INLINE String & Arp::Base::Core::String::operator= ( String && arg )

defaultnoexcept

This move assignment operator moves the right-hand-side operand to this string.

Parameters

arg	The argument to move.

Returns: A reference to this instance.

◆ operator[]() [1/2]

ARP_STRING_INLINE String::Reference Arp::Base::Core::String::operator[] ( size_type offset )

Returns a reference to the character at position offset .

Parameters

offset The index of the character to refer.

The behavior is undefined offset is out of range.

Returns: A reference to the character at position offset .

◆ operator[]() [2/2]

ARP_STRING_INLINE String::ConstReference Arp::Base::Core::String::operator[] ( size_type offset ) const

Returns a const reference to the character at position offset .

Parameters

offset The index of the character to refer.

The behavior is undefined offset is out of range.

Returns: A const reference to the character at position offset .

◆ PopBack()

ARP_STRING_INLINE void Arp::Base::Core::String::PopBack ( void )

Removes the character at the end of this string.

if this string is empty, the operation has no effect.

◆ PushBack()

ARP_STRING_INLINE void Arp::Base::Core::String::PushBack ( CharType c )

Appends the character c to this string.

Parameters

c	The char to append to this string.