mirror of
https://github.com/nlohmann/json.git
synced 2025-07-27 00:41:05 +03:00
29cd970b94
* 🔥 consolidate documentation * ♻️ overwork std specializations * 🚚 move images files to mkdocs * ♻️ fix URLs * 🔧 tweak MkDocs configuration * 🔧 add namespaces * 📝 document deprecations * 📝 document documentation generation * 🚸 improve search * 🚸 add examples * 🚧 start adding documentation for macros * 📝 add note for https://github.com/nlohmann/json/issues/874#issuecomment-1001699139 * 📝 overwork example handling * 📝 fix Markdown tables
59 lines
1.2 KiB
Markdown
59 lines
1.2 KiB
Markdown
# <small>nlohmann::basic_json::</small>clear
|
|
|
|
```cpp
|
|
void clear() noexcept;
|
|
```
|
|
|
|
Clears the content of a JSON value and resets it to the default value as if [`basic_json(value_t)`](basic_json.md) would
|
|
have been called with the current value type from [`type()`](type.md):
|
|
|
|
| Value type | initial value |
|
|
|------------|----------------------|
|
|
| null | `null` |
|
|
| boolean | `false` |
|
|
| string | `""` |
|
|
| number | `0` |
|
|
| binary | An empty byte vector |
|
|
| object | `{}` |
|
|
| array | `[]` |
|
|
|
|
Has the same effect as calling
|
|
|
|
```.cpp
|
|
*this = basic_json(type());
|
|
```
|
|
|
|
## Exception safety
|
|
|
|
No-throw guarantee: this function never throws exceptions.
|
|
|
|
## Complexity
|
|
|
|
Linear in the size of the JSON value.
|
|
|
|
## Notes
|
|
|
|
All iterators, pointers and references related to this container are invalidated.
|
|
|
|
## Examples
|
|
|
|
??? example
|
|
|
|
The example below shows the effect of `clear()` to different
|
|
JSON types.
|
|
|
|
```cpp
|
|
--8<-- "examples/clear.cpp"
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
--8<-- "examples/clear.output"
|
|
```
|
|
|
|
## Version history
|
|
|
|
- Added in version 1.0.0.
|
|
- Added support for binary types in version 3.8.0.
|