json/doc/mkdocs/docs/api/json_pointer/json_pointer.md
Niels Lohmann e97c93f451
🔧 add namespaces
2021-11-07 13:13:37 +01:00

1.1 KiB

nlohmann::json_pointer::json_pointer

explicit json_pointer(const std::string& 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

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.

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"
```

Version history

Added in version 2.0.0.