deserialization of CBOR, MessagePack, and UBJSON values More...
#include <json.hpp>
Public Member Functions | |
| binary_reader (binary_reader &&)=default | |
| binary_reader (const binary_reader &)=delete | |
| binary_reader (InputAdapterType &&adapter, const input_format_t format=input_format_t::json) noexcept | |
| create a binary reader More... | |
| binary_reader & | operator= (binary_reader &&)=default |
| binary_reader & | operator= (const binary_reader &)=delete |
| bool | sax_parse (const input_format_t format, json_sax_t *sax_, const bool strict=true, const cbor_tag_handler_t tag_handler=cbor_tag_handler_t::error) |
| ~binary_reader ()=default | |
Private Types | |
| using | binary_t = typename BasicJsonType::binary_t |
| using | bjd_type = std::pair< char_int_type, string_t > |
| using | char_int_type = typename char_traits< char_type >::int_type |
| using | char_type = typename InputAdapterType::char_type |
| using | json_sax_t = SAX |
| using | number_float_t = typename BasicJsonType::number_float_t |
| using | number_integer_t = typename BasicJsonType::number_integer_t |
| using | number_unsigned_t = typename BasicJsonType::number_unsigned_t |
| using | string_t = typename BasicJsonType::string_t |
Private Member Functions | |
| std::string | exception_message (const input_format_t format, const std::string &detail, const std::string &context) const |
| char_int_type | get () |
| get next character from the input More... | |
| template<typename NumberType > | |
| bool | get_binary (const input_format_t format, const NumberType len, binary_t &result) |
| create a byte array by reading bytes from the input More... | |
| template<typename NumberType > | |
| bool | get_bson_binary (const NumberType len, binary_t &result) |
| Parses a byte array input of length len from the BSON input. 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 | get_cbor_array (const std::size_t len, const cbor_tag_handler_t tag_handler) |
| bool | get_cbor_binary (binary_t &result) |
| reads a CBOR byte array More... | |
| bool | get_cbor_object (const std::size_t len, const cbor_tag_handler_t tag_handler) |
| bool | get_cbor_string (string_t &result) |
| reads a CBOR string More... | |
| char_int_type | get_ignore_noop () |
| bool | get_msgpack_array (const std::size_t len) |
| bool | get_msgpack_binary (binary_t &result) |
| reads a MessagePack byte array More... | |
| bool | get_msgpack_object (const std::size_t len) |
| bool | get_msgpack_string (string_t &result) |
| reads a MessagePack string More... | |
| 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... | |
| std::string | get_token_string () const |
| bool | get_ubjson_array () |
| bool | get_ubjson_high_precision_number () |
| bool | get_ubjson_ndarray_size (std::vector< size_t > &dim) |
| bool | get_ubjson_object () |
| bool | get_ubjson_size_type (std::pair< std::size_t, char_int_type > &result, bool inside_ndarray=false) |
| determine the type and size for a container More... | |
| bool | get_ubjson_size_value (std::size_t &result, bool &is_ndarray, char_int_type prefix=0) |
| bool | get_ubjson_string (string_t &result, const bool get_char=true) |
| reads a UBJSON string More... | |
| bool | get_ubjson_value (const char_int_type prefix) |
| bool | parse_bson_array () |
| Reads an array from the BSON input and passes it to the SAX-parser. More... | |
| bool | parse_bson_element_internal (const char_int_type 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_internal () |
| Reads in a BSON-object and passes it to the SAX-parser. More... | |
| bool | parse_cbor_internal (const bool get_char, const cbor_tag_handler_t tag_handler) |
| bool | parse_msgpack_internal () |
| bool | parse_ubjson_internal (const bool get_char=true) |
| bool | unexpect_eof (const input_format_t format, const char *context) const |
Private Attributes | |
| JSON_PRIVATE_UNLESS_TESTED | __pad0__: const decltype(JSON_BINARY_READER_MAKE_BJD_OPTIMIZED_TYPE_MARKERS_) bjd_optimized_type_markers = JSON_BINARY_READER_MAKE_BJD_OPTIMIZED_TYPE_MARKERS_ |
| const decltype(JSON_BINARY_READER_MAKE_BJD_TYPES_MAP_) | bjd_types_map |
| std::size_t | chars_read = 0 |
| the number of characters read More... | |
| char_int_type | current = char_traits<char_type>::eof() |
| the current character More... | |
| InputAdapterType | ia |
| input adapter More... | |
| const input_format_t | input_format = input_format_t::json |
| input format More... | |
| const bool | is_little_endian = little_endianness() |
| whether we can assume little endianness More... | |
| json_sax_t * | sax = nullptr |
| the SAX parser More... | |
Static Private Attributes | |
| static constexpr JSON_INLINE_VARIABLE std::size_t | npos = static_cast<std::size_t>(-1) |
deserialization of CBOR, MessagePack, and UBJSON values
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
inlineexplicitnoexcept |
|
delete |
|
default |
|
default |
|
inlineprivate |
| [in] | format | the current format |
| [in] | detail | a detailed error message |
| [in] | context | further context information |
|
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 char_traits<char_type>eof() in that case.
|
inlineprivate |
create a byte array by reading bytes from the input
| NumberType | the type of the number |
| [in] | format | the current format (for diagnostics) |
| [in] | len | number of bytes to read |
| [out] | result | byte array created by reading len bytes |
|
inlineprivate |
Parses a byte array input of length len from the BSON input.
| [in] | len | The length of the byte array to be read. |
| [in,out] | result | A reference to the binary variable where the read array is to be stored. |
| NumberType | The type of the length len |
true if the byte array was successfully parsed
|
inlineprivate |
Parses a C-style string from the BSON input.
| [in,out] | result | A reference to the string variable where the read string is to be stored. |
true if the \x00-byte indicating the end of the string was encountered before the EOF; false` indicates an unexpected EOF.
|
inlineprivate |
Parses a zero-terminated string of length len from the BSON input.
| [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. |
| NumberType | The type of the length len |
true if the string was successfully parsed
|
inlineprivate |
|
inlineprivate |
reads a CBOR byte array
This function first reads starting bytes to determine the expected byte array length and then copies this number of bytes into the byte array. Additionally, CBOR's byte arrays with indefinite lengths are supported.
| [out] | result | created byte array |
|
inlineprivate |
|
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.
| [out] | result | created string |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
reads a MessagePack byte array
This function first reads starting bytes to determine the expected byte array length and then copies this number of bytes into a byte array.
| [out] | result | created byte array |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
create a string by reading characters from the input
| NumberType | the type of the number |
| [in] | format | the current format (for diagnostics) |
| [in] | len | number of characters to read |
| [out] | result | string created by reading len bytes |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
|
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.
| [out] | result | pair of the size and the type |
| [in] | inside_ndarray | whether the parser is parsing an ND array dimensional vector |
|
inlineprivate |
| [out] | result | determined size |
| [in,out] | is_ndarray | for input, true means already inside an ndarray vector or ndarray dimension is not allowed; false means ndarray is allowed; for output, true means an ndarray is found; is_ndarray can only return true when its initial value is false |
| [in] | prefix | type marker if already read, otherwise set to 0 |
|
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.
| [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 |
|
inlineprivate |
|
default |
|
delete |
|
inlineprivate |
|
inlineprivate |
Read a BSON document element of the given element_type.
| [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. |
|
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).
| [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). |
|
inlineprivate |
|
inlineprivate |
| [in] | get_char | whether a new character should be retrieved from the input (true) or whether the last read character should be considered instead (false) |
| [in] | tag_handler | how CBOR tags should be treated |
|
inlineprivate |
|
inlineprivate |
|
inline |
|
inlineprivate |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
staticconstexprprivate |
|
private |