json/api/json_sax/start_object.md

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 std::numeric_limits<std::size_t>::max() 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"
```

See also

• end_object - the end of an object was read
• key - an object key was read
• sax_parse - SAX parser

Version history

• Added in version 3.2.0.