Contains a static string with string lentgh up to N characters. The string shall be null terminated. More...

#include <RscString.hxx>

Inheritance diagram for Arp::Base::Rsc::Commons::RscString< N >:

Public Member Functions
	RscString (void)
	Constructs an empty RscString.

	RscString (const char *pChars)
	Constructs an RscString instance and copies the null terminated c-string in internal buffer. More...

	RscString (const char8u *pChars)
	Constructs an RscString instance and copies the null terminated c-string in internal buffer. More...

	RscString (const String &arg)
	Constructor for type `String`. More...

	RscString (const RscString &arg)
	Default copy constructor. More...

	RscString (RscString &&arg) noexcept
	Default move constructor. More...

RscString &	operator= (const RscString &arg)
	Default copy-assignment operator. More...

RscString &	operator= (RscString &&arg) noexcept
	Default move-assignment operator. More...

	~RscString (void)
	Default destructor.

RscString &	operator= (const char *pChars)
	Assigns the char buffer to this instance. More...

RscString &	operator= (const char8u *pChars)
	Assigns the UTF8 char buffer to this instance. More...

RscString &	operator= (const String &str)
	Assigns the String to this instance. More...

Public Member Functions inherited from Arp::Base::Rsc::Commons::RscStringBase
	operator String (void) const
	Converts this object implicit to an instance of type String. More...

size_t	GetLength (void) const
	Gets the length of this string. More...

const char *	CStr (void) const
	Returns a `const char` pointer to the internal string buffer. More...

String	ToString (void) const
	Converts this object to an instance of type String. More...

void	Clear (void)
	Clears this instance resulting in an empty string.

void	Assign (const char *pChars)
	Assigns the char buffer to this instance. More...

void	Assign (const String &str)
	Assigns the String to this instance. More...

void	Read (RscReader &reader)
	Reads this string from RSC. More...

void	Write (RscWriter &writer) const
	Writes this string to RSC. More...

Static Public Member Functions
static constexpr size_t	GetMaxLength (void)
	Get the maximal string length of this instance excluding string terminator. More...

Protected Member Functions
	RscString (RscType stringType)
	Constructor for type < see cref="RscSecureString"/>. More...

Protected Member Functions inherited from Arp::Base::Rsc::Commons::RscStringBase
	RscStringBase (RscType stringType)
	Constructs an empty RscStringBase instance. More...

	RscStringBase (const RscStringBase &arg)
	Default copy constructor. More...

	RscStringBase (RscStringBase &&arg) noexcept
	Default move constructor. More...

RscStringBase &	operator= (const RscStringBase &arg)=delete

RscStringBase &	operator= (RscStringBase &&arg) noexcept=delete

	~RscStringBase (void)
	Default destructor.

void	SetBufferInfo (char *pStringBuffer, size_t bufferSize, size_t strLength=0)
	Constructs an empty RscStringBase instance. More...

void	SetBufferInfo (char pStringBuffer, size_t bufferSize, const char pChars)
	Constructs a RscStringBase instance. More...

void	SetBufferInfo (char *pStringBuffer, size_t bufferSize, const String &str)
	Constructs a RscStringBase instance. More...

void	Assign (const char *pChars, size_t count)
	Copies the char buffer to this instance with a given length. More...

void	SetStringType (RscType value)
	Sets the string type of this instance. More...

RscType	GetStringType (void) const
	Gets the string type of this instance. More...

Friends
std::ostream &	operator<< (std::ostream &os, const RscString &str)
	The ostream operator is used for logging and string formatting. More...

std::istream &	operator>> (std::istream &is, RscString &str)
	The istream operator is used for string parsing. More...

Detailed Description

template<int N>
class Arp::Base::Rsc::Commons::RscString< N >

Contains a static string with string lentgh up to N characters. The string shall be null terminated.

Template Parameters

N	The maximal length of the string, excluding NUL terminator.

Constructor & Destructor Documentation

◆ RscString() [1/6]

template<int N>

Arp::Base::Rsc::Commons::RscString< N >::RscString ( const char * pChars )

inline

