nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType > Class Template Reference

serialization to CBOR and MessagePack values More...

Collaboration diagram for nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >:

Public Member Functions
	binary_writer (output_adapter_t< CharType > adapter)
	create a binary writer
void	write_bson (const BasicJsonType &j)
void	write_cbor (const BasicJsonType &j)
void	write_msgpack (const BasicJsonType &j)
void	write_ubjson (const BasicJsonType &j, const bool use_count, const bool use_type, const bool add_prefix=true, const bool use_bjdata=false)

Static Public Member Functions
template<typename InputCharType , typename C = CharType, enable_if_t< std::is_signed< C >::value &&std::is_signed< char >::value &&std::is_same< char, typename std::remove_cv< InputCharType >::type >::value > * = nullptr>
static constexpr CharType	to_char_type (InputCharType x) noexcept
template<typename C = CharType, enable_if_t< std::is_signed< C >::value &&std::is_signed< char >::value > * = nullptr>
static constexpr CharType	to_char_type (std::uint8_t x) noexcept
template<typename C = CharType, enable_if_t< std::is_signed< C >::value &&std::is_unsigned< char >::value > * = nullptr>
static CharType	to_char_type (std::uint8_t x) noexcept
template<typename C = CharType, enable_if_t< std::is_unsigned< C >::value > * = nullptr>
static constexpr CharType	to_char_type (std::uint8_t x) noexcept

Private Types
using	binary_t = typename BasicJsonType::binary_t
using	number_float_t = typename BasicJsonType::number_float_t
using	string_t = typename BasicJsonType::string_t

Private Member Functions
CharType	ubjson_prefix (const BasicJsonType &j, const bool use_bjdata) const noexcept
	determine the type prefix of container values
bool	write_bjdata_ndarray (const typename BasicJsonType::object_t &value, const bool use_count, const bool use_type)
void	write_bson_array (const string_t &name, const typename BasicJsonType::array_t &value)
	Writes a BSON element with key name and array value.
void	write_bson_binary (const string_t &name, const binary_t &value)
	Writes a BSON element with key name and binary value value.
void	write_bson_boolean (const string_t &name, const bool value)
	Writes a BSON element with key name and boolean value value.
void	write_bson_double (const string_t &name, const double value)
	Writes a BSON element with key name and double value value.
void	write_bson_element (const string_t &name, const BasicJsonType &j)
	Serializes the JSON value j to BSON and associates it with the key name.
void	write_bson_entry_header (const string_t &name, const std::uint8_t element_type)
	Writes the given element_type and name to the output adapter.
void	write_bson_integer (const string_t &name, const std::int64_t value)
	Writes a BSON element with key name and integer value.
void	write_bson_null (const string_t &name)
	Writes a BSON element with key name and null value.
void	write_bson_object (const typename BasicJsonType::object_t &value)
void	write_bson_object_entry (const string_t &name, const typename BasicJsonType::object_t &value)
	Writes a BSON element with key name and object value.
void	write_bson_string (const string_t &name, const string_t &value)
	Writes a BSON element with key name and string value value.
void	write_bson_unsigned (const string_t &name, const BasicJsonType &j)
	Writes a BSON element with key name and unsigned value.
void	write_compact_float (const number_float_t n, detail::input_format_t format)
template<typename NumberType >
void	write_number (const NumberType n, const bool OutputIsLittleEndian=false)
template<typename NumberType , typename std::enable_if< std::is_floating_point< NumberType >::value, int >::type = 0>
void	write_number_with_ubjson_prefix (const NumberType n, const bool add_prefix, const bool use_bjdata)
template<typename NumberType , typename std::enable_if< std::is_unsigned< NumberType >::value, int >::type = 0>
void	write_number_with_ubjson_prefix (const NumberType n, const bool add_prefix, const bool use_bjdata)
template<typename NumberType , typename std::enable_if< std::is_signed< NumberType >::value &&!std::is_floating_point< NumberType >::value, int >::type = 0>
void	write_number_with_ubjson_prefix (const NumberType n, const bool add_prefix, const bool use_bjdata)

Static Private Member Functions
static std::size_t	calc_bson_array_size (const typename BasicJsonType::array_t &value)
static std::size_t	calc_bson_binary_size (const typename BasicJsonType::binary_t &value)
static std::size_t	calc_bson_element_size (const string_t &name, const BasicJsonType &j)
	Calculates the size necessary to serialize the JSON value j with its name.
static std::size_t	calc_bson_entry_header_size (const string_t &name, const BasicJsonType &j)
static std::size_t	calc_bson_integer_size (const std::int64_t value)
static std::size_t	calc_bson_object_size (const typename BasicJsonType::object_t &value)
	Calculates the size of the BSON serialization of the given JSON-object j.
