mirror/json
1
0
Fork 0
mirror of https://github.com/nlohmann/json.git synced 2024-12-22 04:17:51 +08:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity
3c7dc635e7
json/doc/index.md
Niels Lohmann 5f862710fe
🔖 set version to 3.8.0
2020-06-14 17:16:45 +02:00

336 lines
22 KiB
Markdown
Raw Blame History

# JSON for Modern C++
These pages contain the API documentation of JSON for Modern C++, a C++11 header-only JSON class.
# Contents
- Classes
- @link nlohmann::basic_json `basic_json`@endlink -- class template for JSON values
- @link nlohmann::json `json`@endlink -- the default specialization of `basic_json`, defined as `basic_json<>`
- [Functions](functions_func.html)
- object inspection
- @link nlohmann::basic_json::dump dump @endlink -- value serialization
- @link nlohmann::basic_json::type type @endlink -- type of the value
- @link nlohmann::basic_json::is_primitive is_primitive @endlink,
@link nlohmann::basic_json::is_structured is_structured @endlink,
@link nlohmann::basic_json::is_null is_null @endlink,
@link nlohmann::basic_json::is_boolean is_boolean @endlink,
@link nlohmann::basic_json::is_number is_number @endlink,
@link nlohmann::basic_json::is_number_integer is_number_integer @endlink,
@link nlohmann::basic_json::is_number_unsigned is_number_unsigned @endlink,
@link nlohmann::basic_json::is_number_float is_number_float @endlink,
@link nlohmann::basic_json::is_object is_object @endlink,
@link nlohmann::basic_json::is_array is_array @endlink,
@link nlohmann::basic_json::is_string is_string @endlink,
@link nlohmann::basic_json::is_discarded is_discarded @endlink,
@link nlohmann::basic_json::is_binary is_binary @endlink -- check for value type
- @link nlohmann::basic_json::operator value_t() const operator value_t @endlink -- type of the value (implicit conversion)
- value access
- @link nlohmann::basic_json::get get @endlink -- get a value
- @link nlohmann::basic_json::get_ptr get_ptr @endlink -- get a value pointer
- @link nlohmann::basic_json::get_ref get_ref @endlink -- get a value reference
- @link nlohmann::basic_json::get_binary get_binary @endlink -- get a binary value
- @link nlohmann::basic_json::operator ValueType() const operator ValueType @endlink -- get a value (implicit conversion)
- @link nlohmann::basic_json::value value @endlink -- get a value from an object and return default value if key is not present
- exceptions
- @link nlohmann::basic_json::parse_error parse_error @endlink for exceptions indicating a parse error
- @link nlohmann::basic_json::invalid_iterator invalid_iterator @endlink for exceptions indicating errors with iterators
- @link nlohmann::basic_json::type_error type_error @endlink for exceptions indicating executing a member function with a wrong type
- @link nlohmann::basic_json::out_of_range out_of_range @endlink for exceptions indicating access out of the defined range
- @link nlohmann::basic_json::other_error other_error @endlink for exceptions indicating other library errors
- lexicographical comparison operators
- @link nlohmann::basic_json::operator== operator== @endlink
- @link nlohmann::basic_json::operator!= operator!= @endlink
- @link nlohmann::basic_json::operator< operator<= @endlink
- @link nlohmann::basic_json::operator<= operator< @endlink
- @link nlohmann::basic_json::operator> operator> @endlink
- @link nlohmann::basic_json::operator>= operator>= @endlink
- serialization
- @link nlohmann::basic_json::dump dump @endlink serialize to string
- @link nlohmann::basic_json::operator<<(std::ostream&, const basic_json &) operator<< @endlink serialize to stream
- deserialization / parsing
- @link nlohmann::basic_json::parse parse @endlink parse from input (string, file, etc.) and return JSON value
- @link nlohmann::basic_json::sax_parse sax_parse @endlink parse from input (string, file, etc.) and generate SAX events
- @link nlohmann::basic_json::operator>>(std::istream&, basic_json&) operator>> @endlink parse from stream
- @link nlohmann::basic_json::accept accept @endlink check for syntax errors without parsing
- @link nlohmann::json_sax SAX interface @endlink define a user-defined SAX event consumer
- @link nlohmann::basic_json::parser_callback_t callback interface @endlink register a callback to the parse function
- [binary formats](binary_formats.md):
- CBOR: @link nlohmann::basic_json::from_cbor from_cbor @endlink / @link nlohmann::basic_json::to_cbor to_cbor @endlink
- MessagePack: @link nlohmann::basic_json::from_msgpack from_msgpack @endlink / @link nlohmann::basic_json::to_msgpack to_msgpack @endlink
- UBJSON: @link nlohmann::basic_json::from_ubjson from_ubjson @endlink / @link nlohmann::basic_json::to_ubjson to_ubjson @endlink
- BSON: @link nlohmann::basic_json::from_bson from_bson @endlink / @link nlohmann::basic_json::to_bson to_bson @endlink
- Types
- @link nlohmann::basic_json::array_t arrays @endlink
- @link nlohmann::basic_json::object_t objects @endlink
- @link nlohmann::basic_json::string_t strings @endlink
- @link nlohmann::basic_json::boolean_t booleans @endlink
- numbers
- @link nlohmann::basic_json::number_integer_t signed integers @endlink
- @link nlohmann::basic_json::number_unsigned_t unsigned integers @endlink
- @link nlohmann::basic_json::number_float_t floating-point @endlink
- @link nlohmann::basic_json::binary_t binary values @endlink
- further JSON standards
- @link nlohmann::json_pointer JSON Pointer @endlink (RFC 6901)
- @link nlohmann::basic_json::patch JSON Patch @endlink (RFC 6902)
- @link nlohmann::basic_json::merge_patch JSON Merge Patch @endlink (RFC 7396)
# Container function overview
The container functions known from STL have been extended to support the different value types from JSON. However, not all functions can be applied to all value types. Note that the signature of some functions differ between the types; for instance, `at` may be called with either a string to address a key in an object or with an integer to address a value in an array.
Note that this table only lists those exceptions thrown due to the type. For instance, the @link nlohmann::basic_json::at(const typename object_t::key_type & key) `at` @endlink function will always throw a @link nlohmann::basic_json::type_error `json::type_error` @endlink exception when called for a string type. When called for an array, it *may* throw an @link nlohmann::basic_json::out_of_range `json::out_of_range` @endlink exception if the passed index is invalid.
<table>
<tr>
<th rowspan="2">group</th>
<th rowspan="2">function</th>
<th colspan="6">JSON value type</th>
</tr>
<tr>
<th>object</th>
<th>array</th>
<th>string</th>
<th>number</th>
<th>boolean</th>
<th>null</th>
</tr>
<tr>
<td rowspan="8">iterators</td>
<td>`begin`</td>
<td class="ok_green">@link nlohmann::basic_json::begin `begin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::begin `begin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::begin `begin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::begin `begin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::begin `begin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::begin `begin` @endlink (returns `end()`)</td>
</tr>
<tr>
<td>`cbegin`</td>
<td class="ok_green">@link nlohmann::basic_json::cbegin `cbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::cbegin `cbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::cbegin `cbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::cbegin `cbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::cbegin `cbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::cbegin `cbegin` @endlink (returns `cend()`)</td>
</tr>
<tr>
<td>`end`</td>
<td class="ok_green">@link nlohmann::basic_json::end `end` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::end `end` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::end `end` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::end `end` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::end `end` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::end `end` @endlink</td>
</tr>
<tr>
<td>`cend`</td>
<td class="ok_green">@link nlohmann::basic_json::cend `cend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::cend `cend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::cend `cend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::cend `cend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::cend `cend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::cend `cend` @endlink</td>
</tr>
<tr>
<td>`rbegin`</td>
<td class="ok_green">@link nlohmann::basic_json::rbegin `rbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::rbegin `rbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::rbegin `rbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::rbegin `rbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::rbegin `rbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::rbegin `rbegin` @endlink</td>
</tr>
<tr>
<td>`crbegin`</td>
<td class="ok_green">@link nlohmann::basic_json::crbegin `crbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::crbegin `crbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::crbegin `crbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::crbegin `crbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::crbegin `crbegin` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::crbegin `crbegin` @endlink</td>
</tr>
<tr>
<td>`rend`</td>
<td class="ok_green">@link nlohmann::basic_json::rend `rend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::rend `rend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::rend `rend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::rend `rend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::rend `rend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::rend `rend` @endlink</td>
</tr>
<tr>
<td>`crend`</td>
<td class="ok_green">@link nlohmann::basic_json::crend `crend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::crend `crend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::crend `crend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::crend `crend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::crend `crend` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::crend `crend` @endlink</td>
</tr>
<tr>
<td rowspan="4">element<br>access</td>
<td>`at`</td>
<td class="ok_green">@link nlohmann::basic_json::at(const typename object_t::key_type & key) `at` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::at(size_type) `at` @endlink</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (304)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (304)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (304)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (304)</td>
</tr>
<tr>
<td>`operator[]`</td>
<td class="ok_green">@link nlohmann::basic_json::operator[](const typename object_t::key_type &key) `operator[]` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::operator[](size_type) `operator[]` @endlink</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (305)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (305)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (305)</td>
<td class="ok_green">@link nlohmann::basic_json::operator[](const typename object_t::key_type & key) `operator[]` @endlink (creates object)<br>@link nlohmann::basic_json::operator[](size_type) `operator[]` @endlink (creates array)</td>
</tr>
<tr>
<td>`front`</td>
<td class="ok_green">@link nlohmann::basic_json::front `front` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::front `front` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::front `front` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::front `front` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::front `front` @endlink</td>
<td class="nok_throws">throws @link nlohmann::basic_json::invalid_iterator `json::invalid_iterator` @endlink (214)</td>
</tr>
<tr>
<td>`back`</td>
<td class="ok_green">@link nlohmann::basic_json::back `back` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::back `back` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::back `back` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::back `back` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::back `back` @endlink</td>
<td class="nok_throws">throws @link nlohmann::basic_json::invalid_iterator `json::invalid_iterator` @endlink (214)</td>
</tr>
<tr>
<td rowspan="3">capacity</td>
<td>`empty`</td>
<td class="ok_green">@link nlohmann::basic_json::empty `empty` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::empty `empty` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::empty `empty` @endlink (returns `false`)</td>
<td class="ok_green">@link nlohmann::basic_json::empty `empty` @endlink (returns `false`)</td>
<td class="ok_green">@link nlohmann::basic_json::empty `empty` @endlink (returns `false`)</td>
<td class="ok_green">@link nlohmann::basic_json::empty `empty` @endlink (returns `true`)</td>
</tr>
<tr>
<td>`size`</td>
<td class="ok_green">@link nlohmann::basic_json::size `size` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::size `size` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::size `size` @endlink (returns `1`)</td>
<td class="ok_green">@link nlohmann::basic_json::size `size` @endlink (returns `1`)</td>
<td class="ok_green">@link nlohmann::basic_json::size `size` @endlink (returns `1`)</td>
<td class="ok_green">@link nlohmann::basic_json::size `size` @endlink (returns `0`)</td>
</tr>
<tr>
<td>`max_size_`</td>
<td class="ok_green">@link nlohmann::basic_json::max_size `max_size` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::max_size `max_size` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::max_size `max_size` @endlink (returns `1`)</td>
<td class="ok_green">@link nlohmann::basic_json::max_size `max_size` @endlink (returns `1`)</td>
<td class="ok_green">@link nlohmann::basic_json::max_size `max_size` @endlink (returns `1`)</td>
<td class="ok_green">@link nlohmann::basic_json::max_size `max_size` @endlink (returns `0`)</td>
</tr>
<tr>
<td rowspan="7">modifiers</td>
<td>`clear`</td>
<td class="ok_green">@link nlohmann::basic_json::clear `clear` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::clear `clear` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::clear `clear` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::clear `clear` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::clear `clear` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::clear `clear` @endlink</td>
</tr>
<tr>
<td>`insert`</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (309)</td>
<td class="ok_green">@link nlohmann::basic_json::insert `insert` @endlink</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (309)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (309)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (309)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (309)</td>
</tr>
<tr>
<td>`erase`</td>
<td class="ok_green">@link nlohmann::basic_json::erase `erase` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::erase `erase` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::erase `erase` @endlink (converts to null)</td>
<td class="ok_green">@link nlohmann::basic_json::erase `erase` @endlink (converts to null)</td>
<td class="ok_green">@link nlohmann::basic_json::erase `erase` @endlink (converts to null)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (307)</td>
</tr>
<tr>
<td>`push_back`</td>
<td class="ok_green">@link nlohmann::basic_json::push_back(const typename object_t::value_type & val) `push_back` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::push_back(const nlohmann::basic_json &) `push_back` @endlink</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (308)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (308)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (308)</td>
<td class="ok_green">@link nlohmann::basic_json::push_back(const typename object_t::value_type & val) `push_back` @endlink (creates object)<br>@link nlohmann::basic_json::push_back(const nlohmann::basic_json &) `push_back` @endlink (creates array)</td>
</tr>
<tr>
<td>`emplace` / `emplace_back`</td>
<td class="ok_green">@link nlohmann::basic_json::emplace() `emplace` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::emplace_back() `emplace_back` @endlink</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (311)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (311)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (311)</td>
<td class="ok_green">@link nlohmann::basic_json::emplace() `emplace` @endlink (creates object)<br>@link nlohmann::basic_json::emplace_back() `emplace_back` @endlink (creates array)</td>
</tr>
<tr>
<td>`update`</td>
<td class="ok_green">@link nlohmann::basic_json::update() `update` @endlink</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (312)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (312)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (312)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (312)</td>
<td class="nok_throws">throws @link nlohmann::basic_json::type_error `json::type_error` @endlink (312)</td>
</tr>
<tr>
<td>`swap`</td>
<td class="ok_green">@link nlohmann::basic_json::swap `swap` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::swap `swap` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::swap `swap` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::swap `swap` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::swap `swap` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::swap `swap` @endlink</td>
</tr>
<tr>
<td rowspan="3">lookup</td>
<td>`find`</td>
<td class="ok_green">@link nlohmann::basic_json::find `find` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::find `find` @endlink (returns `end()`)</td>
<td class="ok_green">@link nlohmann::basic_json::find `find` @endlink (returns `end()`)</td>
<td class="ok_green">@link nlohmann::basic_json::find `find` @endlink (returns `end()`)</td>
<td class="ok_green">@link nlohmann::basic_json::find `find` @endlink (returns `end()`)</td>
<td class="ok_green">@link nlohmann::basic_json::find `find` @endlink (returns `end()`)</td>
</tr>
<tr>
<td>`count`</td>
<td class="ok_green">@link nlohmann::basic_json::count `count` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::count `count` @endlink (returns `0`)</td>
<td class="ok_green">@link nlohmann::basic_json::count `count` @endlink (returns `0`)</td>
<td class="ok_green">@link nlohmann::basic_json::count `count` @endlink (returns `0`)</td>
<td class="ok_green">@link nlohmann::basic_json::count `count` @endlink (returns `0`)</td>
<td class="ok_green">@link nlohmann::basic_json::count `count` @endlink (returns `0`)</td>
</tr>
<tr>
<td>`contains`</td>
<td class="ok_green">@link nlohmann::basic_json::contains `contains` @endlink</td>
<td class="ok_green">@link nlohmann::basic_json::contains `contains` @endlink (returns `false`)</td>
<td class="ok_green">@link nlohmann::basic_json::contains `contains` @endlink (returns `false`)</td>
<td class="ok_green">@link nlohmann::basic_json::contains `contains` @endlink (returns `false`)</td>
<td class="ok_green">@link nlohmann::basic_json::contains `contains` @endlink (returns `false`)</td>
<td class="ok_green">@link nlohmann::basic_json::contains `contains` @endlink (returns `false`)</td>
</tr>
</table>
@copyright Copyright &copy; 2013-2020 Niels Lohmann. The code is licensed under the [MIT License](http://opensource.org/licenses/MIT).
@author [Niels Lohmann](http://nlohmann.me)
@see https://github.com/nlohmann/json to download the source code
@version 3.8.0
Reference in New Issue View Git Blame Copy Permalink