Constructs an RscString instance and copies the null terminated c-string in internal buffer.

Parameters

pChars Null terminated string to copy into internal buffer

◆ RscString() [2/6]

template<int N>

Arp::Base::Rsc::Commons::RscString< N >::RscString ( const char8u * pChars )

inline

Constructs an RscString instance and copies the null terminated c-string in internal buffer.

Parameters

pChars Null terminated UTF8 string to copy into internal buffer.

◆ RscString() [3/6]

template<int N>

Arp::Base::Rsc::Commons::RscString< N >::RscString ( const String & arg )

inline

Constructor for type String.

Parameters

arg	The string to copy to this object.

◆ RscString() [4/6]

template<int N>

Arp::Base::Rsc::Commons::RscString< N >::RscString ( const RscString< N > & arg )

inline

Default copy constructor.

Parameters

arg	The argument to copy.

◆ RscString() [5/6]

template<int N>

Arp::Base::Rsc::Commons::RscString< N >::RscString ( RscString< N > && arg )

inlinenoexcept

Default move constructor.

Parameters

arg	The argument to move.

◆ RscString() [6/6]

template<int N>

Arp::Base::Rsc::Commons::RscString< N >::RscString ( RscType stringType )

inlineexplicitprotected

Constructor for type < see cref="RscSecureString"/>.

Parameters

stringType The type of the string, i.e. <see cref=RscString"/> or <see cref=RscSecureString"/>.

Member Function Documentation

◆ GetMaxLength()

template<int N>

constexpr size_t Arp::Base::Rsc::Commons::RscString< N >::GetMaxLength ( void )

inlinestaticconstexpr

Get the maximal string length of this instance excluding string terminator.

Returns: The max length of this string.

◆ operator=() [1/5]

template<int N>

RscString< N > & Arp::Base::Rsc::Commons::RscString< N >::operator= ( const char * pChars )

inline

Assigns the char buffer to this instance.

Parameters

pChars The char buffer to assign to this instance.

Returns: This instance.

◆ operator=() [2/5]

template<int N>

RscString< N > & Arp::Base::Rsc::Commons::RscString< N >::operator= ( const char8u * pChars )

inline

Assigns the UTF8 char buffer to this instance.

Parameters

pChars The UTF8 char buffer to assign to this instance.

Returns: This instance.

◆ operator=() [3/5]

template<int N>

RscString< N > & Arp::Base::Rsc::Commons::RscString< N >::operator= ( const RscString< N > & arg )

inline

Default copy-assignment operator.

Parameters

arg	The argument to copy.

Returns: This instance.

◆ operator=() [4/5]

template<int N>

RscString< N > & Arp::Base::Rsc::Commons::RscString< N >::operator= ( const String & str )

inline

Assigns the String to this instance.

Parameters

str	The String to assign to this instance.

Returns: This instance.

◆ operator=() [5/5]

template<int N>

RscString< N > & Arp::Base::Rsc::Commons::RscString< N >::operator= ( RscString< N > && arg )

inlinenoexcept

Default move-assignment operator.

Parameters

arg	The argument to move.

Returns: This instance.

Friends And Related Function Documentation

◆ operator<<

template<int N>

std::ostream & operator<<	(	std::ostream &	os,
		const RscString< N > &	str
	)

friend

The ostream operator is used for logging and string formatting.

Parameters

os	The stream to write to.
str	The string to write to the stream.

Returns: The as argument passed stream os .

◆ operator>>

template<int N>

std::istream & operator>>	(	std::istream &	is,
		RscString< N > &	str
	)

friend

The istream operator is used for string parsing.

Parameters

is	The stream to read from.
str	The string to read.

Returns: The as argument passed stream is .

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

Arp/Base/Rsc/Commons/RscString.hxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ RscString() [1/6]

◆ RscString() [2/6]

◆ RscString() [3/6]

◆ RscString() [4/6]

◆ RscString() [5/6]

◆ RscString() [6/6]

Member Function Documentation

◆ GetMaxLength()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

Friends And Related Function Documentation

◆ operator<<

◆ operator>>