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.

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()

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.

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.

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.

Destructor.

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

Generate events of this value to a Handler.

This function adopts the GoF visitor pattern. Typical usage is to output this JSON value as JSON text via Writer, which is a Handler. It can also be used to deep clone this value via GenericDocument, which is also a Handler.

Template Parameters

Handler

type of handler.

Parameters

handler

An object implementing concept Handler.

Add a member (name-value pair) to the object.

Parameters

name	A string value as name of member.
value	Value of any type.
allocator	Allocator for reallocating memory. It must be the same one as used before. Commonly use GenericDocument::GetAllocator().

Returns

The value itself for fluent API.

Note

The ownership of name and value will be transferred to this object on success.

Precondition

IsObject() && name.IsString()

Postcondition

name.IsNull() && value.IsNull()

Note

Amortized Constant time complexity.

Add a constant string value as member (name-value pair) to the object.

Parameters

name	A string value as name of member.
value	constant string reference as value of member.
allocator	Allocator for reallocating memory. It must be the same one as used before. Commonly use GenericDocument::GetAllocator().

Returns

The value itself for fluent API.

Precondition

IsObject()

Note

This overload is needed to avoid clashes with the generic primitive type AddMember(GenericValue&,T,Allocator&) overload below.

Amortized Constant time complexity.

Add any primitive value as member (name-value pair) to the object.

Template Parameters

T	Either Type, int, unsigned, int64_t, uint64_t

Parameters

name	A string value as name of member.
value	Value of primitive type T as value of member
allocator	Allocator for reallocating memory. Commonly use GenericDocument::GetAllocator().

Returns

The value itself for fluent API.

Precondition

IsObject()

Note

The source type T explicitly disallows all pointer types, especially (const) Ch*. This helps avoiding implicitly referencing character strings with insufficient lifetime, use AddMember(StringRefType, GenericValue&, Allocator&) or AddMember(StringRefType, StringRefType, Allocator&). All other pointer types would implicitly convert to bool, use an explicit cast instead, if needed.

Amortized Constant time complexity.

Add a member (name-value pair) to the object.

Parameters

name	A constant string reference as name of member.
value	Value of any type.
allocator	Allocator for reallocating memory. It must be the same one as used before. Commonly use GenericDocument::GetAllocator().

Returns

The value itself for fluent API.

Note

The ownership of value will be transferred to this object on success.

Precondition

IsObject()

Postcondition

value.IsNull()

Note

Amortized Constant time complexity.

Add a constant string value as member (name-value pair) to the object.

Parameters

name	A constant string reference as name of member.
value	constant string reference as value of member.
allocator	Allocator for reallocating memory. It must be the same one as used before. Commonly use GenericDocument::GetAllocator().

Returns

The value itself for fluent API.

Precondition

IsObject()

Note

This overload is needed to avoid clashes with the generic primitive type AddMember(StringRefType,T,Allocator&) overload below.

Amortized Constant time complexity.

Add any primitive value as member (name-value pair) to the object.

Template Parameters

T	Either Type, int, unsigned, int64_t, uint64_t

Parameters

name	A constant string reference as name of member.
value	Value of primitive type T as value of member
allocator	Allocator for reallocating memory. Commonly use GenericDocument::GetAllocator().

Returns

The value itself for fluent API.

Precondition

IsObject()

Note

The source type T explicitly disallows all pointer types, especially (const) Ch*. This helps avoiding implicitly referencing character strings with insufficient lifetime, use AddMember(StringRefType, GenericValue&, Allocator&) or AddMember(StringRefType, StringRefType, Allocator&). All other pointer types would implicitly convert to bool, use an explicit cast instead, if needed.

Amortized Constant time complexity.

Element iterator.

Precondition

IsArray() == true

Constant element iterator.

Precondition

IsArray() == true

Remove all elements in the array.

This function do not deallocate memory in the array, i.e. the capacity is unchanged.

Note

Linear time complexity.

Deep-copy assignment from Value.

Assigns a copy of the Value to the current Value object

Template Parameters

SourceAllocator

Allocator type of rhs

Parameters

rhs	Value to copy from (read-only)
allocator	Allocator to use for copying

Past-the-end element iterator

Precondition

IsArray() == true

Constant past-the-end element iterator.

Precondition

IsArray() == true

Remove elements in the range [first, last) of the array.

Parameters

first	iterator to the first element to remove
last	iterator following the last element to remove

Precondition

IsArray() == true && Begin() <= first <= last <= End()

Returns

Iterator following the last removed element.

Note

Linear time complexity.

Remove an element of array by iterator.

