Encoding / Decoding functions. More...

Collaboration diagram for Coding Functions:

Functions
String	Murl::Util::EncodeBase64 (const String &dataIn)
	Encode a string to a Base64 character string. More...

String	Murl::Util::EncodeBase64 (const ConstData &dataIn)
	Encode a data object to a Base64 character string. More...

String	Murl::Util::EncodeBase64 (const void *dataIn, UInt64 byteSizeIn)
	Encode a memory block to a Base64 string. More...

Data	Murl::Util::DecodeBase64 (const String &dataIn)
	Decode a Base64 character string. More...

Data	Murl::Util::DecodeBase64 (const ConstData &dataIn)
	Decode Base64 characters from a data object. More...

Data	Murl::Util::DecodeBase64 (const void *dataIn, UInt64 byteSizeIn)
	Decode Base64 characters from a memory block. More...

Bool	Murl::Util::IsBase64 (const String &dataIn)
	Check if a string is Base64 encoded. More...

Bool	Murl::Util::IsBase64 (const ConstData &dataIn)
	Check if a data object is Base64 encoded. More...

Bool	Murl::Util::IsBase64 (const void *dataIn, UInt64 byteSizeIn)
	Check if a memory block is Base64 encoded. More...

String	Murl::Util::EncodeHex (const String &dataIn)
	Encode a string to a Hex character string. More...

String	Murl::Util::EncodeHex (const ConstData &dataIn)
	Encode a data object to a Hex character string. More...

String	Murl::Util::EncodeHex (const void *dataIn, UInt64 byteSizeIn)
	Encode a memory block to a Hex character string. More...

Data	Murl::Util::DecodeHex (const String &dataIn)
	Decode a Hex character string. More...

Data	Murl::Util::DecodeHex (const ConstData &dataIn)
	Decode Hex characters from a data object. More...

Data	Murl::Util::DecodeHex (const void *dataIn, UInt64 byteSizeIn)
	Decode Hex characters from a memory block. More...

UInt64	Murl::Util::EncodeHex (const void dataIn, UInt64 byteSizeIn, void dataOut, UInt64 byteSizeOut)
	Encode a memory block to Hex characters. More...

UInt64	Murl::Util::DecodeHex (const void dataIn, UInt64 byteSizeIn, void dataOut, UInt64 byteSizeOut)
	Decode Hex characters from a memory block. More...

String	Murl::Util::EncodeUrl (const String &source)
	Encode a string to a url character string (percentage encoding). More...

String	Murl::Util::DecodeUrl (const String &source)
	Decode a url character string (percentage encoding) to a string. More...

String	Murl::Util::EncodeXml (const String &source)
	Encode a string so that it can be used as an XML attribute value. More...

Detailed Description

Encoding / Decoding functions.

Function Documentation

◆ EncodeBase64() [1/3]

String Murl::Util::EncodeBase64 ( const String & dataIn )

Encode a string to a Base64 character string.

Parameters

dataIn The source string to encode.

Returns: The Base64 character encoded string.

◆ EncodeBase64() [2/3]

String Murl::Util::EncodeBase64 ( const ConstData & dataIn )

Encode a data object to a Base64 character string.

Parameters

dataIn The source data object to encode.

Returns: The Base64 character encoded string.

◆ EncodeBase64() [3/3]

String Murl::Util::EncodeBase64	(	const void *	dataIn,
		UInt64	byteSizeIn
	)

Encode a memory block to a Base64 string.

Parameters

dataIn	Pointer to the source memory block.
byteSizeIn	The byte size of the memory block.

Returns: The Base64 character encoded string.

◆ DecodeBase64() [1/3]

Data Murl::Util::DecodeBase64 ( const String & dataIn )

Decode a Base64 character string.

Parameters

dataIn The source Base64 character string to decode.

Returns: The decoded data object.

◆ DecodeBase64() [2/3]

Data Murl::Util::DecodeBase64 ( const ConstData & dataIn )

Decode Base64 characters from a data object.

Parameters

dataIn The source data object to decode.

Returns: The decoded data object.

◆ DecodeBase64() [3/3]

Data Murl::Util::DecodeBase64	(	const void *	dataIn,
		UInt64	byteSizeIn
	)

