json/doc/mkdocs/docs/api/json_pointer/index.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

2021-11-07 15:13:37 +03:00
# <small>nlohmann::</small>json_pointer
2021-11-05 23:43:46 +03:00
```cpp
template<typename BasicJsonType>
class json_pointer;
```
2021-11-06 01:29:15 +03:00
A JSON pointer defines a string syntax for identifying a specific value within a JSON document. It can be used with
functions [`at`](../basic_json/at.md) and [`operator[]`](../basic_json/operator%5B%5D.md). Furthermore, JSON pointers
are the base for JSON patches.
2021-11-05 23:43:46 +03:00
## Template parameters
`BasicJsonType`
: a specialization of [`basic_json`](../basic_json/index.md)
## Member functions
- [(constructor)](json_pointer.md)
- [**to_string**](to_string.md) - return a string representation of the JSON pointer
- [**operator std::string**](operator_string.md) - return a string representation of the JSON pointer
- [**operator/=**](operator_slasheq.md) - append to the end of the JSON pointer
- [**operator/**](operator_slash.md) - create JSON Pointer by appending
- [**parent_pointer**](parent_pointer.md) - returns the parent of this JSON pointer
- [**pop_back**](pop_back.md) - remove last reference token
- [**back**](back.md) - return last reference token
- [**push_back**](push_back.md) - append an unescaped token at the end of the pointer
- [**empty**](empty.md) - return whether pointer points to the root document
## See also
2021-11-06 01:29:15 +03:00
- [RFC 6901](https://datatracker.ietf.org/doc/html/rfc6901)
2021-11-05 23:43:46 +03:00
## Version history
Added in version 2.0.0.