Represents a JSON value. Use Value for UTF8 encoding and default allocator. More...

#include <document.h>

Inheritance diagram for GenericValue< Encoding, Allocator >:

Collaboration diagram for GenericValue< Encoding, Allocator >:

Classes
struct	ArrayData

union	Data

struct	Flag

union	Number

struct	ObjectData

struct	ShortString

struct	String

Public Types
enum	{ kBoolFlag = 0x0008, kNumberFlag = 0x0010, kIntFlag = 0x0020, kUintFlag = 0x0040, kInt64Flag = 0x0080, kUint64Flag = 0x0100, kDoubleFlag = 0x0200, kStringFlag = 0x0400, kCopyFlag = 0x0800, kInlineStrFlag = 0x1000, kNullFlag = kNullType, kTrueFlag = kTrueType \| kBoolFlag, kFalseFlag = kFalseType \| kBoolFlag, kNumberIntFlag = kNumberType \| kNumberFlag \| kIntFlag \| kInt64Flag, kNumberUintFlag = kNumberType \| kNumberFlag \| kUintFlag \| kUint64Flag \| kInt64Flag, kNumberInt64Flag = kNumberType \| kNumberFlag \| kInt64Flag, kNumberUint64Flag = kNumberType \| kNumberFlag \| kUint64Flag, kNumberDoubleFlag = kNumberType \| kNumberFlag \| kDoubleFlag, kNumberAnyFlag = kNumberType \| kNumberFlag \| kIntFlag \| kInt64Flag \| kUintFlag \| kUint64Flag \| kDoubleFlag, kConstStringFlag = kStringType \| kStringFlag, kCopyStringFlag = kStringType \| kStringFlag \| kCopyFlag, kShortStringFlag = kStringType \| kStringFlag \| kCopyFlag \| kInlineStrFlag, kObjectFlag = kObjectType, kArrayFlag = kArrayType, kTypeMask = 0x07 }

typedef GenericMember< Encoding, Allocator >	Member
	Name-value pair in an object. More...

typedef Encoding	EncodingType
	Encoding type from template parameter. More...

typedef Allocator	AllocatorType
	Allocator type from template parameter. More...

typedef Encoding::Ch	Ch
	Character type derived from Encoding. More...

typedef GenericStringRef< Ch >	StringRefType
	Reference to a constant string. More...

typedef GenericMemberIterator< false, Encoding, Allocator >::Iterator	MemberIterator
	Member iterator for iterating in object. More...

typedef GenericMemberIterator< true, Encoding, Allocator >::Iterator	ConstMemberIterator
	Constant member iterator for iterating in object. More...

typedef GenericValue *	ValueIterator
	Value iterator for iterating in array. More...

typedef const GenericValue *	ConstValueIterator
	Constant value iterator for iterating in array. More...

typedef GenericValue< Encoding, Allocator >	ValueType
	Value type of itself. More...

typedef GenericArray< false, ValueType >	Array

typedef GenericArray< true, ValueType >	ConstArray

typedef GenericObject< false, ValueType >	Object

typedef GenericObject< true, ValueType >	ConstObject

Public Member Functions
template<typename T >
	RAPIDJSON_DISABLEIF_RETURN ((internal::IsPointer< T >),(GenericValue &)) operator
	Assignment with primitive types. More...

RAPIDJSON_FORCEINLINE const Ch *	GetStringPointer () const

RAPIDJSON_FORCEINLINE const Ch *	SetStringPointer (const Ch *str)

RAPIDJSON_FORCEINLINE GenericValue *	GetElementsPointer () const

RAPIDJSON_FORCEINLINE GenericValue *	SetElementsPointer (GenericValue *elements)

RAPIDJSON_FORCEINLINE Member *	GetMembersPointer () const

RAPIDJSON_FORCEINLINE Member *	SetMembersPointer (Member *members)

void	SetArrayRaw (GenericValue *values, SizeType count, Allocator &allocator)

void	SetObjectRaw (Member *members, SizeType count, Allocator &allocator)
	Initialize this value as object with initial data, without calling destructor. More...

