String.ipp File Reference

#include "Arp/Base/Core/Detail/BasicString.hxx"
#include "Arp/Base/Core/Detail/BasicString.inl"
#include <functional>

Include dependency graph for String.ipp:

This graph shows which files directly or indirectly include this file:

Namespaces
namespace	Arp
	Root namespace for the PLCnext API

Functions
ARP_STRING_EXPORT_DECL std::ostream &	Arp::Base::Core::operator<< (std::ostream &os, const String &right)
	Streams the right string to the out-stream os . More...
ARP_STRING_EXPORT_DECL std::istream &	Arp::Base::Core::operator>> (std::istream &is, String &right)
	Streams the in-stream is into the right string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (const String &left, const String &right)
	Concatenates the right string to the left string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (const String &left, const String::CharType *right)
	Concatenates the right C-string to the left string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (const String &left, const String::CharType right)
	Concatenates the right character to the left string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (const String::CharType left, const String &right)
	Concatenates the right string to the left character. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (const String::CharType *left, const String &right)
	Concatenates the right string to the left string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (const String &left, String &&right)
	Concatenates the right string to the left string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (String &&left, const String &right)
	Concatenates the right string to the left string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (String &&left, const String::CharType *right)
	Concatenates the right string to the left string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (String &&left, String::CharType right)
	Concatenates the right character to the left string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (String &&left, String &&right)
	Concatenates the right string to the left string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (const String::CharType *left, String &&right)
	Concatenates the right string to the left string. More...
ARP_STRING_EXPORT_DECL String	Arp::Base::Core::operator+ (String::CharType left, String &&right)
	Concatenates the right string to the left character. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator== (const String &left, const String &right)
	Compares the left string to the right string on equality. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator== (const String::CharType *left, const String &right)
	Compares the left string to the right string on equality. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator== (const String &left, const String::CharType *right)
	Compares the left string to the right string on equality. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator!= (const String::CharType *left, const String &right)
	Compares the left string to the right string on inequality. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator!= (const String &left, const String::CharType *right)
	Compares the left string to the right string on inequality. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator< (const String::CharType *left, const String &right)
	Compares the left string to the right string. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator< (const String &left, const String::CharType *right)
	Compares the left string to the right string. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator> (const String::CharType *left, const String &right)
	Compares the left string to the right string. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator> (const String &left, const String::CharType *right)
	Compares the left string to the right string. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator<= (const String::CharType *left, const String &right)
	Compares the left string to the right string. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator<= (const String &left, const String::CharType *right)
	Compares the left string to the right string. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator>= (const String::CharType *left, const String &right)
	Compares the left string to the right string. More...
ARP_STRING_EXPORT_DECL bool	Arp::Base::Core::operator>= (const String &left, const String::CharType *right)
	Compares the left string to the right string. More...
ARP_STRING_EXPORT_DECL String::ThreeWayCompareResult	Arp::Base::Core::operator<=> (const String &left, const String &right)
	Three-way compares the left string to the right string. More...
ARP_STRING_EXPORT_DECL void	Arp::Base::Core::swap (String &left, String &right) noexcept
	Swaps the content of the left string with the content of the right string. More...

Detailed Description

Contains the definitions of class String which are directly delegated to the underlying std::string

Function Documentation

operator!=() [1/2]

ARP_STRING_EXPORT bool Arp::Base::Core::operator!=	(	const String &	left,
		const String::CharType *	right
	)

Compares the left string to the right string on inequality.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the strings are not equal, otherwise false.

operator!=() [2/2]

ARP_STRING_EXPORT bool Arp::Base::Core::operator!=	(	const String::CharType *	left,
		const String &	right
	)

Compares the left string to the right string on inequality.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the strings are not equal, otherwise false.

operator+() [1/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	const String &	left,
		const String &	right
	)

Concatenates the right string to the left string.

Parameters

left	The string to append the right string to.
right	The string to append to the left string.

Returns

The concatenated string.

operator+() [2/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	const String &	left,
		const String::CharType *	right
	)

Concatenates the right C-string to the left string.

Parameters

left	The string to append the right C-string to.
right	The C-string to append to the left string.

Returns

The concatenated string.

operator+() [3/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	const String &	left,
		const String::CharType	right
	)

Concatenates the right character to the left string.

Parameters

left	The string to append the right character to.
right	The character to append to the left string.

Returns

The concatenated string.

operator+() [4/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	const String &	left,
		String &&	right
	)

Concatenates the right string to the left string.

Parameters

left	The string to append the right string to.
right	The string to append to the left string.

Returns

The concatenated string.

operator+() [5/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	const String::CharType *	left,
		const String &	right
	)

Concatenates the right string to the left string.

Parameters

left	The C-string to append the right string to.
right	The string to append to the left C-string.

Returns

The concatenated string.

operator+() [6/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	const String::CharType *	left,
		String &&	right
	)

Concatenates the right string to the left string.

Parameters

left	The string to append the right string to.
right	The string to append to the left string.

Returns

The concatenated string.

operator+() [7/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	const String::CharType	left,
		const String &	right
	)

