JSON Pointer. More...

#include "json.h"

Collaboration diagram for nlohmann::json_pointer< BasicJsonType >:

Public Member Functions
	json_pointer (const std::string &s="")
	create JSON pointer More...

const std::string &	back () const
	return last reference token More...

bool	empty () const noexcept
	return whether pointer points to the root document More...

	operator std::string () const
	return a string representation of the JSON pointer More...

json_pointer &	operator/= (const json_pointer &ptr)
	append another JSON pointer at the end of this JSON pointer More...

json_pointer &	operator/= (std::size_t array_idx)
	append an array index at the end of this JSON pointer More...

json_pointer &	operator/= (std::string token)
	append an unescaped reference token at the end of this JSON pointer More...

json_pointer	parent_pointer () const
	returns the parent of this JSON pointer More...

void	pop_back ()
	remove last reference token More...

void	push_back (const std::string &token)
	append an unescaped token at the end of the reference pointer More...

void	push_back (std::string &&token)
	append an unescaped token at the end of the reference pointer More...

std::string	to_string () const
	return a string representation of the JSON pointer More...

Private Member Functions
bool	contains (const BasicJsonType *ptr) const

BasicJsonType &	get_and_create (BasicJsonType &j) const
	create and return a reference to the pointed to value More...

BasicJsonType &	get_checked (BasicJsonType *ptr) const

const BasicJsonType &	get_checked (const BasicJsonType *ptr) const

BasicJsonType &	get_unchecked (BasicJsonType *ptr) const
	return a reference to the pointed to value More...

const BasicJsonType &	get_unchecked (const BasicJsonType *ptr) const
	return a const reference to the pointed to value More...

JSON_PRIVATE_UNLESS_TESTED	replace_substring (s, "/", "~1")

Static Private Member Functions
static BasicJsonType::size_type	array_index (const std::string &s)

static void	flatten (const std::string &reference_string, const BasicJsonType &value, BasicJsonType &result)

static void	replace_substring (std::string &s, const std::string &f, const std::string &t)
	replace all occurrences of a substring by another string More...

static std::vector< std::string >	split (const std::string &reference_string)
	split the string input to reference tokens More...

static void	unescape (std::string &s)
	unescape "~1" to tilde and "~0" to slash (order is important!) More...

static BasicJsonType	unflatten (const BasicJsonType &value)