void	SetStringRaw (StringRefType s) RAPIDJSON_NOEXCEPT
	Initialize this value as constant string, without calling destructor. More...

void	SetStringRaw (StringRefType s, Allocator &allocator)
	Initialize this value as copy string with initial data, without calling destructor. More...

void	RawAssign (GenericValue &rhs) RAPIDJSON_NOEXCEPT
	Assignment without calling destructor. More...

template<typename SourceAllocator >
bool	StringEqual (const GenericValue< Encoding, SourceAllocator > &rhs) const

Assignment operators
GenericValue &	operator= (GenericValue &rhs) RAPIDJSON_NOEXCEPT
	Assignment with move semantics. More...

GenericValue &	operator= (StringRefType str) RAPIDJSON_NOEXCEPT
	Assignment of constant string reference (no copy) More...

Public Attributes
Data	data_

Static Public Attributes
static const SizeType	kDefaultArrayCapacity = 16

static const SizeType	kDefaultObjectCapacity = 16

Friends
template<typename , typename , typename >
class	GenericDocument

Constructors and destructor.
	GenericValue () RAPIDJSON_NOEXCEPT
	Default constructor creates a null value. More...

	GenericValue (Type type) RAPIDJSON_NOEXCEPT
	Constructor with JSON value type. More...

template<typename SourceAllocator >
	GenericValue (const GenericValue< Encoding, SourceAllocator > &rhs, Allocator &allocator)
	Explicit copy constructor (with allocator) More...

template<typename T >
	GenericValue (T b, RAPIDJSON_ENABLEIF((internal::IsSame< bool, T >))) RAPIDJSON_NOEXCEPT
	Constructor for boolean value. More...

	GenericValue (int i) RAPIDJSON_NOEXCEPT
	Constructor for int value. More...

	GenericValue (unsigned u) RAPIDJSON_NOEXCEPT
	Constructor for unsigned value. More...

	GenericValue (int64_t i64) RAPIDJSON_NOEXCEPT
	Constructor for int64_t value. More...

	GenericValue (uint64_t u64) RAPIDJSON_NOEXCEPT
	Constructor for uint64_t value. More...

	GenericValue (double d) RAPIDJSON_NOEXCEPT
	Constructor for double value. More...

	GenericValue (const Ch *s, SizeType length) RAPIDJSON_NOEXCEPT
	Constructor for constant string (i.e. do not make a copy of string) More...

	GenericValue (StringRefType s) RAPIDJSON_NOEXCEPT
	Constructor for constant string (i.e. do not make a copy of string) More...

	GenericValue (const Ch *s, SizeType length, Allocator &allocator)
	Constructor for copy-string (i.e. do make a copy of string) More...

	GenericValue (const Ch *s, Allocator &allocator)
	Constructor for copy-string (i.e. do make a copy of string) More...

	GenericValue (Array a) RAPIDJSON_NOEXCEPT
	Constructor for Array. More...

	GenericValue (Object o) RAPIDJSON_NOEXCEPT
	Constructor for Object. More...

	~GenericValue ()
	Destructor. More...

	GenericValue (const GenericValue &rhs)
	Copy constructor is not permitted. More...

Detailed Description

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>
class GenericValue< Encoding, Allocator >

Represents a JSON value. Use Value for UTF8 encoding and default allocator.

A JSON value can be one of 7 types. This class is a variant type supporting these types.

Use the Value if UTF8 and default allocator

Template Parameters

Encoding	Encoding of the value. (Even non-string values need to have the same encoding in a document)
Allocator	Allocator type for allocating memory of object, array and string.

Member Typedef Documentation

◆ AllocatorType

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef Allocator GenericValue< Encoding, Allocator >::AllocatorType

Allocator type from template parameter.

◆ Array

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericArray<false, ValueType> GenericValue< Encoding, Allocator >::Array

◆ Ch

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef Encoding::Ch GenericValue< Encoding, Allocator >::Ch

Character type derived from Encoding.

