json/doc/mkdocs/docs/api/basic_json/meta.md

51 lines
2.9 KiB
Markdown
Raw Normal View History

# <small>nlohmann::basic_json::</small>meta
2020-07-25 15:40:50 +03:00
```cpp
static basic_json meta();
```
2020-08-12 14:41:59 +03:00
This function returns a JSON object with information about the library, including the version number and information on
the platform and compiler.
2020-07-25 15:40:50 +03:00
## Return value
JSON object holding version information
| key | description |
|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `compiler` | Information on the used compiler. It is an object with the following keys: `c++` (the used C++ standard), `family` (the compiler family; possible values are `clang`, `icc`, `gcc`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version). |
| `copyright` | The copyright line for the library as string. |
| `name` | The name of the library as string. |
| `platform` | The used platform as string. Possible values are `win32`, `linux`, `apple`, `unix`, and `unknown`. |
| `url` | The URL of the project as string. |
| `version` | The version of the library. It is an object with the following keys: `major`, `minor`, and `patch` as defined by [Semantic Versioning](http://semver.org), and `string` (the version string). |
2020-07-25 15:40:50 +03:00
## Exception safety
2020-08-12 14:41:59 +03:00
Strong guarantee: if an exception is thrown, there are no changes to any JSON value.
2020-07-25 15:40:50 +03:00
## Complexity
Constant.
## Examples
2020-07-25 15:40:50 +03:00
??? example
2020-07-25 15:40:50 +03:00
The following code shows an example output of the `meta()`
function.
```cpp
--8<-- "examples/meta.cpp"
```
Output:
```json
--8<-- "examples/meta.output"
```
2020-08-12 14:41:59 +03:00
## Version history
- Added in version 2.1.0.