This class provides a 'Key' wrapper for a C string literal. More...

Detailed Description

This class provides a 'Key' wrapper for a C string literal.

Keys of this type can used to compare against other KeyLiteralString, KeyStringBuffer, or Items that use a Cpl::Text::String as their key.

#include <Key.h>

Inheritance diagram for Cpl::Container::KeyLiteralString:

Collaboration diagram for Cpl::Container::KeyLiteralString:

Public Member Functions
	KeyLiteralString (const char *string)
	Constructor.

const char *	getKeyValue (void) const noexcept
	Returns the Key's content value.

	operator const char * () const
	Cast to read-only character string pointer.

const char *	operator() () const
	Returns a Read-only pointer to the "raw" (short-hand for getKeyValue())

Public Member Functions inherited from Cpl::Container::KeyStringBuffer
	KeyStringBuffer (const char *startOfString, size_t lenOfStringInBytes)
	Constructor.

const char *	getKeyValue (size_t &lenOfStringInBytes) const noexcept
	Returns the Key's content value.

int	compareKey (const Key &key) const
	Key Compare function.

const void *	getRawKey (unsigned *returnRawKeyLenPtr=0) const
	Returns the object's length (in bytes) and point to the start of key data.

Public Member Functions inherited from Cpl::Container::Key
virtual	~Key ()
	Ensure a Virtual destructor.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::KeyStringBuffer
static int	compare (const char myString, unsigned myLen, const char otherString, unsigned otherLen)
	Generic compare function for strings and string buffers.

Public Attributes inherited from Cpl::Container::KeyStringBuffer
const char *	m_stringKeyPtr
	Storage for the key.

size_t	m_len
	Number of bytes in the buffer.

Constructor & Destructor Documentation

Cpl::Container::KeyLiteralString::KeyLiteralString ( const char * string )

inline

Constructor.

const char * Cpl::Container::KeyLiteralString::getKeyValue ( void ) const

inlinenoexcept

Returns the Key's content value.

Cpl::Container::KeyLiteralString::operator const char * ( ) const

inline

Cast to read-only character string pointer.

const char * Cpl::Container::KeyLiteralString::operator() ( ) const

inline

Returns a Read-only pointer to the "raw" (short-hand for getKeyValue())

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