encode_ubjson.md

jsoncons::ubjson::encode_ubjson

Encodes a C++ data structure to the Universal Binary JSON Specification (UBJSON) data format.

#include <jsoncons_ext/ubjson/ubjson.hpp>

template<class T>
void encode_ubjson(const T& jval, std::vector<uint8_t>& v,
                   const ubjson_decode_options& options = ubjson_decode_options()); (1) (until v0.152.0)

template<class T, class Container>
void encode_ubjson(const T& jval, Container& v,
                   const ubjson_decode_options& options = ubjson_decode_options()); (1) (since v0.152.0)

template<class T>
void encode_ubjson(const T& jval, 
                   std::ostream& os,
                   const bson_decode_options& options = bson_decode_options()); (2)

(1) Writes a value of type T into a byte container in the UBJSON data format, using the specified (or defaulted) options. Type 'T' must be an instantiation of basic_json or support json_type_traits.
Type Container must be back insertable and have member type value_type with size exactly 8 bits (since v0.152.0.) Any of the values types int8_t, uint8_t, char, unsigned char and std::byte (since C++17) are allowed.

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

See also

decode_ubjson decodes a Binary JSON data format to a json value.