nlohmann::detail::json_sax_dom_parser< BasicJsonType > Class Template Reference

SAX implementation to create a JSON value from SAX events. More...

`#include <json.hpp>`

## Public 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 | 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 | binary_t = typename BasicJsonType::binary_t

## Public Member Functions

| json_sax_dom_parser (BasicJsonType &r, const bool allow_exceptions_=true)
| json_sax_dom_parser (const json_sax_dom_parser &)=delete
| json_sax_dom_parser (json_sax_dom_parser &&)=default
json_sax_dom_parser & | operator= (const json_sax_dom_parser &)=delete
json_sax_dom_parser & | operator= (json_sax_dom_parser &&)=default
| ~json_sax_dom_parser ()=default
bool | null ()
bool | boolean (bool val)
bool | number_integer (number_integer_t val)
bool | number_unsigned (number_unsigned_t val)
bool | number_float (number_float_t val, const string_t &)
bool | string (string_t &val)
bool | start_object (std::size_t len)
bool | key (string_t &val)
bool | end_object ()
bool | start_array (std::size_t len)
bool | end_array ()
bool | parse_error (std::size_t, const std::string &, const detail::exception &ex)
constexpr bool | is_errored () const
| json_sax_dom_parser (BasicJsonType &r, const bool allow_exceptions_=true)
| json_sax_dom_parser (const json_sax_dom_parser &)=delete
| json_sax_dom_parser (json_sax_dom_parser &&)=default
json_sax_dom_parser & | operator= (const json_sax_dom_parser &)=delete
json_sax_dom_parser & | operator= (json_sax_dom_parser &&)=default
| ~json_sax_dom_parser ()=default
bool | null ()
bool | boolean (bool val)
bool | number_integer (number_integer_t val)
bool | number_unsigned (number_unsigned_t val)
bool | number_float (number_float_t val, const string_t &)
bool | string (string_t &val)
bool | binary (binary_t &val)
bool | start_object (std::size_t len)
bool | key (string_t &val)
bool | end_object ()
bool | start_array (std::size_t len)
bool | end_array ()
template<class Exception >
bool | parse_error (std::size_t, const std::string &, const Exception &ex)
constexpr bool | is_errored () const

## Detailed Description

### template<typename BasicJsonType>
class nlohmann::detail::json_sax_dom_parser< BasicJsonType >

SAX implementation to create a JSON value from SAX events.

This class implements the json_sax interface and processes the SAX events to create a JSON value which makes it basically a DOM parser. The structure or hierarchy of the JSON value is managed by the stack `ref_stack` which contains a pointer to the respective array or object for each recursion depth.

After successful parsing, the value that is passed by reference to the constructor contains the parsed value.

Template Parameters

  BasicJsonType | the JSON type

## Member Typedef Documentation

## binary_t

template<typename BasicJsonType >

using nlohmann::detail::json_sax_dom_parser< BasicJsonType >::binary_t = typename BasicJsonType::binary_t

## number_float_t [1/2]

template<typename BasicJsonType >

using nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_float_t = typename BasicJsonType::number_float_t

## number_float_t [2/2]

template<typename BasicJsonType >

using nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_float_t = typename BasicJsonType::number_float_t

## number_integer_t [1/2]

template<typename BasicJsonType >

using nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_integer_t = typename BasicJsonType::number_integer_t

## number_integer_t [2/2]

template<typename BasicJsonType >

using nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_integer_t = typename BasicJsonType::number_integer_t

## number_unsigned_t [1/2]

template<typename BasicJsonType >

using nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_unsigned_t = typename BasicJsonType::number_unsigned_t

## number_unsigned_t [2/2]

template<typename BasicJsonType >

using nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_unsigned_t = typename BasicJsonType::number_unsigned_t

## string_t [1/2]

template<typename BasicJsonType >

using nlohmann::detail::json_sax_dom_parser< BasicJsonType >::string_t = typename BasicJsonType::string_t

## string_t [2/2]

template<typename BasicJsonType >

using nlohmann::detail::json_sax_dom_parser< BasicJsonType >::string_t = typename BasicJsonType::string_t

## Constructor & Destructor Documentation

## json_sax_dom_parser() [1/6]

template<typename BasicJsonType >

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser | ( | BasicJsonType & | r,
|  | const bool | allow_exceptions_ = `true`
| ) |  |

inlineexplicit

Parameters

  [in,out] | r | reference to a JSON value that is manipulated while parsing
  [in] | allow_exceptions_ | whether parse errors yield exceptions

## json_sax_dom_parser() [2/6]

template<typename BasicJsonType >

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser | ( | const json_sax_dom_parser< BasicJsonType > & |  | ) |