Decode Base64 characters from a memory block.

Parameters

dataIn	Pointer to the source memory block.
byteSizeIn	The byte size of the memory block.

Returns: The decoded data object.

◆ IsBase64() [1/3]

Bool Murl::Util::IsBase64 ( const String & dataIn )

Check if a string is Base64 encoded.

Parameters

dataIn The source Base64 string.

Returns: true if the string is Base64 encoded.

◆ IsBase64() [2/3]

Bool Murl::Util::IsBase64 ( const ConstData & dataIn )

Check if a data object is Base64 encoded.

Parameters

dataIn The source Base64 data object.

Returns: true if the data object is Base64 encoded.

◆ IsBase64() [3/3]

Bool Murl::Util::IsBase64	(	const void *	dataIn,
		UInt64	byteSizeIn
	)

Check if a memory block is Base64 encoded.

Parameters

dataIn	Pointer to the source memory block.
byteSizeIn	The byte size of the memory block.

Returns: true if the memory block is Base64 encoded.

◆ EncodeHex() [1/4]

String Murl::Util::EncodeHex ( const String & dataIn )

Encode a string to a Hex character string.

Parameters

dataIn The source string to encode.

Returns: The Hex character encoded string.

◆ EncodeHex() [2/4]

String Murl::Util::EncodeHex ( const ConstData & dataIn )

Encode a data object to a Hex character string.

Parameters

dataIn The source data object to encode.

Returns: The Hex character encoded string.

◆ EncodeHex() [3/4]

String Murl::Util::EncodeHex	(	const void *	dataIn,
		UInt64	byteSizeIn
	)

Encode a memory block to a Hex character string.

Parameters

dataIn	Pointer to the source memory block.
byteSizeIn	The byte size of the memory block.

Returns: The Hex character encoded string.

◆ DecodeHex() [1/4]

Data Murl::Util::DecodeHex ( const String & dataIn )

Decode a Hex character string.

Parameters

dataIn The source Hex character string to decode.

Returns: The decoded data object.

◆ DecodeHex() [2/4]

Data Murl::Util::DecodeHex ( const ConstData & dataIn )

Decode Hex characters from a data object.

Parameters

dataIn The source data object to decode.

Returns: The decoded data object.

◆ DecodeHex() [3/4]

Data Murl::Util::DecodeHex	(	const void *	dataIn,
		UInt64	byteSizeIn
	)

Decode Hex characters from a memory block.

Parameters

dataIn	Pointer to the source memory block.
byteSizeIn	The byte size of the memory block.

Returns: The decoded data object.

◆ EncodeHex() [4/4]

UInt64 Murl::Util::EncodeHex	(	const void *	dataIn,
		UInt64	byteSizeIn,
		void *	dataOut,
		UInt64	byteSizeOut
	)

Encode a memory block to Hex characters.

Parameters

dataIn	Pointer to the source memory block.
byteSizeIn	The byte size of the source memory block.
dataOut	Pointer to the destination memory block.
byteSizeOut	The byte size of the destination memory block.

Returns: The number of bytes written into destination.

◆ DecodeHex() [4/4]

UInt64 Murl::Util::DecodeHex	(	const void *	dataIn,
		UInt64	byteSizeIn,
		void *	dataOut,
		UInt64	byteSizeOut
	)

Decode Hex characters from a memory block.

Parameters

dataIn	Pointer to the source memory block.
byteSizeIn	The byte size of the source memory block.
dataOut	Pointer to the destination memory block.
byteSizeOut	The byte size of the destination memory block.

Returns: The number of bytes written into destination.

◆ EncodeUrl()

String Murl::Util::EncodeUrl ( const String & source )

Encode a string to a url character string (percentage encoding).

Parameters

source The source string to encode.

Returns: The url character encoded string.

◆ DecodeUrl()

String Murl::Util::DecodeUrl ( const String & source )

Decode a url character string (percentage encoding) to a string.

Parameters

source The source url character string to decode.

Returns: The decoded string.

◆ EncodeXml()

String Murl::Util::EncodeXml ( const String & source )

Encode a string so that it can be used as an XML attribute value.

Parameters

source The source string to encode.

Returns: The XML encoded string.