Constructor that parses a string or URI fragment representation.

Parameters

source	A null-terminated, string or URI fragment representation of JSON pointer.
allocator	User supplied allocator for this pointer. If no allocator is provided, it creates a self-owned one.

Constructor that parses a string or URI fragment representation, with length of the source string.

Parameters

source	A string or URI fragment representation of JSON pointer.
length	Length of source.
allocator	User supplied allocator for this pointer. If no allocator is provided, it creates a self-owned one.

Note

Slightly faster than the overload without length.

Constructor with user-supplied tokens.

This constructor let user supplies const array of tokens. This prevents the parsing process and eliminates allocation. This is preferred for memory constrained environments.

Parameters

tokens	An constant array of tokens representing the JSON pointer.
tokenCount	Number of tokens.

Example

Append a name token with length, and return a new Pointer.

Parameters

name	Name to be appended.
length	Length of name.
allocator	Allocator for the newly return Pointer.

Returns

A new Pointer with appended token.

Append a token and return a new Pointer.

Parameters

token	Token to be appended.
allocator	Allocator for the newly return Pointer.

Returns

A new Pointer with appended token.

Append a token by value, and return a new Pointer.

Parameters

token	token to be appended.
allocator	Allocator for the newly return Pointer.

Returns

A new Pointer with appended token.

Append a index token, and return a new Pointer.

Parameters

index	Index to be appended.
allocator	Allocator for the newly return Pointer.

Returns

A new Pointer with appended token.

Append a name token without length, and return a new Pointer.

Parameters

name	Name (const Ch*) to be appended.
allocator	Allocator for the newly return Pointer.

Returns

A new Pointer with appended token.

Creates a value in a document.

Parameters

document	A document to be resolved.
alreadyExist	If non-null, it stores whether the resolved value is already exist.

Returns

The resolved newly created, or already exists value.

Create a value in a subtree.

If the value is not exist, it creates all parent values and a JSON Null value. So it always succeed and return the newly created or existing value.

Remind that it may change types of parents according to tokens, so it potentially removes previously stored values. For example, if a document was an array, and "/foo" is used to create a value, then the document will be changed to an object, and all existing array elements are lost.

Parameters

root	Root value of a DOM subtree to be resolved. It can be any value other than document root.
allocator	Allocator for creating the values if the specified value or its parents are not exist.
alreadyExist	If non-null, it stores whether the resolved value is already exist.

Returns

The resolved newly created (a JSON Null value), or already exists value.

Erase a value in a subtree.

Parameters

root	Root value of a DOM sub-tree to be resolved. It can be any value other than document root.

Returns

Whether the resolved value is found and erased.

Note

Erasing with an empty pointer Pointer(""), i.e. the root, always fail and return false.

Query a const value in a const subtree.

Parameters

root	Root value of a DOM sub-tree to be resolved. It can be any value other than document root.

Returns

Pointer to the value if it can be resolved. Otherwise null.

Query a value in a subtree.

Parameters

root	Root value of a DOM sub-tree to be resolved. It can be any value other than document root.
unresolvedTokenIndex	If the pointer cannot resolve a token in the pointer, this parameter can obtain the index of unresolved token.

Returns

Pointer to the value if it can be resolved. Otherwise null.

Note

There are only 3 situations when a value cannot be resolved:

1. A value in the path is not an array nor object.
2. An object value does not contain the token.
3. A token is out of range of an array value.

Use unresolvedTokenIndex to retrieve the token index.

Query a value in a document with default primitive value.

Template Parameters

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

Query a value in a subtree with default value.

Similar to Get(), but if the specified value do not exists, it creates all parents and clone the default value. So that this function always succeed.

Parameters

root	Root value of a DOM sub-tree to be resolved. It can be any value other than document root.
defaultValue	Default value to be cloned if the value was not exists.
allocator	Allocator for creating the values if the specified value or its parents are not exist.

See also

Create()

Query a value in a subtree with default primitive value.

Template Parameters

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

Inequality operator.

Note

When any pointers are invalid, always returns true.

Equality operator.

Note

When any pointers are invalid, always returns false.

Set a primitive value in a document.

Template Parameters

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

Set a primitive value in a subtree.

Template Parameters

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

Set a value in a subtree, with move semantics.

It creates all parents if they are not exist or types are different to the tokens. So this function always succeeds but potentially remove existing values.

Parameters

root	Root value of a DOM sub-tree to be resolved. It can be any value other than document root.
value	Value to be set.
allocator	Allocator for creating the values if the specified value or its parents are not exist.

See also

Create()

Stringify the pointer into string representation.

Template Parameters

OutputStream

Type of output stream.

Parameters

os	The output stream.

Stringify the pointer into URI fragment representation.

Template Parameters

OutputStream

Type of output stream.

Parameters

os	The output stream.

Swap a value with a value in a subtree.

It creates all parents if they are not exist or types are different to the tokens. So this function always succeeds but potentially remove existing values.

Parameters

root	Root value of a DOM sub-tree to be resolved. It can be any value other than document root.
value	Value to be swapped.
allocator	Allocator for creating the values if the specified value or its parents are not exist.

See also

Create()