basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >::json_pointer Class Reference

JSON Pointer. More...

#include <json.hpp>

Collaboration diagram for basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >::json_pointer:

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

Friends
class	basic_json
	allow basic_json to access private members More...
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<template< typename U, typename V, typename... Args > class ObjectType = std::map, template< typename U, typename... Args > class ArrayType = std::vector, class StringType = std::string, class BooleanType = bool, class NumberIntegerType = std::int64_t, class NumberUnsignedType = std::uint64_t, class NumberFloatType = double, template< typename U > class AllocatorType = std::allocator, template< typename T, typename SFINAE=void > class JSONSerializer = adl_serializer>
class nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >::json_pointer

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 11623 of file json.hpp.

Constructor & Destructor Documentation

json_pointer()

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

std::domain_error	if reference token is nonempty and does not begin with a slash (/); example: "JSON pointer must be empty or begin with /"
std::domain_error	if a tilde (~) is not followed by 0 (representing ~) or 1 (representing /); example: "escape error: ~ must be followed with 0 or 1"

{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 11651 of file json.hpp.

Member Function Documentation

operator std::string()

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

Definition at line 11681 of file json.hpp.

Here is the call graph for this function:

to_string()

std::string 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

Definition at line 11670 of file json.hpp.

Friends And Related Function Documentation

basic_json

friend class basic_json

friend

allow basic_json to access private members

Definition at line 11626 of file json.hpp.

operator!=

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

friend

Definition at line 12211 of file json.hpp.

operator==

bool operator== ( json_pointer const &  lhs, json_pointer const &  rhs  )

friend

Definition at line 12205 of file json.hpp.

---

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

• json.hpp