static std::size_t	calc_bson_string_size (const string_t &value)
static constexpr std::size_t	calc_bson_unsigned_size (const std::uint64_t value) noexcept
static constexpr CharType	get_cbor_float_prefix (double)
static constexpr CharType	get_cbor_float_prefix (float)
static constexpr CharType	get_msgpack_float_prefix (double)
static constexpr CharType	get_msgpack_float_prefix (float)
static constexpr CharType	get_ubjson_float_prefix (double)
static constexpr CharType	get_ubjson_float_prefix (float)

Private Attributes
const bool	is_little_endian = little_endianness()
	whether we can assume little endianness
output_adapter_t< CharType >	oa = nullptr
	the output

Detailed Description

template<typename BasicJsonType, typename CharType>
class nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >

serialization to CBOR and MessagePack values

Definition at line 15078 of file json.hpp.

Member Typedef Documentation

binary_t

template<typename BasicJsonType , typename CharType >

using nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::binary_t = typename BasicJsonType::binary_t

private

Definition at line 15081 of file json.hpp.

number_float_t

template<typename BasicJsonType , typename CharType >

using nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::number_float_t = typename BasicJsonType::number_float_t

private

Definition at line 15082 of file json.hpp.

string_t

template<typename BasicJsonType , typename CharType >

using nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::string_t = typename BasicJsonType::string_t

private

Definition at line 15080 of file json.hpp.

Constructor & Destructor Documentation

binary_writer()

template<typename BasicJsonType , typename CharType >

nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::binary_writer ( output_adapter_t< CharType >  adapter )

inlineexplicit

create a binary writer

Parameters

[in]

adapter

output adapter to write to

Definition at line 15090 of file json.hpp.

References JSON_ASSERT.

Member Function Documentation

calc_bson_array_size()

template<typename BasicJsonType , typename CharType >

static std::size_t nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::calc_bson_array_size ( const typename BasicJsonType::array_t &  value )

inlinestaticprivate

Returns

The size of the BSON-encoded array value

Definition at line 16146 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

calc_bson_binary_size()

template<typename BasicJsonType , typename CharType >

static std::size_t nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::calc_bson_binary_size ( const typename BasicJsonType::binary_t &  value )

inlinestaticprivate

Returns

The size of the BSON-encoded binary array value

Definition at line 16161 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

calc_bson_element_size()

template<typename BasicJsonType , typename CharType >

static std::size_t nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::calc_bson_element_size ( const string_t &  name, const BasicJsonType &  j  )

inlinestaticprivate

Calculates the size necessary to serialize the JSON value j with its name.

Returns

The calculated size for the BSON document entry for j with the given name.

Definition at line 16203 of file json.hpp.

References JSON_ASSERT.

calc_bson_entry_header_size()

template<typename BasicJsonType , typename CharType >

static std::size_t nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::calc_bson_entry_header_size ( const string_t &  name, const BasicJsonType &  j  )

inlinestaticprivate

Returns

The size of a BSON document entry header, including the id marker and the entry name size (and its null-terminator).

Definition at line 15999 of file json.hpp.

References JSON_HEDLEY_UNLIKELY, and JSON_THROW.

calc_bson_integer_size()

template<typename BasicJsonType , typename CharType >

static std::size_t nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::calc_bson_integer_size ( const std::int64_t  value )

inlinestaticprivate

Returns

The size of the BSON-encoded integer value

Definition at line 16076 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

calc_bson_object_size()

template<typename BasicJsonType , typename CharType >

static std::size_t nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::calc_bson_object_size ( const typename BasicJsonType::object_t &  value )

inlinestaticprivate

Calculates the size of the BSON serialization of the given JSON-object j.

Parameters

[in]

value

JSON value to serialize

Precondition

value.type() == value_t::object

Definition at line 16298 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

calc_bson_string_size()

template<typename BasicJsonType , typename CharType >

static std::size_t nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::calc_bson_string_size ( const string_t &  value )

inlinestaticprivate

Returns

The size of the BSON-encoded string in value

Definition at line 16046 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

calc_bson_unsigned_size()

template<typename BasicJsonType , typename CharType >

static constexpr std::size_t nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::calc_bson_unsigned_size ( const std::uint64_t  value )

inlinestaticconstexprprivatenoexcept

Returns

The size of the BSON-encoded unsigned integer in j

Definition at line 16104 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

get_cbor_float_prefix() [1/2]

template<typename BasicJsonType , typename CharType >

