Arp::System::Commons::Encoding Namespace Reference

Namespace for classes related to string encoding More...

Classes
class	Utf16
	This static class provides encoding string operations from UTF8 to UTF16 or vice versa. More...

Enumerations
enum class	EncodingResult {   None = 0 , Success = 1 , Partial = 2 , InvalidChar = 3 ,   Error = 4 , NoConversion = 5 , InvalidArgument = 6 , OutOfMemory = 7 ,   Unspecified = 512 }
	This enum defines encoding results for operations of class Utf16. More...

Functions
ARP_CXX_SYMBOL_EXPORT std::ostream &	operator<< (std::ostream &os, EncodingResult value)
	Global output stream operator of enum EncodingResult for logging. More...
ARP_CXX_SYMBOL_EXPORT std::istream &	operator>> (std::istream &is, EncodingResult &value)
	Global input stream operator of enum EncodingResult for parsing. More...

Detailed Description

Namespace for classes related to string encoding

Enumeration Type Documentation

EncodingResult

enum Arp::System::Commons::Encoding::EncodingResult

strong

This enum defines encoding results for operations of class Utf16.

Enumerator
None	Initial value.
Success	Encoding was successful.
Partial	Not all characters were converted, e.g. if the buffer was to small.
InvalidChar	An invalid character encountered.
Error	Any error occurs during encoding/decoding.
NoConversion	No conversion required, input and output types are the same or empty.
InvalidArgument	No conversion required, input and output types are the same or empty.
OutOfMemory	Not enough memory available.
Unspecified	Unspecified conversion error.

Function Documentation

operator<<()

ARP_CXX_SYMBOL_EXPORT std::ostream& Arp::System::Commons::Encoding::operator<<	(	std::ostream &	os,
		EncodingResult	value
	)

Global output stream operator of enum EncodingResult for logging.

operator>>()

ARP_CXX_SYMBOL_EXPORT std::istream& Arp::System::Commons::Encoding::operator>>	(	std::istream &	is,
		EncodingResult &	value
	)

Global input stream operator of enum EncodingResult for parsing.