Private Attributes
JSON_PRIVATE_UNLESS_TESTED	__pad0__: json_pointer top() const { if (JSON_HEDLEY_UNLIKELY(empty())) { JSON_THROW(detail::out_of_range::create(405

JSON_PRIVATE_UNLESS_TESTED	__pad1__: static std::string escape(std::string s) { replace_substring(s

JSON_PRIVATE_UNLESS_TESTED JSON pointer has no	parent

result	reference_tokens = {reference_tokens[0]}

std::vector< std::string >	reference_tokens
	the reference tokens More...

json_pointer	result = *this

return	result

return	s

Friends
class	basic_json

bool	operator!= (json_pointer const &lhs, json_pointer const &rhs) noexcept
	compares two JSON pointers for inequality More...

json_pointer	operator/ (const json_pointer &lhs, const json_pointer &rhs)
	create a new JSON pointer by appending the right JSON pointer at the end of the left JSON pointer More...

json_pointer	operator/ (const json_pointer &ptr, std::size_t array_idx)
	create a new JSON pointer by appending the array-index-token at the end of the JSON pointer More...

json_pointer	operator/ (const json_pointer &ptr, std::string token)
	create a new JSON pointer by appending the unescaped token at the end of the JSON pointer More...

bool	operator== (json_pointer const &lhs, json_pointer const &rhs) noexcept
	compares two JSON pointers for equality More...

Detailed Description

template<typename BasicJsonType>
class nlohmann::json_pointer< BasicJsonType >

JSON Pointer.

A JSON pointer defines a string syntax for identifying a specific value within a JSON document. It can be used with functions at and operator[]. Furthermore, JSON pointers are the base for JSON patches.

See also: RFC 6901

Since: version 2.0.0

Definition at line 11624 of file json.h.

Constructor & Destructor Documentation

◆ json_pointer()

template<typename BasicJsonType >

nlohmann::json_pointer< BasicJsonType >::json_pointer ( const std::string & s = "" )

inlineexplicit

create JSON pointer

Create a JSON pointer according to the syntax described in Section 3 of RFC6901.

Parameters

[in] s string representing the JSON pointer; if omitted, the empty string is assumed which references the whole JSON value

Exceptions

parse_error.107	if the given JSON pointer s is nonempty and does not begin with a slash (`/`); see example below
parse_error.108	if a tilde (`~`) in the given JSON pointer s is not followed by `0` (representing `~`) or `1` (representing `/`); see example below

@liveexample{The example shows the construction several valid JSON pointers as well as the exceptional behavior.,json_pointer}

Since: version 2.0.0

Definition at line 11652 of file json.h.

Referenced by nlohmann::json_pointer< BasicJsonType >::unflatten().

Here is the caller graph for this function:

Member Function Documentation

◆ array_index()

template<typename BasicJsonType >

static BasicJsonType::size_type nlohmann::json_pointer< BasicJsonType >::array_index ( const std::string & s )

inlinestaticprivate

Parameters

[in] s reference token to be converted into an array index

Returns: integer representation of s

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index begins not with a digit
out_of_range.404	if string s could not be converted to an integer
out_of_range.410	if an array index exceeds size_type

Definition at line 11939 of file json.h.

References nlohmann::detail::parse_error::create(), nlohmann::detail::out_of_range::create(), JSON_CATCH, JSON_HEDLEY_UNLIKELY, JSON_THROW, JSON_TRY, max, and nlohmann::json_pointer< BasicJsonType >::s.

Referenced by nlohmann::json_pointer< BasicJsonType >::contains(), nlohmann::json_pointer< BasicJsonType >::get_and_create(), nlohmann::json_pointer< BasicJsonType >::get_checked(), and nlohmann::json_pointer< BasicJsonType >::get_unchecked().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ back()

template<typename BasicJsonType >

const std::string& nlohmann::json_pointer< BasicJsonType >::back ( ) const

inline

return last reference token

Precondition: not empty()

Returns: last reference token

@liveexample{The example shows the usage of back.,json_pointer__back}

@complexity Constant.

Exceptions

out_of_range.405 if JSON pointer has no parent

Since: version 3.6.0

Definition at line 11876 of file json.h.

References nlohmann::detail::out_of_range::create(), nlohmann::json_pointer< BasicJsonType >::empty(), JSON_HEDLEY_UNLIKELY, JSON_THROW, and nlohmann::json_pointer< BasicJsonType >::reference_tokens.

Here is the call graph for this function:

◆ contains()

template<typename BasicJsonType >

bool nlohmann::json_pointer< BasicJsonType >::contains ( const BasicJsonType * ptr ) const

inlineprivate

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index was not a number

Definition at line 12268 of file json.h.

References nlohmann::detail::array, nlohmann::json_pointer< BasicJsonType >::array_index(), JSON_HEDLEY_UNLIKELY, nlohmann::detail::object, and nlohmann::json_pointer< BasicJsonType >::reference_tokens.

Referenced by nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::contains().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ empty()

template<typename BasicJsonType >

bool nlohmann::json_pointer< BasicJsonType >::empty ( ) const

inlinenoexcept

return whether pointer points to the root document

Returns: true iff the JSON pointer points to the root document

@complexity Constant.

@exceptionsafety No-throw guarantee: this function never throws exceptions.

@liveexample{The example shows the result of empty for different JSON Pointers.,json_pointer__empty}

Since: version 3.6.0

Definition at line 11923 of file json.h.

References nlohmann::json_pointer< BasicJsonType >::reference_tokens.

Referenced by nlohmann::json_pointer< BasicJsonType >::back(), nlohmann::json_pointer< BasicJsonType >::parent_pointer(), and nlohmann::json_pointer< BasicJsonType >::pop_back().

Here is the caller graph for this function:

◆ flatten()

template<typename BasicJsonType >

static void nlohmann::json_pointer< BasicJsonType >::flatten	(	const std::string &	reference_string,
		const BasicJsonType &	value,
		BasicJsonType &	result
	)

inlinestaticprivate

Parameters

[in]	reference_string	the reference string to the current value
[in]	value	the value to consider
[in,out]	result	the result object to insert values to

Note: Empty objects or arrays are flattened to null.

Definition at line 12458 of file json.h.

References nlohmann::detail::array, nlohmann::detail::object, nlohmann::json_pointer< BasicJsonType >::result, and nlohmann::to_string().

Referenced by nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::flatten().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_and_create()

template<typename BasicJsonType >

BasicJsonType& nlohmann::json_pointer< BasicJsonType >::get_and_create ( BasicJsonType & j ) const

inlineprivate

create and return a reference to the pointed to value

@complexity Linear in the number of reference tokens.

Exceptions

parse_error.109	if array index is not a number
type_error.313	if value cannot be unflattened

Definition at line 12006 of file json.h.

References nlohmann::detail::array, nlohmann::json_pointer< BasicJsonType >::array_index(), nlohmann::detail::type_error::create(), JSON_THROW, nlohmann::detail::null, nlohmann::detail::object, nlohmann::json_pointer< BasicJsonType >::reference_tokens, and nlohmann::json_pointer< BasicJsonType >::result.

Here is the call graph for this function:

◆ get_checked() [1/2]

template<typename BasicJsonType >

BasicJsonType& nlohmann::json_pointer< BasicJsonType >::get_checked ( BasicJsonType * ptr ) const

inlineprivate

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index was not a number
out_of_range.402	if the array index '-' is used
out_of_range.404	if the JSON pointer can not be resolved

Definition at line 12137 of file json.h.

References nlohmann::detail::array, nlohmann::json_pointer< BasicJsonType >::array_index(), nlohmann::detail::out_of_range::create(), JSON_HEDLEY_UNLIKELY, JSON_THROW, nlohmann::detail::object, nlohmann::json_pointer< BasicJsonType >::reference_tokens, and nlohmann::to_string().

Referenced by nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::at(), and nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::value().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_checked() [2/2]

template<typename BasicJsonType >

const BasicJsonType& nlohmann::json_pointer< BasicJsonType >::get_checked ( const BasicJsonType * ptr ) const

inlineprivate

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index was not a number
out_of_range.402	if the array index '-' is used
out_of_range.404	if the JSON pointer can not be resolved

Definition at line 12228 of file json.h.

References nlohmann::detail::array, nlohmann::json_pointer< BasicJsonType >::array_index(), nlohmann::detail::out_of_range::create(), JSON_HEDLEY_UNLIKELY, JSON_THROW, nlohmann::detail::object, nlohmann::json_pointer< BasicJsonType >::reference_tokens, and nlohmann::to_string().

Here is the call graph for this function:

◆ get_unchecked() [1/2]

template<typename BasicJsonType >

BasicJsonType& nlohmann::json_pointer< BasicJsonType >::get_unchecked ( BasicJsonType * ptr ) const

inlineprivate

return a reference to the pointed to value

Note: This version does not throw if a value is not present, but tries to create nested values instead. For instance, calling this function with pointer "/this/that" on a null value is equivalent to calling operator[]("this").operator[]("that") on that value, effectively changing the null value to an object.

Parameters

[in] ptr a JSON value

Returns: reference to the JSON value pointed to by the JSON pointer

@complexity Linear in the length of the JSON pointer.

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index was not a number
out_of_range.404	if the JSON pointer can not be resolved

Definition at line 12078 of file json.h.

References nlohmann::detail::array, nlohmann::json_pointer< BasicJsonType >::array_index(), nlohmann::detail::out_of_range::create(), JSON_THROW, nlohmann::detail::object, nlohmann::json_pointer< BasicJsonType >::reference_tokens, and sample-rng-plot::x.

Referenced by nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::operator[]().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_unchecked() [2/2]

template<typename BasicJsonType >

const BasicJsonType& nlohmann::json_pointer< BasicJsonType >::get_unchecked ( const BasicJsonType * ptr ) const

inlineprivate

return a const reference to the pointed to value

Parameters

[in] ptr a JSON value

Returns: const reference to the JSON value pointed to by the JSON pointer

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index was not a number
out_of_range.402	if the array index '-' is used
out_of_range.404	if the JSON pointer can not be resolved

Definition at line 12186 of file json.h.

References nlohmann::detail::array, nlohmann::json_pointer< BasicJsonType >::array_index(), nlohmann::detail::out_of_range::create(), JSON_HEDLEY_UNLIKELY, JSON_THROW, nlohmann::detail::object, nlohmann::json_pointer< BasicJsonType >::reference_tokens, and nlohmann::to_string().

Here is the call graph for this function:

◆ operator std::string()

template<typename BasicJsonType >

nlohmann::json_pointer< BasicJsonType >::operator std::string ( ) const

inline

return a string representation of the JSON pointer

Invariant: For each JSON pointer ptr, it holds:
ptr == json_pointer(ptr.to_string());

nlohmann::json_pointer::json_pointer
json_pointer(const std::string &s="")
create JSON pointer
Definition: json.h:11652

Returns: a string representation of the JSON pointer

@liveexample{The example shows the result of to_string.,json_pointer__to_string}

Since: version 2.0.0

Definition at line 11681 of file json.h.

References nlohmann::json_pointer< BasicJsonType >::to_string().

Here is the call graph for this function:

◆ operator/=() [1/3]

template<typename BasicJsonType >

json_pointer& nlohmann::json_pointer< BasicJsonType >::operator/= ( const json_pointer< BasicJsonType > & ptr )

inline

append another JSON pointer at the end of this JSON pointer

Parameters

[in] ptr JSON pointer to append

Returns: JSON pointer with ptr appended

@liveexample{The example shows the usage of operator/=.,json_pointer__operator_add}

@complexity Linear in the length of ptr.

See also: operator/=(std::string) to append a reference token; operator/=(std::size_t) to append an array index; operator/(const json_pointer&, const json_pointer&) for a binary operator

Since: version 3.6.0

Definition at line 11702 of file json.h.

References nlohmann::json_pointer< BasicJsonType >::reference_tokens.

◆ operator/=() [2/3]

template<typename BasicJsonType >

json_pointer& nlohmann::json_pointer< BasicJsonType >::operator/= ( std::size_t array_idx )

inline

append an array index at the end of this JSON pointer

Parameters

[in] array_idx array index to append

Returns: JSON pointer with array_idx appended

@liveexample{The example shows the usage of operator/=.,json_pointer__operator_add}

@complexity Amortized constant.

See also: operator/=(const json_pointer&) to append a JSON pointer; operator/=(std::string) to append a reference token; operator/(const json_pointer&, std::string) for a binary operator

Since: version 3.6.0

Definition at line 11748 of file json.h.

References nlohmann::to_string().

Here is the call graph for this function:

◆ operator/=() [3/3]

template<typename BasicJsonType >

json_pointer& nlohmann::json_pointer< BasicJsonType >::operator/= ( std::string token )

inline

append an unescaped reference token at the end of this JSON pointer

Parameters

[in] token reference token to append

Returns: JSON pointer with token appended without escaping token

@liveexample{The example shows the usage of operator/=.,json_pointer__operator_add}

@complexity Amortized constant.

See also: operator/=(const json_pointer&) to append a JSON pointer; operator/=(std::size_t) to append an array index; operator/(const json_pointer&, std::size_t) for a binary operator

Since: version 3.6.0

Definition at line 11726 of file json.h.

References nlohmann::json_pointer< BasicJsonType >::push_back().

Here is the call graph for this function:

◆ parent_pointer()

template<typename BasicJsonType >

json_pointer nlohmann::json_pointer< BasicJsonType >::parent_pointer ( ) const

inline

returns the parent of this JSON pointer

Returns: parent of this JSON pointer; in case this JSON pointer is the root, the root itself is returned

@complexity Linear in the length of the JSON pointer.

@liveexample{The example shows the result of parent_pointer for different JSON Pointers.,json_pointer__parent_pointer}

Since: version 3.6.0

Definition at line 11827 of file json.h.

References nlohmann::json_pointer< BasicJsonType >::empty(), and nlohmann::json_pointer< BasicJsonType >::pop_back().

Here is the call graph for this function:

◆ pop_back()

template<typename BasicJsonType >

void nlohmann::json_pointer< BasicJsonType >::pop_back ( )

inline

remove last reference token

Precondition: not empty()

@liveexample{The example shows the usage of pop_back.,json_pointer__pop_back}

@complexity Constant.

Exceptions

out_of_range.405 if JSON pointer has no parent

Since: version 3.6.0

Definition at line 11852 of file json.h.

References nlohmann::detail::out_of_range::create(), nlohmann::json_pointer< BasicJsonType >::empty(), JSON_HEDLEY_UNLIKELY, JSON_THROW, and nlohmann::json_pointer< BasicJsonType >::reference_tokens.

Referenced by nlohmann::json_pointer< BasicJsonType >::parent_pointer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ push_back() [1/2]

template<typename BasicJsonType >

void nlohmann::json_pointer< BasicJsonType >::push_back ( const std::string & token )

inline

append an unescaped token at the end of the reference pointer

Parameters

[in] token token to add

@complexity Amortized constant.

@liveexample{The example shows the result of push_back for different JSON Pointers.,json_pointer__push_back}

Since: version 3.6.0

Definition at line 11898 of file json.h.

References nlohmann::json_pointer< BasicJsonType >::reference_tokens.

Referenced by nlohmann::json_pointer< BasicJsonType >::operator/=(), and nlohmann::json_pointer< BasicJsonType >::split().

Here is the caller graph for this function:

◆ push_back() [2/2]

template<typename BasicJsonType >

void nlohmann::json_pointer< BasicJsonType >::push_back ( std::string && token )

inline

append an unescaped token at the end of the reference pointer

Parameters

[in] token token to add

@complexity Amortized constant.

@liveexample{The example shows the result of push_back for different JSON Pointers.,json_pointer__push_back}

Since: version 3.6.0

Definition at line 11904 of file json.h.

References nlohmann::json_pointer< BasicJsonType >::reference_tokens.

◆ replace_substring() [1/2]

template<typename BasicJsonType >

JSON_PRIVATE_UNLESS_TESTED nlohmann::json_pointer< BasicJsonType >::replace_substring	(	s	,
		"/"	,
		"~1"
	)

private

◆ replace_substring() [2/2]

template<typename BasicJsonType >

static void nlohmann::json_pointer< BasicJsonType >::replace_substring	(	std::string &	s,
		const std::string &	f,
		const std::string &	t
	)

inlinestaticprivate

replace all occurrences of a substring by another string

Parameters

[in,out]	s	the string to manipulate; changed so that all occurrences of f are replaced with t
[in]	f	the substring to replace with t
[in]	t	the string to replace f

Precondition: The search string f must not be empty. This precondition is enforced with an assertion.

Since: version 2.0.0

Definition at line 12423 of file json.h.

References f(), JSON_ASSERT, and nlohmann::json_pointer< BasicJsonType >::s.

Referenced by nlohmann::json_pointer< BasicJsonType >::unescape().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ split()

template<typename BasicJsonType >

static std::vector<std::string> nlohmann::json_pointer< BasicJsonType >::split ( const std::string & reference_string )

inlinestaticprivate

split the string input to reference tokens

Note: This function is only called by the json_pointer constructor. All exceptions below are documented there.

Exceptions

parse_error.107	if the pointer is not empty or begins with '/'
parse_error.108	if character '~' is not followed by '0' or '1'

Definition at line 12348 of file json.h.

References nlohmann::detail::parse_error::create(), JSON_ASSERT, JSON_HEDLEY_UNLIKELY, JSON_THROW, nlohmann::json_pointer< BasicJsonType >::push_back(), nlohmann::json_pointer< BasicJsonType >::result, visualizer.core::start(), and nlohmann::json_pointer< BasicJsonType >::unescape().

Here is the call graph for this function:

◆ to_string()

template<typename BasicJsonType >

std::string nlohmann::json_pointer< BasicJsonType >::to_string ( ) const

inline

return a string representation of the JSON pointer

Invariant: For each JSON pointer ptr, it holds:
ptr == json_pointer(ptr.to_string());

Returns: a string representation of the JSON pointer

@liveexample{The example shows the result of to_string.,json_pointer__to_string}

Since: version 2.0.0

Definition at line 11670 of file json.h.

References nlohmann::json_pointer< BasicJsonType >::reference_tokens.

Referenced by nlohmann::json_pointer< BasicJsonType >::operator std::string().

Here is the caller graph for this function:

◆ unescape()

template<typename BasicJsonType >

static void nlohmann::json_pointer< BasicJsonType >::unescape ( std::string & s )

inlinestaticprivate

unescape "~1" to tilde and "~0" to slash (order is important!)

Definition at line 12444 of file json.h.

References nlohmann::json_pointer< BasicJsonType >::replace_substring(), and nlohmann::json_pointer< BasicJsonType >::s.

Referenced by nlohmann::json_pointer< BasicJsonType >::split().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unflatten()

template<typename BasicJsonType >

static BasicJsonType nlohmann::json_pointer< BasicJsonType >::unflatten ( const BasicJsonType & value )

inlinestaticprivate

Parameters

[in] value flattened JSON

Returns: unflattened JSON

Exceptions

parse_error.109	if array index is not a number
type_error.314	if value is not an object
type_error.315	if object values are not primitive
type_error.313	if value cannot be unflattened

Definition at line 12521 of file json.h.

References nlohmann::json_pointer< BasicJsonType >::json_pointer(), nlohmann::detail::type_error::create(), JSON_HEDLEY_UNLIKELY, JSON_THROW, and nlohmann::json_pointer< BasicJsonType >::result.

Referenced by nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::unflatten().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ basic_json

template<typename BasicJsonType >

friend class basic_json

friend

Definition at line 11628 of file json.h.

◆ operator!=

template<typename BasicJsonType >

bool operator!=	(	json_pointer< BasicJsonType > const &	lhs,
		json_pointer< BasicJsonType > const &	rhs
	)

friend

compares two JSON pointers for inequality

Parameters

[in]	lhs	JSON pointer to compare
[in]	rhs	JSON pointer to compare

Returns: whether lhs is not equal rhs

@complexity Linear in the length of the JSON pointer

@exceptionsafety No-throw guarantee: this function never throws exceptions.

Definition at line 12576 of file json.h.

◆ operator/ [1/3]

template<typename BasicJsonType >

json_pointer operator/	(	const json_pointer< BasicJsonType > &	lhs,
		const json_pointer< BasicJsonType > &	rhs
	)

friend

create a new JSON pointer by appending the right JSON pointer at the end of the left JSON pointer

Parameters

[in]	lhs	JSON pointer
[in]	rhs	JSON pointer

Returns: a new JSON pointer with rhs appended to lhs

@liveexample{The example shows the usage of operator/.,json_pointer__operator_add_binary}

@complexity Linear in the length of lhs and rhs.

See also: operator/=(const json_pointer&) to append a JSON pointer

Since: version 3.6.0

Definition at line 11768 of file json.h.

◆ operator/ [2/3]

template<typename BasicJsonType >

json_pointer operator/	(	const json_pointer< BasicJsonType > &	ptr,
		std::size_t	array_idx
	)

friend

create a new JSON pointer by appending the array-index-token at the end of the JSON pointer

Parameters

[in]	ptr	JSON pointer
[in]	array_idx	array index

Returns: a new JSON pointer with array_idx appended to ptr

@liveexample{The example shows the usage of operator/.,json_pointer__operator_add_binary}

@complexity Linear in the length of ptr.

See also: operator/=(std::size_t) to append an array index

Since: version 3.6.0

Definition at line 11809 of file json.h.

◆ operator/ [3/3]

template<typename BasicJsonType >

json_pointer operator/	(	const json_pointer< BasicJsonType > &	ptr,
		std::string	token
	)

friend

create a new JSON pointer by appending the unescaped token at the end of the JSON pointer

Parameters

[in]	ptr	JSON pointer
[in]	token	reference token

Returns: a new JSON pointer with unescaped token appended to ptr

@liveexample{The example shows the usage of operator/.,json_pointer__operator_add_binary}

@complexity Linear in the length of ptr.

See also: operator/=(std::string) to append a reference token

Since: version 3.6.0

Definition at line 11789 of file json.h.

◆ operator==

template<typename BasicJsonType >

bool operator==	(	json_pointer< BasicJsonType > const &	lhs,
		json_pointer< BasicJsonType > const &	rhs
	)

friend

compares two JSON pointers for equality

Parameters

[in]	lhs	JSON pointer to compare
[in]	rhs	JSON pointer to compare

Returns: whether lhs is equal to rhs

@complexity Linear in the length of the JSON pointer

@exceptionsafety No-throw guarantee: this function never throws exceptions.

Definition at line 12559 of file json.h.

Member Data Documentation

◆ pad0

template<typename BasicJsonType >

JSON_PRIVATE_UNLESS_TESTED nlohmann::json_pointer< BasicJsonType >::__pad0__

private

Definition at line 11984 of file json.h.

◆ pad1

template<typename BasicJsonType >

JSON_PRIVATE_UNLESS_TESTED nlohmann::json_pointer< BasicJsonType >::__pad1__

private

Definition at line 12434 of file json.h.

◆ parent

template<typename BasicJsonType >

JSON_PRIVATE_UNLESS_TESTED JSON pointer has no nlohmann::json_pointer< BasicJsonType >::parent

private

Definition at line 11989 of file json.h.

◆ reference_tokens [1/2]

template<typename BasicJsonType >

result nlohmann::json_pointer< BasicJsonType >::reference_tokens = {reference_tokens[0]}

private

Definition at line 11993 of file json.h.

◆ reference_tokens [2/2]

template<typename BasicJsonType >

std::vector<std::string> nlohmann::json_pointer< BasicJsonType >::reference_tokens

private

the reference tokens

Definition at line 12583 of file json.h.

◆ result [1/2]

template<typename BasicJsonType >

json_pointer nlohmann::json_pointer< BasicJsonType >::result = *this

private

Definition at line 11992 of file json.h.

Referenced by nlohmann::json_pointer< BasicJsonType >::flatten(), nlohmann::json_pointer< BasicJsonType >::get_and_create(), nlohmann::json_pointer< BasicJsonType >::split(), and nlohmann::json_pointer< BasicJsonType >::unflatten().

◆ result [2/2]

template<typename BasicJsonType >

return nlohmann::json_pointer< BasicJsonType >::result

private

Definition at line 11994 of file json.h.

◆ s

template<typename BasicJsonType >

return nlohmann::json_pointer< BasicJsonType >::s

private

Definition at line 12440 of file json.h.

Referenced by nlohmann::json_pointer< BasicJsonType >::array_index(), nlohmann::json_pointer< BasicJsonType >::replace_substring(), and nlohmann::json_pointer< BasicJsonType >::unescape().

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

src/applications/utils/json.h

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

template<typename BasicJsonType> class nlohmann::json_pointer< BasicJsonType >

Constructor & Destructor Documentation

◆ json_pointer()

Member Function Documentation

◆ array_index()

◆ back()

◆ contains()

◆ empty()

◆ flatten()

◆ get_and_create()

◆ get_checked() [1/2]

◆ get_checked() [2/2]

◆ get_unchecked() [1/2]

◆ get_unchecked() [2/2]

◆ operator std::string()

◆ operator/=() [1/3]

◆ operator/=() [2/3]

◆ operator/=() [3/3]

◆ parent_pointer()

◆ pop_back()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ replace_substring() [1/2]

◆ replace_substring() [2/2]

◆ split()

◆ to_string()

◆ unescape()

◆ unflatten()

Friends And Related Function Documentation

◆ basic_json

◆ operator!=

◆ operator/ [1/3]

◆ operator/ [2/3]

◆ operator/ [3/3]

◆ operator==

Member Data Documentation

◆ __pad0__

◆ __pad1__

◆ parent

◆ reference_tokens [1/2]

◆ reference_tokens [2/2]

◆ result [1/2]

◆ result [2/2]

◆ s

template<typename BasicJsonType>
class nlohmann::json_pointer< BasicJsonType >

◆ pad0

◆ pad1