◆ ConstArray

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericArray<true, ValueType> GenericValue< Encoding, Allocator >::ConstArray

◆ ConstMemberIterator

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericMemberIterator<true,Encoding,Allocator>::Iterator GenericValue< Encoding, Allocator >::ConstMemberIterator

Constant member iterator for iterating in object.

◆ ConstObject

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericObject<true, ValueType> GenericValue< Encoding, Allocator >::ConstObject

◆ ConstValueIterator

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef const GenericValue* GenericValue< Encoding, Allocator >::ConstValueIterator

Constant value iterator for iterating in array.

◆ EncodingType

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef Encoding GenericValue< Encoding, Allocator >::EncodingType

Encoding type from template parameter.

◆ Member

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericMember<Encoding, Allocator> GenericValue< Encoding, Allocator >::Member

Name-value pair in an object.

◆ MemberIterator

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericMemberIterator<false,Encoding,Allocator>::Iterator GenericValue< Encoding, Allocator >::MemberIterator

Member iterator for iterating in object.

◆ Object

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericObject<false, ValueType> GenericValue< Encoding, Allocator >::Object

◆ StringRefType

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericStringRef<Ch> GenericValue< Encoding, Allocator >::StringRefType

Reference to a constant string.

◆ ValueIterator

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericValue* GenericValue< Encoding, Allocator >::ValueIterator

Value iterator for iterating in array.

◆ ValueType

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericValue<Encoding, Allocator> GenericValue< Encoding, Allocator >::ValueType

Value type of itself.

Member Enumeration Documentation

◆ anonymous enum

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

anonymous enum

Enumerator
kBoolFlag
kNumberFlag
kIntFlag
kUintFlag
kInt64Flag
kUint64Flag
kDoubleFlag
kStringFlag
kCopyFlag
kInlineStrFlag
kNullFlag
kTrueFlag
kFalseFlag
kNumberIntFlag
kNumberUintFlag
kNumberInt64Flag
kNumberUint64Flag
kNumberDoubleFlag
kNumberAnyFlag
kConstStringFlag
kCopyStringFlag
kShortStringFlag
kObjectFlag
kArrayFlag
kTypeMask

Constructor & Destructor Documentation