static constexpr CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::get_cbor_float_prefix ( double  )

inlinestaticconstexprprivate

Definition at line 16334 of file json.hpp.

get_cbor_float_prefix() [2/2]

template<typename BasicJsonType , typename CharType >

static constexpr CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::get_cbor_float_prefix ( float  )

inlinestaticconstexprprivate

Definition at line 16329 of file json.hpp.

get_msgpack_float_prefix() [1/2]

template<typename BasicJsonType , typename CharType >

static constexpr CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::get_msgpack_float_prefix ( double  )

inlinestaticconstexprprivate

Definition at line 16348 of file json.hpp.

get_msgpack_float_prefix() [2/2]

template<typename BasicJsonType , typename CharType >

static constexpr CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::get_msgpack_float_prefix ( float  )

inlinestaticconstexprprivate

Definition at line 16343 of file json.hpp.

get_ubjson_float_prefix() [1/2]

template<typename BasicJsonType , typename CharType >

static constexpr CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::get_ubjson_float_prefix ( double  )

inlinestaticconstexprprivate

Definition at line 16649 of file json.hpp.

get_ubjson_float_prefix() [2/2]

template<typename BasicJsonType , typename CharType >

static constexpr CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::get_ubjson_float_prefix ( float  )

inlinestaticconstexprprivate

Definition at line 16644 of file json.hpp.

to_char_type() [1/4]

template<typename BasicJsonType , typename CharType >

template<typename InputCharType , typename C = CharType, enable_if_t< std::is_signed< C >::value &&std::is_signed< char >::value &&std::is_same< char, typename std::remove_cv< InputCharType >::type >::value > * = nullptr>

static constexpr CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::to_char_type ( InputCharType  x )

inlinestaticconstexprnoexcept

Definition at line 16863 of file json.hpp.

to_char_type() [2/4]

template<typename BasicJsonType , typename CharType >

template<typename C = CharType, enable_if_t< std::is_signed< C >::value &&std::is_signed< char >::value > * = nullptr>

static constexpr CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::to_char_type ( std::uint8_t  x )

inlinestaticconstexprnoexcept

Definition at line 16834 of file json.hpp.

to_char_type() [3/4]

template<typename BasicJsonType , typename CharType >

template<typename C = CharType, enable_if_t< std::is_signed< C >::value &&std::is_unsigned< char >::value > * = nullptr>

static CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::to_char_type ( std::uint8_t  x )

inlinestaticnoexcept

Definition at line 16841 of file json.hpp.

to_char_type() [4/4]

template<typename BasicJsonType , typename CharType >

template<typename C = CharType, enable_if_t< std::is_unsigned< C >::value > * = nullptr>

static constexpr CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::to_char_type ( std::uint8_t  x )

inlinestaticconstexprnoexcept

Definition at line 16852 of file json.hpp.

ubjson_prefix()

template<typename BasicJsonType , typename CharType >

CharType nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::ubjson_prefix ( const BasicJsonType &  j, const bool  use_bjdata  ) const

inlineprivatenoexcept

determine the type prefix of container values

Definition at line 16543 of file json.hpp.

write_bjdata_ndarray()

template<typename BasicJsonType , typename CharType >

bool nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bjdata_ndarray ( const typename BasicJsonType::object_t &  value, const bool  use_count, const bool  use_type  )

inlineprivate

Returns

false if the object is successfully converted to a bjdata ndarray, true if the type or size is invalid

Definition at line 16657 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::key, and nlohmann::json_abi_v3_11_3::detail::value.

write_bson()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson ( const BasicJsonType &  j )

inline

Parameters

[in]

j

JSON value to serialize

Precondition

j.type() == value_t::object

Definition at line 15099 of file json.hpp.

References JSON_THROW.

write_bson_array()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_array ( const string_t &  name, const typename BasicJsonType::array_t &  value  )

inlineprivate

Writes a BSON element with key name and array value.

Definition at line 16169 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

write_bson_binary()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_binary ( const string_t &  name, const binary_t &  value  )

inlineprivate

Writes a BSON element with key name and binary value value.

Definition at line 16188 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

write_bson_boolean()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_boolean ( const string_t &  name, const bool  value  )

inlineprivate

Writes a BSON element with key name and boolean value value.

Definition at line 16026 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

write_bson_double()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_double ( const string_t &  name, const double  value  )

inlineprivate

Writes a BSON element with key name and double value value.

Definition at line 16036 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

write_bson_element()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_element ( const string_t &  name, const BasicJsonType &  j  )

inlineprivate

Serializes the JSON value j to BSON and associates it with the key name.

Parameters

