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

#include <document.h>

Classes
struct	ArrayData

union	Data

struct	Flag

union	Number

struct	ObjectData

struct	ShortString

struct	String

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

typedef Encoding	EncodingType
	Encoding type from template parameter.

typedef Allocator	AllocatorType
	Allocator type from template parameter.

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

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

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

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

typedef GenericValue *	ValueIterator
	Value iterator for iterating in array.

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

typedef GenericArray< false, ValueType >	Array

typedef GenericArray< true, ValueType >	ConstArray

typedef GenericObject< false, ValueType >	Object

typedef GenericObject< true, ValueType >	ConstObject

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

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

	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...

	GenericValue (bool b) RAPIDJSON_NOEXCEPT
	Constructor for boolean value. More...

	GenericValue (int i) RAPIDJSON_NOEXCEPT
	Constructor for int value.

	GenericValue (unsigned u) RAPIDJSON_NOEXCEPT
	Constructor for unsigned value.

	GenericValue (int64_t i64) RAPIDJSON_NOEXCEPT
	Constructor for int64_t value.

	GenericValue (uint64_t u64) RAPIDJSON_NOEXCEPT
	Constructor for uint64_t value.

	GenericValue (double d) RAPIDJSON_NOEXCEPT
	Constructor for double value.

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

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

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

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

	GenericValue (const std::basic_string< Ch > &s, Allocator &allocator)
	Constructor for copy-string from a string object (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...

Assignment operators
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 }

Data	data_

template<typename , typename , typename >
class	GenericDocument

static const SizeType	kDefaultArrayCapacity = 16

static const SizeType	kDefaultObjectCapacity = 16

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...

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

const RAPIDJSON_FORCEINLINE Ch *	GetStringPointer () const

const RAPIDJSON_FORCEINLINE 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.

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

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

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

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

Detailed Description

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>
class rapidjson::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.

Constructor & Destructor Documentation

◆ GenericValue() [1/6]

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

rapidjson::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() [2/6]

template<typename Encoding , typename Allocator >

template<typename SourceAllocator >

rapidjson::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() [3/6]

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

rapidjson::GenericValue< Encoding, Allocator >::GenericValue ( bool b )

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() [4/6]

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

rapidjson::GenericValue< Encoding, Allocator >::GenericValue	(	const std::basic_string< Ch > &	s,
		Allocator &	allocator
	)

inline

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

Note: Requires the definition of the preprocessor symbol RAPIDJSON_HAS_STDSTRING.

◆ GenericValue() [5/6]

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

rapidjson::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() [6/6]

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

rapidjson::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<>>

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

inline

Destructor.

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

Member Function Documentation

◆ operator=() [1/2]

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

GenericValue& rapidjson::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.

◆ operator=() [2/2]

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

GenericValue& rapidjson::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 >

rapidjson::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

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

include/rapidjson/document.h

Classes

Public Types

Public Attributes

Constructors and destructor.

Assignment operators

Detailed Description

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

Constructor & Destructor Documentation

◆ GenericValue() [1/6]

◆ GenericValue() [2/6]

◆ GenericValue() [3/6]

◆ GenericValue() [4/6]

◆ GenericValue() [5/6]

◆ GenericValue() [6/6]

◆ ~GenericValue()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ RAPIDJSON_DISABLEIF_RETURN()

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