json/api/json_sax/key.md

nlohmann::json_sax::key

virtual bool key(string_t& val) = 0;

An object key was read.

Parameters

val (in)

object key

Return value

Whether parsing should proceed.

Notes

It is safe to move the passed object key value.

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

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

Version history

• Added in version 3.2.0.