name	The name to associate with the JSON entity j within the current BSON document

Definition at line 16251 of file json.hpp.

References JSON_ASSERT.

write_bson_entry_header()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_entry_header ( const string_t &  name, const std::uint8_t  element_type  )

inlineprivate

Writes the given element_type and name to the output adapter.

Definition at line 16014 of file json.hpp.

write_bson_integer()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_integer ( const string_t &  name, const std::int64_t  value  )

inlineprivate

Writes a BSON element with key name and integer value.

Definition at line 16086 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

write_bson_null()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_null ( const string_t &  name )

inlineprivate

Writes a BSON element with key name and null value.

Definition at line 16068 of file json.hpp.

write_bson_object()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_object ( const typename BasicJsonType::object_t &  value )

inlineprivate

Parameters

[in]

value

JSON value to serialize

Precondition

value.type() == value_t::object

Definition at line 16313 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

write_bson_object_entry()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_object_entry ( const string_t &  name, const typename BasicJsonType::object_t &  value  )

inlineprivate

Writes a BSON element with key name and object value.

Definition at line 16136 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

write_bson_string()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_string ( const string_t &  name, const string_t &  value  )

inlineprivate

Writes a BSON element with key name and string value value.

Definition at line 16054 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::value.

write_bson_unsigned()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_bson_unsigned ( const string_t &  name, const BasicJsonType &  j  )

inlineprivate

Writes a BSON element with key name and unsigned value.

Definition at line 16114 of file json.hpp.

References JSON_THROW.

write_cbor()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_cbor ( const BasicJsonType &  j )

inline

Parameters

[in]

j

JSON value to serialize

Definition at line 15128 of file json.hpp.

write_compact_float()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_compact_float ( const number_float_t  n, detail::input_format_t  format  )

inlineprivate

Definition at line 16800 of file json.hpp.

write_msgpack()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_msgpack ( const BasicJsonType &  j )

inline

Parameters

[in]

j

JSON value to serialize

Definition at line 15452 of file json.hpp.

write_number()

template<typename BasicJsonType , typename CharType >

template<typename NumberType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_number ( const NumberType  n, const bool  OutputIsLittleEndian = false  )

inlineprivate

Definition at line 16784 of file json.hpp.

write_number_with_ubjson_prefix() [1/3]

template<typename BasicJsonType , typename CharType >

template<typename NumberType , typename std::enable_if< std::is_floating_point< NumberType >::value, int >::type = 0>

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_number_with_ubjson_prefix ( const NumberType  n, const bool  add_prefix, const bool  use_bjdata  )

inlineprivate

Definition at line 16360 of file json.hpp.

write_number_with_ubjson_prefix() [2/3]

template<typename BasicJsonType , typename CharType >

template<typename NumberType , typename std::enable_if< std::is_unsigned< NumberType >::value, int >::type = 0>

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_number_with_ubjson_prefix ( const NumberType  n, const bool  add_prefix, const bool  use_bjdata  )

inlineprivate

Definition at line 16374 of file json.hpp.

write_number_with_ubjson_prefix() [3/3]

template<typename BasicJsonType , typename CharType >

template<typename NumberType , typename std::enable_if< std::is_signed< NumberType >::value &&!std::is_floating_point< NumberType >::value, int >::type = 0>

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_number_with_ubjson_prefix ( const NumberType  n, const bool  add_prefix, const bool  use_bjdata  )

inlineprivate

Definition at line 16462 of file json.hpp.

write_ubjson()

template<typename BasicJsonType , typename CharType >

void nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::write_ubjson ( const BasicJsonType &  j, const bool  use_count, const bool  use_type, const bool  add_prefix = true, const bool  use_bjdata = false  )

inline

Parameters

[in]	j	JSON value to serialize
[in]	use_count	whether to use '#' prefixes (optimized format)
[in]	use_type	whether to use '$' prefixes (optimized format)
[in]	add_prefix	whether prefixes need to be used for this value
[in]	use_bjdata	whether write in BJData format, default is false

Definition at line 15778 of file json.hpp.

References JSON_ASSERT.

Member Data Documentation

is_little_endian

template<typename BasicJsonType , typename CharType >

const bool nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::is_little_endian = little_endianness()

private

whether we can assume little endianness

Definition at line 16870 of file json.hpp.

oa

template<typename BasicJsonType , typename CharType >

output_adapter_t<CharType> nlohmann::json_abi_v3_11_3::detail::binary_writer< BasicJsonType, CharType >::oa = nullptr

private

the output

Definition at line 16873 of file json.hpp.

---

The documentation for this class was generated from the following file:

• json.hpp