◆ GenericValue() [1/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( )

inline

Default constructor creates a null value.

◆ GenericValue() [2/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( const GenericValue< Encoding, Allocator > & rhs )

private

Copy constructor is not permitted.

◆ GenericValue() [3/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( Type type )

inlineexplicit

Constructor with JSON value type.

This creates a Value of specified type with default content.

Parameters

type	Type of the value.

Note: Default content for number is zero.

◆ GenericValue() [4/16]

template<typename Encoding, typename Allocator>

template<typename SourceAllocator >

GenericValue< Encoding, Allocator >::GenericValue	(	const GenericValue< Encoding, SourceAllocator > &	rhs,
		Allocator &	allocator
	)

inline

Explicit copy constructor (with allocator)

Creates a copy of a Value by using the given Allocator

Template Parameters

SourceAllocator allocator of rhs

Parameters

rhs	Value to copy from (read-only)
allocator	Allocator for allocating copied elements and buffers. Commonly use GenericDocument::GetAllocator().

See also: CopyFrom()

◆ GenericValue() [5/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

template<typename T >

GenericValue< Encoding, Allocator >::GenericValue	(	T	b,
		RAPIDJSON_ENABLEIF((internal::IsSame< bool, T >))
	)

inlineexplicit

Constructor for boolean value.

Parameters

b	Boolean value

Note: This constructor is limited to real boolean values and rejects implicitly converted types like arbitrary pointers. Use an explicit cast to bool, if you want to construct a boolean JSON value in such cases.

◆ GenericValue() [6/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( int i )

inlineexplicit

Constructor for int value.

◆ GenericValue() [7/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( unsigned u )

inlineexplicit

Constructor for unsigned value.

◆ GenericValue() [8/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( int64_t i64 )

inlineexplicit

Constructor for int64_t value.

◆ GenericValue() [9/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( uint64_t u64 )

inlineexplicit

Constructor for uint64_t value.

◆ GenericValue() [10/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( double d )

inlineexplicit

Constructor for double value.

◆ GenericValue() [11/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue	(	const Ch *	s,
		SizeType	length
	)

inline

Constructor for constant string (i.e. do not make a copy of string)

◆ GenericValue() [12/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( StringRefType s )

inlineexplicit

Constructor for constant string (i.e. do not make a copy of string)

◆ GenericValue() [13/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue	(	const Ch *	s,
		SizeType	length,
		Allocator &	allocator
	)

inline

Constructor for copy-string (i.e. do make a copy of string)

◆ GenericValue() [14/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue	(	const Ch *	s,
		Allocator &	allocator
	)

inline

Constructor for copy-string (i.e. do make a copy of string)

◆ GenericValue() [15/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( Array a )

inline

Constructor for Array.

Parameters

a	An array obtained by `GetArray()`.

Note: Array is always pass-by-value.; the source array is moved into this value and the sourec array becomes empty.

◆ GenericValue() [16/16]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( Object o )

inline

Constructor for Object.

Parameters

o	An object obtained by `GetObject()`.

Note: Object is always pass-by-value.; the source object is moved into this value and the sourec object becomes empty.

◆ ~GenericValue()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::~GenericValue ( )

inline

Destructor.

Need to destruct elements of array, members of object, or copy-string.

Here is the caller graph for this function:

Member Function Documentation

◆ GetElementsPointer()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

RAPIDJSON_FORCEINLINE GenericValue* GenericValue< Encoding, Allocator >::GetElementsPointer ( ) const

inline

Here is the caller graph for this function:

◆ GetMembersPointer()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

RAPIDJSON_FORCEINLINE Member* GenericValue< Encoding, Allocator >::GetMembersPointer ( ) const

inline

Here is the caller graph for this function:

◆ GetStringPointer()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

RAPIDJSON_FORCEINLINE const Ch* GenericValue< Encoding, Allocator >::GetStringPointer ( ) const

inline

Here is the caller graph for this function:

◆ operator=() [1/2]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue& GenericValue< Encoding, Allocator >::operator= ( GenericValue< Encoding, Allocator > & rhs )

inline

Assignment with move semantics.

Parameters

rhs	Source of the assignment. It will become a null value after assignment.

Here is the caller graph for this function:

◆ operator=() [2/2]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue& GenericValue< Encoding, Allocator >::operator= ( StringRefType str )

inline

Assignment of constant string reference (no copy)

Parameters

str	Constant string reference to be assigned

Note: This overload is needed to avoid clashes with the generic primitive type assignment overload below.

See also: GenericStringRef, operator=(T)

◆ RAPIDJSON_DISABLEIF_RETURN()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

template<typename T >

GenericValue< Encoding, Allocator >::RAPIDJSON_DISABLEIF_RETURN	(	(internal::IsPointer< T >)	,
		(GenericValue< Encoding, Allocator > &)
	)

Assignment with primitive types.

Template Parameters

T	Either Type, `int`, `unsigned`, `int64_t`, `uint64_t`

Parameters

value The value to be assigned.

Note: The source type T explicitly disallows all pointer types, especially (const) Ch*. This helps avoiding implicitly referencing character strings with insufficient lifetime, use SetString(const Ch*, Allocator&) (for copying) or StringRef() (to explicitly mark the pointer as constant) instead. All other pointer types would implicitly convert to bool, use SetBool() instead.Set boolean value

◆ RawAssign()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

void GenericValue< Encoding, Allocator >::RawAssign ( GenericValue< Encoding, Allocator > & rhs )

inline

Assignment without calling destructor.

Here is the caller graph for this function:

◆ SetArrayRaw()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

void GenericValue< Encoding, Allocator >::SetArrayRaw	(	GenericValue< Encoding, Allocator > *	values,
		SizeType	count,
		Allocator &	allocator
	)

inline

Here is the caller graph for this function:

◆ SetElementsPointer()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

RAPIDJSON_FORCEINLINE GenericValue* GenericValue< Encoding, Allocator >::SetElementsPointer ( GenericValue< Encoding, Allocator > * elements )

inline

Here is the caller graph for this function:

◆ SetMembersPointer()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

RAPIDJSON_FORCEINLINE Member* GenericValue< Encoding, Allocator >::SetMembersPointer ( Member * members )

inline

Here is the caller graph for this function:

◆ SetObjectRaw()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

void GenericValue< Encoding, Allocator >::SetObjectRaw	(	Member *	members,
		SizeType	count,
		Allocator &	allocator
	)

inline

Initialize this value as object with initial data, without calling destructor.

Here is the caller graph for this function:

◆ SetStringPointer()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

RAPIDJSON_FORCEINLINE const Ch* GenericValue< Encoding, Allocator >::SetStringPointer ( const Ch * str )

inline

Here is the caller graph for this function:

◆ SetStringRaw() [1/2]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

void GenericValue< Encoding, Allocator >::SetStringRaw ( StringRefType s )

inline

Initialize this value as constant string, without calling destructor.

Here is the caller graph for this function:

◆ SetStringRaw() [2/2]

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

void GenericValue< Encoding, Allocator >::SetStringRaw	(	StringRefType	s,
		Allocator &	allocator
	)

inline

Initialize this value as copy string with initial data, without calling destructor.

◆ StringEqual()

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

template<typename SourceAllocator >

bool GenericValue< Encoding, Allocator >::StringEqual ( const GenericValue< Encoding, SourceAllocator > & rhs ) const

inline

Friends And Related Function Documentation

◆ GenericDocument

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

template<typename , typename , typename >

friend class GenericDocument

friend

Member Data Documentation

◆ data_

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

Data GenericValue< Encoding, Allocator >::data_

◆ kDefaultArrayCapacity

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

const SizeType GenericValue< Encoding, Allocator >::kDefaultArrayCapacity = 16

static

◆ kDefaultObjectCapacity

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

const SizeType GenericValue< Encoding, Allocator >::kDefaultObjectCapacity = 16

static

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

deps/discord-rpc/thirdparty/rapidjson-1.1.0/include/rapidjson/document.h

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Friends

Constructors and destructor.

Detailed Description

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>> class GenericValue< Encoding, Allocator >

Member Typedef Documentation

◆ AllocatorType

◆ Array

◆ Ch

◆ ConstArray

◆ ConstMemberIterator

◆ ConstObject

◆ ConstValueIterator

◆ EncodingType

◆ Member

◆ MemberIterator

◆ Object

◆ StringRefType

◆ ValueIterator

◆ ValueType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ GenericValue() [1/16]

◆ GenericValue() [2/16]

◆ GenericValue() [3/16]

◆ GenericValue() [4/16]

◆ GenericValue() [5/16]

◆ GenericValue() [6/16]

◆ GenericValue() [7/16]

◆ GenericValue() [8/16]

◆ GenericValue() [9/16]

◆ GenericValue() [10/16]

◆ GenericValue() [11/16]

◆ GenericValue() [12/16]

◆ GenericValue() [13/16]

◆ GenericValue() [14/16]

◆ GenericValue() [15/16]

◆ GenericValue() [16/16]

◆ ~GenericValue()

Member Function Documentation

◆ GetElementsPointer()

◆ GetMembersPointer()

◆ GetStringPointer()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ RAPIDJSON_DISABLEIF_RETURN()

◆ RawAssign()

◆ SetArrayRaw()

◆ SetElementsPointer()

◆ SetMembersPointer()

◆ SetObjectRaw()

◆ SetStringPointer()

◆ SetStringRaw() [1/2]

◆ SetStringRaw() [2/2]

◆ StringEqual()

Friends And Related Function Documentation

◆ GenericDocument

Member Data Documentation

◆ data_

◆ kDefaultArrayCapacity

◆ kDefaultObjectCapacity

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>
class GenericValue< Encoding, Allocator >