deserialization of CBOR, MessagePack, and UBJSON values More...

#include <json.hpp>

Public Member Functions
	binary_reader (input_adapter_t adapter)
	create a binary reader More...

	binary_reader (const binary_reader &)=delete

	binary_reader (binary_reader &&)=default

binary_reader &	operator= (const binary_reader &)=delete

binary_reader &	operator= (binary_reader &&)=default

	~binary_reader ()=default

bool	sax_parse (const input_format_t format, json_sax_t *sax_, const bool strict=true)

Static Public Member Functions
static constexpr bool	little_endianess (int num=1) noexcept
	determine system byte order More...

Private Types
using	number_integer_t = typename BasicJsonType::number_integer_t

using	number_unsigned_t = typename BasicJsonType::number_unsigned_t

using	number_float_t = typename BasicJsonType::number_float_t

using	string_t = typename BasicJsonType::string_t

using	json_sax_t = SAX

Private Member Functions
bool	parse_bson_internal ()
	Reads in a BSON-object and passes it to the SAX-parser. More...

bool	get_bson_cstr (string_t &result)
	Parses a C-style string from the BSON input. More...

template<typename NumberType >
bool	get_bson_string (const NumberType len, string_t &result)
	Parses a zero-terminated string of length len from the BSON input. More...

bool	parse_bson_element_internal (const int element_type, const std::size_t element_type_parse_position)
	Read a BSON document element of the given element_type. More...

bool	parse_bson_element_list (const bool is_array)
	Read a BSON element list (as specified in the BSON-spec) More...

bool	parse_bson_array ()
	Reads an array from the BSON input and passes it to the SAX-parser. More...

bool	parse_cbor_internal (const bool get_char=true)

bool	get_cbor_string (string_t &result)
	reads a CBOR string More...

bool	get_cbor_array (const std::size_t len)

bool	get_cbor_object (const std::size_t len)

bool	parse_msgpack_internal ()

bool	get_msgpack_string (string_t &result)
	reads a MessagePack string More...

bool	get_msgpack_array (const std::size_t len)

bool	get_msgpack_object (const std::size_t len)

bool	parse_ubjson_internal (const bool get_char=true)

bool	get_ubjson_string (string_t &result, const bool get_char=true)
	reads a UBJSON string More...

bool	get_ubjson_size_value (std::size_t &result)

bool	get_ubjson_size_type (std::pair< std::size_t, int > &result)
	determine the type and size for a container More...

bool	get_ubjson_value (const int prefix)

bool	get_ubjson_array ()

bool	get_ubjson_object ()

int	get ()
	get next character from the input More...

int	get_ignore_noop ()

template<typename NumberType , bool InputIsLittleEndian = false>
bool	get_number (const input_format_t format, NumberType &result)

template<typename NumberType >
bool	get_string (const input_format_t format, const NumberType len, string_t &result)
	create a string by reading characters from the input More...

bool	unexpect_eof (const input_format_t format, const char *context) const

std::string	get_token_string () const

std::string	exception_message (const input_format_t format, const std::string &detail, const std::string &context) const

Private Attributes
input_adapter_t	ia = nullptr
	input adapter More...

int	current = std::char_traits<char>::eof()
	the current character More...

std::size_t	chars_read = 0
	the number of characters read More...

const bool	is_little_endian = little_endianess()
	whether we can assume little endianess More...

json_sax_t *	sax = nullptr
	the SAX parser More...

Detailed Description

template<typename BasicJsonType, typename SAX = json_sax_dom_parser<BasicJsonType>>
class nlohmann::detail::binary_reader< BasicJsonType, SAX >

deserialization of CBOR, MessagePack, and UBJSON values

Definition at line 3543 of file json.hpp.

Member Typedef Documentation

◆ json_sax_t

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

using nlohmann::detail::binary_reader< BasicJsonType, SAX >::json_sax_t = SAX

private

Definition at line 3549 of file json.hpp.

◆ number_float_t

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

using nlohmann::detail::binary_reader< BasicJsonType, SAX >::number_float_t = typename BasicJsonType::number_float_t

private

Definition at line 3547 of file json.hpp.

◆ number_integer_t

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

using nlohmann::detail::binary_reader< BasicJsonType, SAX >::number_integer_t = typename BasicJsonType::number_integer_t

private

Definition at line 3545 of file json.hpp.

◆ number_unsigned_t

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

using nlohmann::detail::binary_reader< BasicJsonType, SAX >::number_unsigned_t = typename BasicJsonType::number_unsigned_t

