| # <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 with no subtype | | |
| | 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 | |
| #include <iostream> | |
| #include <nlohmann/json.hpp> | |
| using json = nlohmann::json; | |
| int main() | |
| { | |
| // create JSON values | |
| json j_null; | |
| json j_boolean = true; | |
| json j_number_integer = 17; | |
| json j_number_float = 23.42; | |
| json j_object = {{"one", 1}, {"two", 2}}; | |
| json j_array = {1, 2, 4, 8, 16}; | |
| json j_string = "Hello, world"; | |
| // call clear() | |
| j_null.clear(); | |
| j_boolean.clear(); | |
| j_number_integer.clear(); | |
| j_number_float.clear(); | |
| j_object.clear(); | |
| j_array.clear(); | |
| j_string.clear(); | |
| // serialize the cleared values() | |
| std::cout << j_null << '\n'; | |
| std::cout << j_boolean << '\n'; | |
| std::cout << j_number_integer << '\n'; | |
| std::cout << j_number_float << '\n'; | |
| std::cout << j_object << '\n'; | |
| std::cout << j_array << '\n'; | |
| std::cout << j_string << '\n'; | |
| } | |
| ``` | |
| Output: | |
| ```json | |
| null | |
| false | |
| 0 | |
| 0.0 | |
| {} | |
| [] | |
| "" | |
| ``` | |
| ## See also | |
| - [erase](erase.md) removes elements from a JSON value | |
| - [empty](empty.md) checks whether the JSON value has no elements | |
| ## Version history | |
| - Added in version 1.0.0. | |
| - Added support for binary types in version 3.8.0. | |
| - Fixed in version 3.13.0 to also clear the subtype of a binary value; before, the subtype was left unchanged. |