Parameters

pos	iterator to the element to remove

Precondition

IsArray() == true && Begin() <= pos < End()

Returns

Iterator following the removed element. If the iterator pos refers to the last element, the End() iterator is returned.

Note

Linear time complexity.

Erase a member in object by its name.

Parameters

name	Name of member to be removed.

Returns

Whether the member existed.

Note

Linear time complexity.

Remove members in the range [first, last) from an object.

Parameters

first	iterator to the first member to remove
last	iterator following the last member to remove

Precondition

IsObject() == true && MemberBegin() <= first <= last <= MemberEnd()

Returns

Iterator following the last removed element.

Note

This function preserves the relative order of the remaining object members.

Linear time complexity.

Remove a member from an object by iterator.

Parameters

pos	iterator to the member to remove

Precondition

IsObject() == true && MemberBegin() <= pos < MemberEnd()

Returns

Iterator following the removed element. If the iterator pos refers to the last element, the MemberEnd() iterator is returned.

Note

This function preserves the relative order of the remaining object members. If you do not need this, use the more efficient RemoveMember(MemberIterator).

Linear time complexity.

Find member by name.

Parameters

name	Member name to be searched.

Precondition

IsObject() == true

Returns

Iterator to member, if it exists. Otherwise returns MemberEnd().

Note

Earlier versions of Rapidjson returned a NULL pointer, in case the requested member doesn't exist. For consistency with e.g. std::map, this has been changed to MemberEnd() now.

Linear time complexity.

Find member by name.

This version is faster because it does not need a StrLen(). It can also handle string with null character.

Parameters

name	Member name to be searched.

Precondition

IsObject() == true

Returns

Iterator to member, if it exists. Otherwise returns MemberEnd().

Note

Earlier versions of Rapidjson returned a NULL pointer, in case the requested member doesn't exist. For consistency with e.g. std::map, this has been changed to MemberEnd() now.

Linear time complexity.

Get the value as double type.

Note

If the value is 64-bit integer type, it may lose precision. Use IsLosslessDouble() to check whether the converison is lossless.

Get the value as float type.

Note

If the value is 64-bit integer type, it may lose precision. Use IsLosslessFloat() to check whether the converison is lossless.

Get the length of string.

Since rapidjson permits "\\u0000" in the json string, strlen(v.GetString()) may not equal to v.GetStringLength().

Check whether a member exists in the object.

Parameters

name	Member name to be searched.

Precondition

IsObject() == true

Returns

Whether a member with that name exists.

Note

It is better to use FindMember() directly if you need the obtain the value as well.

Linear time complexity.

Check whether a member exists in the object with GenericValue name.

This version is faster because it does not need a StrLen(). It can also handle string with null character.

Parameters

name	Member name to be searched.

Precondition

IsObject() == true

Returns

Whether a member with that name exists.

Note

It is better to use FindMember() directly if you need the obtain the value as well.

Linear time complexity.

Templated version for checking whether this value is type T.

Template Parameters

T	Either bool, int, unsigned, int64_t, uint64_t, double, float, const char*, std::basic_string<Ch>

Member iterator.

Precondition

IsObject() == true

Const member iterator.

Precondition

IsObject() == true

Past-the-end member iterator

Precondition

IsObject() == true

Const past-the-end member iterator.

Precondition

IsObject() == true

Prepare Value for move semantics.

Returns

*this

Not-equal-to operator.

Returns

!(*this == rhs)

Not-equal-to operator with arbitrary types.

Returns

!(*this == rhs)

Assignment with move semantics.

Parameters

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

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)

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.

Equal-to operator.

Note

If an object contains duplicated named member, comparing equality with any object is always false.

Linear time complexity (number of all values in the subtree and total lengths of all strings).

Equal-to operator with primitive types.

Template Parameters

T	Either Type, int, unsigned, int64_t, uint64_t, double, true, false

Get a value from an object associated with the name.

Precondition

IsObject() == true

Template Parameters

SourceAllocator

Allocator of the name value

Note

Compared to operator[](T*), this version is faster because it does not need a StrLen(). And it can also handle strings with embedded null characters.

Linear time complexity.

Get an element from array by index.

Precondition

IsArray() == true

Parameters

index

Zero-based index of element.

See also

operator[](T*)

Get a value from an object associated with the name.

Precondition

IsObject() == true

Template Parameters

T	Either Ch or const Ch (template used for disambiguation with operator[](SizeType))

Note

In version 0.1x, if the member is not found, this function returns a null value. This makes issue 7. Since 0.2, if the name is not correct, it will assert. If user is unsure whether a member exists, user should use HasMember() first. A better approach is to use FindMember().