private

Definition at line 3546 of file json.hpp.

◆ string_t

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

using nlohmann::detail::binary_reader< BasicJsonType, SAX >::string_t = typename BasicJsonType::string_t

private

Definition at line 3548 of file json.hpp.

Constructor & Destructor Documentation

◆ binary_reader() [1/3]

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

nlohmann::detail::binary_reader< BasicJsonType, SAX >::binary_reader ( input_adapter_t adapter )

inlineexplicit

create a binary reader

Parameters

[in] adapter input adapter to read from

Definition at line 3557 of file json.hpp.

◆ binary_reader() [2/3]

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

nlohmann::detail::binary_reader< BasicJsonType, SAX >::binary_reader ( const binary_reader< BasicJsonType, SAX > & )

delete

◆ binary_reader() [3/3]

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

nlohmann::detail::binary_reader< BasicJsonType, SAX >::binary_reader ( binary_reader< BasicJsonType, SAX > && )

default

◆ ~binary_reader()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

nlohmann::detail::binary_reader< BasicJsonType, SAX >::~binary_reader ( )

default

Member Function Documentation

◆ exception_message()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

std::string nlohmann::detail::binary_reader< BasicJsonType, SAX >::exception_message	(	const input_format_t	format,
		const std::string &	detail,
		const std::string &	context
	)		const

inlineprivate

Parameters

[in]	format	the current format
[in]	detail	a detailed error message
[in]	context	further contect information

Returns: a message string to use in the parse_error exceptions

Definition at line 5446 of file json.hpp.

◆ get()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

int nlohmann::detail::binary_reader< BasicJsonType, SAX >::get ( )

inlineprivate

get next character from the input

This function provides the interface to the used input adapter. It does not throw in case the input reached EOF, but returns a -'ve valued std::char_traits<char>::eof() in that case.

Returns: character read from the input

Definition at line 5321 of file json.hpp.

◆ get_bson_cstr()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_bson_cstr ( string_t & result )

inlineprivate

Parses a C-style string from the BSON input.

Parameters

[in,out] result A reference to the string variable where the read string is to be stored.

