Reference to a constant string (not taking a copy) More...

#include <document.h>

Inheritance diagram for GenericStringRef< CharType >:

Collaboration diagram for GenericStringRef< CharType >:

Public Types
typedef CharType	Ch
	character type of the string

Public Member Functions
	GenericStringRef (const CharType *str)
	Explicitly create string reference from `const` character pointer.

	GenericStringRef (const CharType *str, SizeType len)
	Create constant string reference from pointer and length.

template<SizeType N>
	GenericStringRef (const CharType(&str)[N]) RAPIDJSON_NOEXCEPT
	Create string reference from `const` character array.

	GenericStringRef (const GenericStringRef &rhs)

	operator const Ch * () const
	implicit conversion to plain CharType pointer

Public Attributes
const SizeType	length
	length of the string (excluding the trailing NULL terminator)

const Ch *const	s
	plain CharType pointer

Related Symbols
(Note that these are not member symbols.)
template<typename CharType>
GenericStringRef< CharType >	StringRef (const CharType *str)
	Mark a character pointer as constant string.

template<typename CharType>
GenericStringRef< CharType >	StringRef (const CharType *str, size_t length)
	Mark a character pointer as constant string.

Detailed Description

template<typename CharType>
struct GenericStringRef< CharType >

Reference to a constant string (not taking a copy)

Template Parameters

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

Value v("foo");   // ok, no need to copy & calculate length
const char foo[] = "foo";
v.SetString(foo); // ok
 
const char* bar = foo;
// Value x(bar); // not ok, can't rely on bar's lifetime
Value x(StringRef(bar)); // lifetime explicitly guaranteed by user
Value y(StringRef(bar, 3));  // ok, explicitly pass length

See also: StringRef, GenericValue::SetString

Definition at line 335 of file document.h.

Member Typedef Documentation

◆ Ch

template<typename CharType>

typedef CharType GenericStringRef< CharType >::Ch

character type of the string

Definition at line 336 of file document.h.

Constructor & Destructor Documentation

◆ GenericStringRef() [1/4]

template<typename CharType>

template<SizeType N>

GenericStringRef< CharType >::GenericStringRef ( const CharType(&) str[N] )

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.

Template Parameters

N	length of the string, automatically inferred

Parameters

str	Constant character array, lifetime assumed to be longer than the use of the string in e.g. a GenericValue

Postcondition: s == str

Note: Constant complexity.; There is a hidden, private overload to disallow references to non-const character arrays to be created via this constructor. By this, e.g. function-scope arrays used to be filled via 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.

◆ GenericStringRef() [2/4]

template<typename CharType>

GenericStringRef< CharType >::GenericStringRef ( const CharType * str )

inlineexplicit

Explicitly create string reference from const character pointer.

This constructor can be used to explicitly create a reference to a constant string pointer.

See also: StringRef(const CharType*)

Parameters

str	Constant character pointer, lifetime assumed to be longer than the use of the string in e.g. a GenericValue

Postcondition: s == str

Note: There is a hidden, private overload to disallow references to non-const character arrays to be created via this constructor. By this, e.g. function-scope arrays used to be filled via snprintf are excluded from consideration. In such cases, the referenced string should be copied to the GenericValue instead.

Definition at line 388 of file document.h.

◆ GenericStringRef() [3/4]

template<typename CharType>

GenericStringRef< CharType >::GenericStringRef	(	const CharType *	str,
		SizeType	len )

inline

Create constant string reference from pointer and length.

Parameters

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

Postcondition: s == str && length == len

Note: Constant complexity.

Definition at line 400 of file document.h.

◆ GenericStringRef() [4/4]

template<typename CharType>

GenericStringRef< CharType >::GenericStringRef ( const GenericStringRef< CharType > & rhs )

inline

Definition at line 403 of file document.h.

Member Function Documentation

◆ operator const Ch *()

template<typename CharType>

GenericStringRef< CharType >::operator const Ch * ( ) const

inline

implicit conversion to plain CharType pointer

Definition at line 406 of file document.h.

Friends And Related Symbol Documentation

◆ StringRef() [1/2]

template<typename CharType>

GenericStringRef< CharType > StringRef ( const CharType * str )

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.

Template Parameters

CharType Character type of the string

Parameters

str	Constant string, lifetime assumed to be longer than the use of the string in e.g. a GenericValue

Returns: GenericStringRef string reference object

See also: GenericValue::GenericValue(StringRefType), GenericValue::operator=(StringRefType), GenericValue::SetString(StringRefType), GenericValue::PushBack(StringRefType, Allocator&), GenericValue::AddMember

Definition at line 443 of file document.h.

◆ StringRef() [2/2]

template<typename CharType>

GenericStringRef< CharType > StringRef	(	const CharType *	str,
		size_t	length )

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.

Template Parameters

CharType character type of the string

Parameters

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.

Returns: GenericStringRef string reference object

Definition at line 463 of file document.h.

Member Data Documentation

◆ length

template<typename CharType>

const SizeType GenericStringRef< CharType >::length

length of the string (excluding the trailing NULL terminator)

Definition at line 409 of file document.h.

◆ s

template<typename CharType>

const Ch* const GenericStringRef< CharType >::s

plain CharType pointer

Definition at line 408 of file document.h.

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

document.h

Public Types

Public Member Functions

Public Attributes

Related Symbols

Detailed Description

Member Typedef Documentation

◆ Ch

Constructor & Destructor Documentation

◆ GenericStringRef() [1/4]

◆ GenericStringRef() [2/4]

◆ GenericStringRef() [3/4]

◆ GenericStringRef() [4/4]

Member Function Documentation

◆ operator const Ch *()

Friends And Related Symbol Documentation

◆ StringRef() [1/2]

◆ StringRef() [2/2]

Member Data Documentation

◆ length

◆ s