Linear time complexity.

Remove the last element in the array.

Note

Constant time complexity.

Append a GenericValue at the end of the array.

Parameters

value	Value to be appended.
allocator	Allocator for reallocating memory. It must be the same one as used before. Commonly use GenericDocument::GetAllocator().

Precondition

IsArray() == true

Postcondition

value.IsNull() == true

Returns

The value itself for fluent API.

Note

The ownership of value will be transferred to this array on success.

If the number of elements to be appended is known, calls Reserve() once first may be more efficient.

Amortized constant time complexity.

Append a constant string reference at the end of the array.

Parameters

value	Constant string reference to be appended.
allocator	Allocator for reallocating memory. It must be the same one used previously. Commonly use GenericDocument::GetAllocator().

Precondition

IsArray() == true

Returns

The value itself for fluent API.

Note

If the number of elements to be appended is known, calls Reserve() once first may be more efficient.

Amortized constant time complexity.

See also

GenericStringRef

Append a primitive value at the end of the array.

Template Parameters

T	Either Type, int, unsigned, int64_t, uint64_t

Parameters

value	Value of primitive type T to be appended.
allocator	Allocator for reallocating memory. It must be the same one as used before. Commonly use GenericDocument::GetAllocator().

Precondition

IsArray() == true

Returns

The value itself for fluent API.

Note

If the number of elements to be appended is known, calls Reserve() once first may be more efficient.

The source type T explicitly disallows all pointer types, especially (const) Ch*. This helps avoiding implicitly referencing character strings with insufficient lifetime, use PushBack(GenericValue&, Allocator&) or PushBack(StringRefType, Allocator&). All other pointer types would implicitly convert to bool, use an explicit cast instead, if needed.

Amortized constant time complexity.

Remove all members in the object.

This function do not deallocate memory in the object, i.e. the capacity is unchanged.

Note

Linear time complexity.

Remove a member in object by its name.

Parameters

name	Name of member to be removed.

Returns

Whether the member existed.

Note

This function may reorder the object members. Use EraseMember(ConstMemberIterator) if you need to preserve the relative order of the remaining members.

Linear time complexity.

Remove a member in object by iterator.

Parameters

m	member iterator (obtained by FindMember() or MemberBegin()).

Returns

the new iterator after removal.

Note

This function may reorder the object members. Use EraseMember(ConstMemberIterator) if you need to preserve the relative order of the remaining members.

Constant time complexity.

Request the array to have enough capacity to store elements.

Parameters

newCapacity	The capacity that the array at least need to have.
allocator	Allocator for reallocating memory. It must be the same one as used before. Commonly use GenericDocument::GetAllocator().

Returns

The value itself for fluent API.

Note

Linear time complexity.

Set this value as an empty array.

Postcondition

IsArray == true

Postcondition

IsBool() == true

Set this value as an empty object.

Postcondition

IsObject() == true

Set this value as a string by copying from source string.

Parameters

s	source string.
allocator	Allocator for allocating copied buffer. Commonly use GenericDocument::GetAllocator().

Returns

The value itself for fluent API.

Postcondition

IsString() == true && GetString() != s && strcmp(GetString(),s) == 0 && GetStringLength() == length

Set this value as a string without copying source string.

This version has better performance with supplied length, and also support string containing null character.

Parameters

s	source string pointer.
length	The length of source string, excluding the trailing null terminator.

Returns

The value itself for fluent API.

Postcondition

IsString() == true && GetString() == s && GetStringLength() == length

See also

SetString(StringRefType)

Set this value as a string by copying from source string.

This version has better performance with supplied length, and also support string containing null character.

Parameters

s	source string.
length	The length of source string, excluding the trailing null terminator.
allocator	Allocator for allocating copied buffer. Commonly use GenericDocument::GetAllocator().

Returns

The value itself for fluent API.

Postcondition

IsString() == true && GetString() != s && strcmp(GetString(),s) == 0 && GetStringLength() == length

Set this value as a string without copying source string.

Parameters

s	source string reference

Returns

The value itself for fluent API.

Postcondition

IsString() == true && GetString() == s && GetStringLength() == s.length

Exchange the contents of this value with those of other.

Parameters

other

Another value.

Note

Constant complexity.

Not-Equal-to operator with arbitrary types (symmetric version).

Returns

!(rhs == lhs)

Equal-to operator with arbitrary types (symmetric version).

Returns

(rhs == lhs)

free-standing swap function helper

Helper function to enable support for common swap implementation pattern based on std::swap:

See also

Swap()