json/doc/mkdocs/docs/api/basic_json/boolean_t.md
Niels Lohmann 29cd970b94
Consolidate documentation (#3071)
* 🔥 consolidate documentation
* ♻️ overwork std specializations
* 🚚 move images files to mkdocs
* ♻️ fix URLs
* 🔧 tweak MkDocs configuration
* 🔧 add namespaces
* 📝 document deprecations
* 📝 document documentation generation
* 🚸 improve search
* 🚸 add examples
* 🚧 start adding documentation for macros
* 📝 add note for https://github.com/nlohmann/json/issues/874#issuecomment-1001699139
* 📝 overwork example handling
* 📝 fix Markdown tables
2021-12-29 13:41:01 +01:00

930 B

nlohmann::basic_json::boolean_t

using boolean_t = BooleanType;

The type used to store JSON booleans.

RFC 8259 implicitly describes a boolean as a type which differentiates the two literals #!json true and #!json false.

To store objects in C++, a type is defined by the template parameter BooleanType which chooses the type to use.

Notes

Default type

With the default values for BooleanType (#!cpp bool), the default value for boolean_t is #!cpp bool.

Storage

Boolean values are stored directly inside a basic_json type.

Examples

??? example

The following code shows that `boolean_t` is by default, a typedef to `#!cpp bool`.
 
```cpp
--8<-- "examples/boolean_t.cpp"
```

Output:

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

Version history

  • Added in version 1.0.0.