Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.83 KB

decode_ubjson.md

File metadata and controls

61 lines (43 loc) · 2.83 KB
Raw

jsoncons::ubjson::decode_ubjson

Decodes a Universal Binary JSON Specification (JSON) data format into a C++ data structure.

#include <jsoncons_ext/ubjson/ubjson.hpp>

template <typename T>
T decode_ubjson(const std::vector<uint8_t>& source,
    const bson_decode_options& options = bson_decode_options());    (1) (until 0.152.0)

template <typename T,typename Source>
T decode_ubjson(const Source& source,
    const bson_decode_options& options = bson_decode_options());           (1) (since 0.152.0)

template <typename T>
T decode_ubjson(std::istream>& is,
    const bson_decode_options& options = bson_decode_options());           (2)

template <typename T,typename InputIt>
T decode_ubjson(InputIt first, InputIt last,
    const bson_decode_options& options = bson_decode_options());           (3)

template <typename T,typename Source,class Allocator,class TempAllocator>
T decode_ubjson(const allocator_set<Allocator,TempAllocator>& alloc_set,
    const Source& source,
    const ubjson_decode_options& options = ubjson_decode_options());       (4) (since 0.171.0)

template <typename T,class Allocator,class TempAllocator>
T decode_ubjson(const allocator_set<Allocator,TempAllocator>& alloc_set,
    std::istream& is,
    const ubjson_decode_options& options = ubjson_decode_options());       (5) (since 0.171.0)

(1) Reads UBJSON data from a contiguous byte sequence provided by source into a type T, using the specified (or defaulted) options. Type Source must be a container that has member functions data() and size(), and member type value_type with size exactly 8 bits (since 0.152.0.) Any of the values types int8_t, uint8_t, char, unsigned char and std::byte (since C++17) are allowed. Type 'T' must be an instantiation of basic_json or support json_type_traits.

(2) Reads UBJSON data from a binary stream into a type T, using the specified (or defaulted) options. Type 'T' must be an instantiation of basic_json or support json_type_traits.

(3) Reads UBJSON data from the range [first,last) into a type T, using the specified (or defaulted) options. Type 'T' must be an instantiation of basic_json or support json_type_traits.

Functions (4)-(5) are identical to (1)-(2) except an allocator_set is passed as an additional argument and provides allocators for result data and temporary allocations.

Exceptions

Throws a ser_error if parsing fails, and a conv_error if type conversion fails.

See also

encode_ubjson encodes a json value to the Universal Binary JSON Specification data format.