json/docs/mkdocs/docs/api/json_sax/start_object.md
Niels Lohmann 7b6cf5918b
Documentation change (#3672)
Co-authored-by: Florian Albrechtskirchinger <falbrechtskirchinger@gmail.com>
2022-08-05 19:51:39 +02:00

621 B

nlohmann::json_sax::start_object

virtual bool start_object(std::size_t elements) = 0;

The beginning of an object was read.

Parameters

elements (in)
number of object elements or #!cpp -1 if unknown

Return value

Whether parsing should proceed.

Notes

Binary formats may report the number of elements.

Examples

??? example

The example below shows how the SAX interface is used.

```cpp
--8<-- "examples/sax_parse.cpp"
```

Output:

```json
--8<-- "examples/sax_parse.output"
```

Version history

  • Added in version 3.2.0.