deploy: 7c9208bfb3

api/basic_json/to_string.md

@@ -0,0 +1,66 @@
+# 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
+
+## Exception safety
+
+Strong guarantee: if an exception is thrown, there are no changes to any JSON value.
+
+## 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();
+}
+```
+
+## Examples
+
+??? example
+
+    The following code shows how the library's `to_string()` function integrates with others, allowing
+    argument-dependent lookup.
+     
+    ```cpp
+    --8<-- "examples/to_string.cpp"
+    ```
+    
+    Output:
+    
+    ```json
+    --8<-- "examples/to_string.output"
+    ```
+
+## See also
+
+- [dump](dump.md)
+- [Serialization](../../features/serialization.md) - the serialization article
+
+## Version history
+
+Added in version 3.7.0.