json/doc/mkdocs/docs/api/basic_json/to_string.md

49 lines
857 B
Markdown
Raw Normal View History

2021-11-05 00:36:11 +03:00
# to_string(basic_json)
```cpp
template <typename BasicJsonType>
std::string to_string(const BasicJsonType& j)
```
This function implements a user-defined to_string for JSON objects.
## Template parameters
`BasicJsonType`
: a specialization of [`basic_json`](index.md)
## Return value
string containing the serialization of the JSON value
2021-11-05 16:26:19 +03:00
## Exception safety
Strong guarantee: if an exception is thrown, there are no changes to any JSON value.
2021-11-05 00:36:11 +03:00
## Exceptions
Throws [`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) if a string stored inside the JSON value
is not UTF-8 encoded
## Complexity
Linear.
## Possible implementation
```cpp
template <typename BasicJsonType>
std::string to_string(const BasicJsonType& j)
{
return j.dump();
}
```
## See also
- [dump](dump.md)
## Version history
Added in version 3.7.0.