Returns: true if the \x00-byte indicating the end of the string was encountered before the EOF; false` indicates an unexpected EOF.

Definition at line 3674 of file json.hpp.

◆ get_bson_string()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

template<typename NumberType >

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_bson_string	(	const NumberType	len,
		string_t &	result
	)

inlineprivate

Parses a zero-terminated string of length len from the BSON input.

Parameters

[in]	len	The length (including the zero-byte at the end) of the string to be read.
[in,out]	result	A reference to the string variable where the read string is to be stored.

Template Parameters

NumberType The type of the length len

Precondition: len >= 1

Returns: true if the string was successfully parsed

Definition at line 3706 of file json.hpp.

◆ get_cbor_array()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_cbor_array ( const std::size_t len )

inlineprivate

Parameters

[in] len the length of the array or std::size_t(-1) for an array of indefinite size

Returns: whether array creation completed

Definition at line 4295 of file json.hpp.

◆ get_cbor_object()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_cbor_object ( const std::size_t len )

inlineprivate

Parameters

[in] len the length of the object or std::size_t(-1) for an object of indefinite size

Returns: whether object creation completed

Definition at line 4331 of file json.hpp.

◆ get_cbor_string()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_cbor_string ( string_t & result )

inlineprivate

reads a CBOR string

This function first reads starting bytes to determine the expected string length and then copies this number of bytes into a string. Additionally, CBOR's strings with indefinite lengths are supported.

Parameters

[out] result created string

Returns: whether string creation completed

Definition at line 4206 of file json.hpp.

◆ get_ignore_noop()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

int nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_ignore_noop ( )

inlineprivate

Returns: character read from the input after ignoring all 'N' entries

Definition at line 5330 of file json.hpp.

◆ get_msgpack_array()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_msgpack_array ( const std::size_t len )

inlineprivate

Parameters

[in] len the length of the array

Returns: whether array creation completed

Definition at line 4828 of file json.hpp.

◆ get_msgpack_object()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_msgpack_object ( const std::size_t len )

inlineprivate

Parameters

[in] len the length of the object

Returns: whether object creation completed

Definition at line 4850 of file json.hpp.

◆ get_msgpack_string()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_msgpack_string ( string_t & result )

inlineprivate

reads a MessagePack string

This function first reads starting bytes to determine the expected string length and then copies this number of bytes into a string.

Parameters

[out] result created string

Returns: whether string creation completed

Definition at line 4752 of file json.hpp.

◆ get_number()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

template<typename NumberType , bool InputIsLittleEndian = false>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_number	(	const input_format_t	format,
		NumberType &	result
	)

inlineprivate

Definition at line 5355 of file json.hpp.

◆ get_string()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

template<typename NumberType >

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_string	(	const input_format_t	format,
		const NumberType	len,
		string_t &	result
	)

inlineprivate

create a string by reading characters from the input

Template Parameters

NumberType the type of the number

Parameters

[in]	format	the current format (for diagnostics)
[in]	len	number of characters to read
[out]	result	string created by reading len bytes

Returns: whether string creation completed

Note: We can not reserve len bytes for the result, because len may be too large. Usually, unexpect_eof() detects the end of the input before we run out of string memory.

Definition at line 5398 of file json.hpp.

◆ get_token_string()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

std::string nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_token_string ( ) const

inlineprivate

Returns: a string representation of the last read byte

Definition at line 5433 of file json.hpp.

◆ get_ubjson_array()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_ubjson_array ( )

inlineprivate

Returns: whether array creation completed

Definition at line 5174 of file json.hpp.

◆ get_ubjson_object()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_ubjson_object ( )

inlineprivate

Returns: whether object creation completed

Definition at line 5236 of file json.hpp.

◆ get_ubjson_size_type()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_ubjson_size_type ( std::pair< std::size_t, int > & result )

inlineprivate

determine the type and size for a container

In the optimized UBJSON format, a type and a size can be provided to allow for a more compact representation.

Parameters

[out] result pair of the size and the type

Returns: whether pair creation completed

Definition at line 5037 of file json.hpp.

◆ get_ubjson_size_value()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_ubjson_size_value ( std::size_t & result )

inlineprivate

Parameters

[out] result determined size

Returns: whether size determination completed

Definition at line 4960 of file json.hpp.

◆ get_ubjson_string()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_ubjson_string	(	string_t &	result,
		const bool	get_char = `true`
	)

inlineprivate

reads a UBJSON string

This function is either called after reading the 'S' byte explicitly indicating a string, or in case of an object key where the 'S' byte can be left out.

Parameters

[out]	result	created string
[in]	get_char	whether a new character should be retrieved from the input (true, default) or whether the last read character should be considered instead

Returns: whether string creation completed

Definition at line 4906 of file json.hpp.

◆ get_ubjson_value()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::get_ubjson_value ( const int prefix )

inlineprivate

Parameters

prefix the previously read or set type prefix

Returns: whether value creation completed

Definition at line 5078 of file json.hpp.

◆ little_endianess()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

static constexpr bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::little_endianess ( int num = 1 )

inlinestaticconstexprnoexcept

determine system byte order

Returns: true if and only if system's byte order is little endian

Note: from http://stackoverflow.com/a/1001328/266378

Definition at line 3635 of file json.hpp.

◆ operator=() [1/2]

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

binary_reader & nlohmann::detail::binary_reader< BasicJsonType, SAX >::operator= ( binary_reader< BasicJsonType, SAX > && )

default

◆ operator=() [2/2]

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

binary_reader & nlohmann::detail::binary_reader< BasicJsonType, SAX >::operator= ( const binary_reader< BasicJsonType, SAX > & )

delete

◆ parse_bson_array()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::parse_bson_array ( )

inlineprivate

Reads an array from the BSON input and passes it to the SAX-parser.

Returns: whether a valid BSON-array was passed to the SAX parser

Definition at line 3835 of file json.hpp.

◆ parse_bson_element_internal()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::parse_bson_element_internal	(	const int	element_type,
		const std::size_t	element_type_parse_position
	)

inlineprivate

Read a BSON document element of the given element_type.

Parameters

[in]	element_type	The BSON element type, c.f. http://bsonspec.org/spec.html
[in]	element_type_parse_position	The position in the input stream, where the `element_type` was read.

Warning: Not all BSON element types are supported yet. An unsupported element_type will give rise to a parse_error.114: Unsupported BSON record type 0x...

Returns: whether a valid BSON-object/array was passed to the SAX parser

Definition at line 3727 of file json.hpp.

◆ parse_bson_element_list()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::parse_bson_element_list ( const bool is_array )

inlineprivate

Read a BSON element list (as specified in the BSON-spec)

The same binary layout is used for objects and arrays, hence it must be indicated with the argument is_array which one is expected (true --> array, false --> object).

Parameters

[in] is_array Determines if the element list being read is to be treated as an object (is_array == false), or as an array (is_array == true).

Returns: whether a valid BSON-object/array was passed to the SAX parser

Definition at line 3798 of file json.hpp.

◆ parse_bson_internal()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::parse_bson_internal ( )

inlineprivate

Reads in a BSON-object and passes it to the SAX-parser.

Returns: whether a valid BSON-value was passed to the SAX parser

Definition at line 3649 of file json.hpp.

◆ parse_cbor_internal()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::parse_cbor_internal ( const bool get_char = true )

inlineprivate

Parameters

[in] get_char whether a new character should be retrieved from the input (true, default) or whether the last read character should be considered instead

Returns: whether a valid CBOR value was passed to the SAX parser

Definition at line 3864 of file json.hpp.

◆ parse_msgpack_internal()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::parse_msgpack_internal ( )

inlineprivate

Returns: whether a valid MessagePack value was passed to the SAX parser

Definition at line 4383 of file json.hpp.

◆ parse_ubjson_internal()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::parse_ubjson_internal ( const bool get_char = true )

inlineprivate

Parameters

[in] get_char whether a new character should be retrieved from the input (true, default) or whether the last read character should be considered instead

Returns: whether a valid UBJSON value was passed to the SAX parser

Definition at line 4887 of file json.hpp.

◆ sax_parse()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::sax_parse	(	const input_format_t	format,
		json_sax_t *	sax_,
		const bool	strict = `true`
	)

inline

Parameters

[in]	format	the binary format to parse
[in]	sax_	a SAX event processor
[in]	strict	whether to expect the input to be consumed completed

Returns

Definition at line 3577 of file json.hpp.

◆ unexpect_eof()

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::unexpect_eof	(	const input_format_t	format,
		const char *	context
	)		const

inlineprivate

Parameters

[in]	format	the current format (for diagnostics)
[in]	context	further context information (for diagnostics)

Returns: whether the last read character is not EOF

Definition at line 5420 of file json.hpp.

Member Data Documentation

◆ chars_read

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

std::size_t nlohmann::detail::binary_reader< BasicJsonType, SAX >::chars_read = 0

private

the number of characters read

Definition at line 5485 of file json.hpp.

◆ current

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

int nlohmann::detail::binary_reader< BasicJsonType, SAX >::current = std::char_traits<char>::eof()

private

the current character

Definition at line 5482 of file json.hpp.

◆ ia

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

input_adapter_t nlohmann::detail::binary_reader< BasicJsonType, SAX >::ia = nullptr

private

input adapter

Definition at line 5479 of file json.hpp.

◆ is_little_endian

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

const bool nlohmann::detail::binary_reader< BasicJsonType, SAX >::is_little_endian = little_endianess()

private

whether we can assume little endianess

Definition at line 5488 of file json.hpp.

◆ sax

template<typename BasicJsonType , typename SAX = json_sax_dom_parser<BasicJsonType>>

json_sax_t* nlohmann::detail::binary_reader< BasicJsonType, SAX >::sax = nullptr

private

the SAX parser

Definition at line 5491 of file json.hpp.

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

external/MecaCell/mecacell/utilities/json.hpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ json_sax_t

◆ number_float_t

◆ number_integer_t

◆ number_unsigned_t

◆ string_t

Constructor & Destructor Documentation

◆ binary_reader() [1/3]

◆ binary_reader() [2/3]

◆ binary_reader() [3/3]

◆ ~binary_reader()

Member Function Documentation

◆ exception_message()

◆ get()

◆ get_bson_cstr()

◆ get_bson_string()

◆ get_cbor_array()

◆ get_cbor_object()

◆ get_cbor_string()

◆ get_ignore_noop()

◆ get_msgpack_array()

◆ get_msgpack_object()

◆ get_msgpack_string()

◆ get_number()

◆ get_string()

◆ get_token_string()

◆ get_ubjson_array()

◆ get_ubjson_object()

◆ get_ubjson_size_type()

◆ get_ubjson_size_value()

◆ get_ubjson_string()

◆ get_ubjson_value()

◆ little_endianess()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parse_bson_array()

◆ parse_bson_element_internal()

◆ parse_bson_element_list()

◆ parse_bson_internal()

◆ parse_cbor_internal()

◆ parse_msgpack_internal()

◆ parse_ubjson_internal()

◆ sax_parse()

◆ unexpect_eof()

Member Data Documentation

◆ chars_read

◆ current

◆ ia

◆ is_little_endian

◆ sax