2022-07-31 18:38:52 +03:00
|
|
|
# <small>nlohmann::</small>operator""_json_pointer
|
2020-08-13 15:04:08 +03:00
|
|
|
|
|
|
|
|
```cpp
|
2021-12-29 15:41:01 +03:00
|
|
|
json_pointer operator "" _json_pointer(const char* s, std::size_t n);
|
2020-08-13 15:04:08 +03:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This operator implements a user-defined string literal for JSON Pointers. It can be used by adding `#!cpp _json_pointer`
|
2022-07-31 18:38:52 +03:00
|
|
|
to a string literal and returns a [`json_pointer`](json_pointer/index.md) object if no parse error occurred.
|
2020-08-13 15:04:08 +03:00
|
|
|
|
2022-08-01 23:42:35 +03:00
|
|
|
It is recommended to bring the operator into scope using any of the following lines:
|
2022-07-31 18:38:52 +03:00
|
|
|
```cpp
|
2022-08-01 23:42:35 +03:00
|
|
|
using nlohmann::literals::operator "" _json_pointer;
|
2022-07-31 18:38:52 +03:00
|
|
|
using namespace nlohmann::literals;
|
|
|
|
|
using namespace nlohmann::json_literals;
|
|
|
|
|
using namespace nlohmann::literals::json_literals;
|
|
|
|
|
using namespace nlohmann;
|
|
|
|
|
```
|
2022-08-05 20:51:39 +03:00
|
|
|
This is suggested to ease migration to the next major version release of the library. See
|
|
|
|
|
['JSON_USE_GLOBAL_UDLS`](macros/json_use_global_udls.md#notes) for details.
|
2022-07-31 18:38:52 +03:00
|
|
|
|
2020-08-13 15:04:08 +03:00
|
|
|
## Parameters
|
|
|
|
|
|
|
|
|
|
`s` (in)
|
|
|
|
|
: a string representation of a JSON Pointer
|
|
|
|
|
|
|
|
|
|
`n` (in)
|
|
|
|
|
: length of string `s`
|
|
|
|
|
|
|
|
|
|
## Return value
|
|
|
|
|
|
2022-07-31 18:38:52 +03:00
|
|
|
[`json_pointer`](json_pointer/index.md) value parsed from `s`
|
2020-08-13 15:04:08 +03:00
|
|
|
|
|
|
|
|
## Exceptions
|
|
|
|
|
|
2022-07-31 18:38:52 +03:00
|
|
|
The function can throw anything that [`json_pointer::json_pointer`](json_pointer/index.md) would throw.
|
2020-08-13 15:04:08 +03:00
|
|
|
|
|
|
|
|
## Complexity
|
|
|
|
|
|
|
|
|
|
Linear.
|
|
|
|
|
|
2021-12-29 15:41:01 +03:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
??? example
|
|
|
|
|
|
|
|
|
|
The following code shows how to create JSON Pointers from string literals.
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
--8<-- "examples/operator_literal_json_pointer.cpp"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Output:
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
--8<-- "examples/operator_literal_json_pointer.output"
|
|
|
|
|
```
|
|
|
|
|
|
2022-01-09 16:32:38 +03:00
|
|
|
## See also
|
|
|
|
|
|
2022-07-31 18:38:52 +03:00
|
|
|
- [json_pointer](json_pointer/index.md) - type to represent JSON Pointers
|
2022-01-09 16:32:38 +03:00
|
|
|
|
2020-08-13 15:04:08 +03:00
|
|
|
## Version history
|
|
|
|
|
|
|
|
|
|
- Added in version 2.0.0.
|
2022-07-31 18:38:52 +03:00
|
|
|
- Moved to namespace `nlohmann::literals::json_literals` in 3.11.0.
|