json/api/json_pointer/json_pointer.md

nlohmann::json_pointer::json_pointer

explicit json_pointer(const string_t& s = "");

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

Parameters

s (in)

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

Exception safety

Strong guarantee: if an exception is thrown, there are no changes to any JSON pointer.

Exceptions

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

Complexity

Linear in the length of s.

Examples

??? example

The example shows the construction several valid JSON pointers as well as the exceptional behavior.
 
```cpp
--8<-- "examples/json_pointer.cpp"
```

Output:

```json
--8<-- "examples/json_pointer.output"
```

See also

• JSON Pointer - the article on JSON Pointer support
• operator""_json_pointer user-defined string literal for JSON pointers

Version history

• Added in version 2.0.0.
• Changed type of s to string_t in version 3.11.0.