|
◆ from_ubjson() [1/2]
template<typename A1 , typename A2 , detail::enable_if_t< std::is_constructible< detail::input_adapter, A1, A2 >::value, int > = 0>
static basic_json nlohmann::basic_json::from_ubjson |
( |
A1 && |
a1, |
|
|
A2 && |
a2, |
|
|
const bool |
strict = true , |
|
|
const bool |
allow_exceptions = true |
|
) |
| |
|
inlinestatic |
Deserializes a given input i to a JSON value using the UBJSON (Universal Binary JSON) serialization format.
The library maps UBJSON types to JSON value types as follows:
UBJSON type | JSON value type | marker |
no-op | no value, next value is read | N |
null | null | Z |
false | false | F |
true | true | T |
float32 | number_float | d |
float64 | number_float | D |
uint8 | number_unsigned | U |
int8 | number_integer | i |
int16 | number_integer | I |
int32 | number_integer | l |
int64 | number_integer | L |
string | string | S |
char | string | C |
array | array (optimized values are supported) | [ |
object | object (optimized values are supported) | { |
- Note
- The mapping is complete in the sense that any UBJSON value can be converted to a JSON value.
- Parameters
-
[in] | i | an input in UBJSON format convertible to an input adapter |
[in] | strict | whether to expect the input to be consumed until EOF (true by default) |
[in] | allow_exceptions | whether to throw exceptions in case of a parse error (optional, true by default) |
- Returns
- deserialized JSON value; in case of a parse error and allow_exceptions set to
false , the return value will be value_t::discarded.
- Exceptions
-
parse_error.110 | if the given input ends prematurely or the end of file was not reached when strict was set to true |
parse_error.112 | if a parse error occurs |
parse_error.113 | if a string could not be parsed successfully |
- Complexity
- Linear in the size of the input i.
- Example
- The example shows the deserialization of a byte vector in UBJSON format to a JSON value.
3 #include <nlohmann/json.hpp>
10 std::vector<uint8_t> v = {0x7B, 0x69, 0x07, 0x63, 0x6F, 0x6D, 0x70, 0x61,
11 0x63, 0x74, 0x54, 0x69, 0x06, 0x73, 0x63, 0x68,
12 0x65, 0x6D, 0x61, 0x69, 0x00, 0x7D
19 std::cout << std::setw(2) << j << std::endl;
Output (play with this example online): {
"compact": true,
"schema": 0
}
The example code above can be translated withg++ -std=c++11 -Isingle_include doc/examples/from_ubjson.cpp -o from_ubjson
- See also
- http://ubjson.org
-
to_ubjson(const basic_json&, const bool, const bool) for the analogous serialization
-
from_cbor(detail::input_adapter&&, const bool, const bool) for the related CBOR format
-
from_msgpack(detail::input_adapter&&, const bool, const bool) for the related MessagePack format
-
from_bson(detail::input_adapter&&, const bool, const bool) for the related BSON format
- Since
- version 3.1.0; added allow_exceptions parameter since 3.2.0
Definition at line 21740 of file json.hpp.
|