Concatenates the right string to the left character.

Parameters

left	The character to append the right string to.
right	The string to append to the left character.

Returns

The concatenated string.

operator+() [8/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	String &&	left,
		const String &	right
	)

Concatenates the right string to the left string.

Parameters

left	The string to append the right string to.
right	The string to append to the left string.

Returns

The concatenated string.

operator+() [9/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	String &&	left,
		const String::CharType *	right
	)

Concatenates the right string to the left string.

Parameters

left	The string to append the right string to.
right	The string to append to the left string.

Returns

The concatenated string.

operator+() [10/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	String &&	left,
		String &&	right
	)

Concatenates the right string to the left string.

Parameters

left	The string to append the right string to.
right	The string to append to the left string.

Returns

The concatenated string.

operator+() [11/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	String &&	left,
		String::CharType	right
	)

Concatenates the right character to the left string.

Parameters

left	The string to append the right character to.
right	The character to append to the left string.

Returns

The concatenated string.

operator+() [12/12]

ARP_STRING_EXPORT String Arp::Base::Core::operator+	(	String::CharType	left,
		String &&	right
	)

Concatenates the right string to the left character.

Parameters

left	The character to append the right string to.
right	The string to append to the left character.

Returns

The concatenated string.

operator<() [1/2]

ARP_STRING_EXPORT bool Arp::Base::Core::operator<	(	const String &	left,
		const String::CharType *	right
	)

Compares the left string to the right string.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the left string is less than the right string, otherwise false.

operator<() [2/2]

ARP_STRING_EXPORT bool Arp::Base::Core::operator<	(	const String::CharType *	left,
		const String &	right
	)

Compares the left string to the right string.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the left string is less than the right string, otherwise false.

operator<<()

ARP_STRING_EXPORT std::ostream & Arp::Base::Core::operator<<	(	std::ostream &	os,
		const String &	right
	)

Streams the right string to the out-stream os .

Parameters

os	The out-stream to stream to.
right	The string to stream.

Returns

The out-stream os .

operator<=() [1/2]

ARP_STRING_EXPORT bool Arp::Base::Core::operator<=	(	const String &	left,
		const String::CharType *	right
	)

Compares the left string to the right string.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the left string is less or equal than the right string, otherwise false.

operator<=() [2/2]

ARP_STRING_EXPORT bool Arp::Base::Core::operator<=	(	const String::CharType *	left,
		const String &	right
	)

Compares the left string to the right string.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the left string is less or equal than the right string, otherwise false.

operator<=>()

ARP_STRING_EXPORT String::ThreeWayCompareResult Arp::Base::Core::operator<=>	(	const String &	left,
		const String &	right
	)

Three-way compares the left string to the right string.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

The three-way compare result of underlying std::string.

The C++ 20 three-way-compare operator will generate the definitions of all string compare operators: <, >, <=, >=, ==, !=.

operator==() [1/3]

ARP_STRING_EXPORT bool Arp::Base::Core::operator==	(	const String &	left,
		const String &	right
	)

Compares the left string to the right string on equality.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the strings are equal, otherwise false.

operator==() [2/3]

ARP_STRING_EXPORT bool Arp::Base::Core::operator==	(	const String &	left,
		const String::CharType *	right
	)

Compares the left string to the right string on equality.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the strings are equal, otherwise false.

operator==() [3/3]

ARP_STRING_EXPORT bool Arp::Base::Core::operator==	(	const String::CharType *	left,
		const String &	right
	)

Compares the left string to the right string on equality.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the strings are equal, otherwise false.

operator>() [1/2]

ARP_STRING_EXPORT bool Arp::Base::Core::operator>	(	const String &	left,
		const String::CharType *	right
	)

Compares the left string to the right string.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the left string is greater than the right string, otherwise false.

operator>() [2/2]

ARP_STRING_EXPORT bool Arp::Base::Core::operator>	(	const String::CharType *	left,
		const String &	right
	)

Compares the left string to the right string.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the left string is greater than the right string, otherwise false.

operator>=() [1/2]

ARP_STRING_EXPORT bool Arp::Base::Core::operator>=	(	const String &	left,
		const String::CharType *	right
	)

Compares the left string to the right string.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the left string is greater or equal than the right string, otherwise false.

operator>=() [2/2]

ARP_STRING_EXPORT bool Arp::Base::Core::operator>=	(	const String::CharType *	left,
		const String &	right
	)

Compares the left string to the right string.

Parameters

left	The string to compare to the right string.
right	The string to compare to the left string.

Returns

true if the left string is greater or equal than the right string, otherwise false.

operator>>()

ARP_STRING_EXPORT std::istream & Arp::Base::Core::operator>>	(	std::istream &	is,
		String &	right
	)

Streams the in-stream is into the right string.

Parameters

is	The in-stream to stream from.
right	The string to stream into.

Returns

The in-stream is .

swap()

ARP_STRING_EXPORT void Arp::Base::Core::swap ( String &  left, String &  right  )

noexcept

Swaps the content of the left string with the content of the right string.

Parameters

left	The first string to swap.
right	The second string to swap.