delete

## json_sax_dom_parser() [3/6]

template<typename BasicJsonType >

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser | ( | json_sax_dom_parser< BasicJsonType > && |  | ) |

default

## ~json_sax_dom_parser() [1/2]

template<typename BasicJsonType >

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::~json_sax_dom_parser | ( |  | ) |

default

## json_sax_dom_parser() [4/6]

template<typename BasicJsonType >

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser | ( | BasicJsonType & | r,
|  | const bool | allow_exceptions_ = `true`
| ) |  |

inlineexplicit

Parameters

  [in,out] | r | reference to a JSON value that is manipulated while parsing
  [in] | allow_exceptions_ | whether parse errors yield exceptions

## json_sax_dom_parser() [5/6]

template<typename BasicJsonType >

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser | ( | const json_sax_dom_parser< BasicJsonType > & |  | ) |

delete

## json_sax_dom_parser() [6/6]

template<typename BasicJsonType >

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser | ( | json_sax_dom_parser< BasicJsonType > && |  | ) |

default

## ~json_sax_dom_parser() [2/2]

template<typename BasicJsonType >

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::~json_sax_dom_parser | ( |  | ) |

default

## Member Function Documentation

## binary()

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::binary | ( | binary_t & | val | ) |

inline

## boolean() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::boolean | ( | bool | val | ) |

inline

## boolean() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::boolean | ( | bool | val | ) |

inline

## end_array() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::end_array | ( |  | ) |

inline

## end_array() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::end_array | ( |  | ) |

inline

## end_object() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::end_object | ( |  | ) |

inline

## end_object() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::end_object | ( |  | ) |

inline

## is_errored() [1/2]

template<typename BasicJsonType >

constexpr bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::is_errored | ( |  | ) | const

inlineconstexpr

## is_errored() [2/2]

template<typename BasicJsonType >

constexpr bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::is_errored | ( |  | ) | const

inlineconstexpr

## key() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::key | ( | string_t & | val | ) |

inline

## key() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::key | ( | string_t & | val | ) |

inline

## null() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::null | ( |  | ) |

inline

## null() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::null | ( |  | ) |

inline

## number_float() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_float | ( | number_float_t | val,
|  | const string_t & |
| ) |  |

inline

## number_float() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_float | ( | number_float_t | val,
|  | const string_t & |
| ) |  |

inline

## number_integer() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_integer | ( | number_integer_t | val | ) |

inline

## number_integer() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_integer | ( | number_integer_t | val | ) |

inline

## number_unsigned() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_unsigned | ( | number_unsigned_t | val | ) |

inline

## number_unsigned() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_unsigned | ( | number_unsigned_t | val | ) |

inline

## operator=() [1/4]

template<typename BasicJsonType >

json_sax_dom_parser& nlohmann::detail::json_sax_dom_parser< BasicJsonType >::operator= | ( | const json_sax_dom_parser< BasicJsonType > & |  | ) |

delete

## operator=() [2/4]

template<typename BasicJsonType >

json_sax_dom_parser& nlohmann::detail::json_sax_dom_parser< BasicJsonType >::operator= | ( | const json_sax_dom_parser< BasicJsonType > & |  | ) |

delete

## operator=() [3/4]

template<typename BasicJsonType >

json_sax_dom_parser& nlohmann::detail::json_sax_dom_parser< BasicJsonType >::operator= | ( | json_sax_dom_parser< BasicJsonType > && |  | ) |

default

## operator=() [4/4]

template<typename BasicJsonType >

json_sax_dom_parser& nlohmann::detail::json_sax_dom_parser< BasicJsonType >::operator= | ( | json_sax_dom_parser< BasicJsonType > && |  | ) |

default

## parse_error() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::parse_error | ( | std::size_t | ,
|  | const std::string & | ,
|  | const detail::exception & | ex
| ) |  |

inline

## parse_error() [2/2]

template<typename BasicJsonType >
template<class Exception >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::parse_error | ( | std::size_t | ,
|  | const std::string & | ,
|  | const Exception & | ex
| ) |  |

inline

## start_array() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::start_array | ( | std::size_t | len | ) |

inline

## start_array() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::start_array | ( | std::size_t | len | ) |

inline

## start_object() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::start_object | ( | std::size_t | len | ) |

inline

## start_object() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::start_object | ( | std::size_t | len | ) |

inline

## string() [1/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::string | ( | string_t & | val | ) |

inline

## string() [2/2]

template<typename BasicJsonType >

bool nlohmann::detail::json_sax_dom_parser< BasicJsonType >::string | ( | string_t & | val | ) |

inline

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

- build/_deps/json-src/include/nlohmann/json.hpp