Reference to a constant string (not taking a copy) More...
#include <document.h>
Public Types | |
typedef CharType | Ch |
character type of the string More... | |
Public Member Functions | |
template<SizeType N> | |
GenericStringRef (const CharType(&str)[N]) RAPIDJSON_NOEXCEPT | |
Create string reference from const character array. More... | |
GenericStringRef (const CharType *str) | |
Explicitly create string reference from const character pointer. More... | |
GenericStringRef (const CharType *str, SizeType len) | |
Create constant string reference from pointer and length. More... | |
GenericStringRef (const GenericStringRef &rhs) | |
operator const Ch * () const | |
implicit conversion to plain CharType pointer More... | |
Public Attributes | |
const SizeType | length |
length of the string (excluding the trailing NULL terminator) More... | |
const Ch *const | s |
plain CharType pointer More... | |
Private Member Functions | |
template<SizeType N> | |
GenericStringRef (CharType(&str)[N]) | |
Disallow construction from non-const array. More... | |
SizeType | NotNullStrLen (const CharType *str) |
GenericStringRef & | operator= (const GenericStringRef &rhs) |
Copy assignment operator not permitted - immutable type. More... | |
Static Private Attributes | |
static const Ch | emptyString [] = { CharType() } |
Empty string - used when passing in a NULL pointer. More... | |
Related Functions | |
(Note that these are not member functions.) | |
template<typename CharType > | |
GenericStringRef< CharType > | StringRef (const CharType *str) |
Mark a character pointer as constant string. More... | |
template<typename CharType > | |
GenericStringRef< CharType > | StringRef (const CharType *str, size_t length) |
Mark a character pointer as constant string. More... | |
Reference to a constant string (not taking a copy)
CharType | character type of the string |
This helper class is used to automatically infer constant string references for string literals, especially from const
(!) character arrays.
The main use is for creating JSON string values without copying the source string via an Allocator. This requires that the referenced string pointers have a sufficient lifetime, which exceeds the lifetime of the associated GenericValue.
Example
Definition at line 334 of file document.h.
typedef CharType GenericStringRef< CharType >::Ch |
character type of the string
Definition at line 336 of file document.h.
|
inline |
Create string reference from const
character array.
This constructor implicitly creates a constant string reference from a const
character array. It has better performance than StringRef(const CharType*) by inferring the string length from the array length, and also supports strings containing null characters.
N | length of the string, automatically inferred |
str | Constant character array, lifetime assumed to be longer than the use of the string in e.g. a GenericValue |
snprintf
are excluded from consideration. In such cases, the referenced string should be copied to the GenericValue instead. Definition at line 364 of file document.h.
|
inlineexplicit |
Explicitly create string reference from const
character pointer.
This constructor can be used to explicitly create a reference to a constant string pointer.
str | Constant character pointer, lifetime assumed to be longer than the use of the string in e.g. a GenericValue |
snprintf
are excluded from consideration. In such cases, the referenced string should be copied to the GenericValue instead. Definition at line 389 of file document.h.
|
inline |
Create constant string reference from pointer and length.
str | constant string, lifetime assumed to be longer than the use of the string in e.g. a GenericValue |
len | length of the string, excluding the trailing NULL terminator |
Definition at line 402 of file document.h.
|
inline |
Definition at line 407 of file document.h.
|
private |
Disallow construction from non-const array.
|
inlineprivate |
Definition at line 421 of file document.h.
|
inline |
implicit conversion to plain CharType pointer
Definition at line 412 of file document.h.
|
private |
Copy assignment operator not permitted - immutable type.
|
related |
Mark a character pointer as constant string.
Mark a plain character pointer as a "string literal". This function can be used to avoid copying a character string to be referenced as a value in a JSON GenericValue object, if the string's lifetime is known to be valid long enough.
CharType | Character type of the string |
str | Constant string, lifetime assumed to be longer than the use of the string in e.g. a GenericValue |
Definition at line 454 of file document.h.
|
related |
Mark a character pointer as constant string.
Mark a plain character pointer as a "string literal". This function can be used to avoid copying a character string to be referenced as a value in a JSON GenericValue object, if the string's lifetime is known to be valid long enough.
This version has better performance with supplied length, and also supports string containing null characters.
CharType | character type of the string |
str | Constant string, lifetime assumed to be longer than the use of the string in e.g. a GenericValue |
length | The length of source string. |
Definition at line 475 of file document.h.
|
staticprivate |
Empty string - used when passing in a NULL pointer.
Definition at line 428 of file document.h.
const SizeType GenericStringRef< CharType >::length |
length of the string (excluding the trailing NULL terminator)
Definition at line 418 of file document.h.
const Ch* const GenericStringRef< CharType >::s |
plain CharType pointer
Definition at line 417 of file document.h.