nlohmann::json_pointer< BasicJsonType > Class Template Reference

JSON Pointer. More...

#include <json.hpp>

Public Member Functions
	json_pointer (const std::string &s="")
	create JSON pointer More...
std::string	to_string () const noexcept
	return a string representation of the JSON pointer More...
	operator std::string () const
	return a string representation of the JSON pointer More...

Static Public Member Functions
static int	array_index (const std::string &s)

Friends
class	basic_json
bool	operator== (json_pointer const &lhs, json_pointer const &rhs) noexcept
bool	operator!= (json_pointer const &lhs, json_pointer const &rhs) noexcept

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

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

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

Since

version 2.0.0

Member Function Documentation

array_index()

template<typename BasicJsonType >

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

inlinestatic

Parameters

[in]

s

reference token to be converted into an array index

Returns

integer representation of s

Exceptions

out_of_range.404

if string s could not be converted to an integer

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

Returns

a string representation of the JSON pointer

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

Since

version 2.0.0

to_string()

template<typename BasicJsonType >

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

inlinenoexcept

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

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

Since

version 2.0.0

---

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

• IO/vtk/include/json.hpp