Skip to content

decode_ubjson.md

Latest commit

 

History

History
89 lines (62 loc) · 3.91 KB

decode_ubjson.md

File metadata and controls

89 lines (62 loc) · 3.91 KB

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,typename BytesViewLike>
T decode_ubjson(const BytesViewLike& 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 BytesViewLike,typename Alloc,typename TempAlloc>
T decode_ubjson(const allocator_set<Alloc,TempAlloc>& aset,
    const BytesViewLike& source,
    const ubjson_decode_options& options = ubjson_decode_options());           (3) (since 0.171.0)

template <typename T,typename Alloc,typename TempAlloc>
T decode_ubjson(const allocator_set<Alloc,TempAlloc>& aset,
    std::istream& is,
    const ubjson_decode_options& options = ubjson_decode_options());           (4) (since 0.171.0)

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

template <typename T,typename BytesViewLike>
read_result<T> try_decode_ubjson(const BytesViewLike& source,
    const bson_decode_options& options = bson_decode_options());               (6) (since 1.4.0)

template <typename T>
read_result<T> try_decode_ubjson(std::istream>& is,
    const bson_decode_options& options = bson_decode_options());               (7) (since 1.4.0)

template <typename T,typename BytesViewLike,typename Alloc,typename TempAlloc>
read_result<T> try_decode_ubjson(const allocator_set<Alloc,TempAlloc>& aset,
    const BytesViewLike& source,
    const ubjson_decode_options& options = ubjson_decode_options());           (8) (since 1.4.0)

template <typename T,typename Alloc,typename TempAlloc>
read_result<T> try_decode_ubjson(const allocator_set<Alloc,TempAlloc>& aset,
    std::istream& is,
    const ubjson_decode_options& options = ubjson_decode_options());           (9) (since 1.4.0)

template <typename T,typename InputIt>
read_result<T> try_decode_ubjson(InputIt first, InputIt last,
    const bson_decode_options& options = bson_decode_options());               (10) (since 1.4.0)

(1) Reads UBJSON data from a contiguous byte sequence provided by source into a type T, using the specified (or defaulted) options. Type BytesViewLike 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 jsoncons reflection 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 jsoncons reflection traits.

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

(5) 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 jsoncons reflection traits.

(6)-(10) Non-throwing versions of (1)-(5)

Return value

(1)-(5) Deserialized value

(6)-(10) read_result

Exceptions

(1)-(5) Throw ser_error if read fails.

Any overload may throw std::bad_alloc if memory allocation fails.

See also

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