mirror of
https://github.com/nlohmann/json.git
synced 2025-05-11 21:53:56 +00:00
29cd970b94
* 🔥 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
2.9 KiB
2.9 KiB
nlohmann::basic_json::meta
static basic_json meta();
This function returns a JSON object with information about the library, including the version number and information on the platform and compiler.
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, and string (the version string). |
Exception safety
Strong guarantee: if an exception is thrown, there are no changes to any JSON value.
Complexity
Constant.
Examples
??? example
The following code shows an example output of the `meta()`
function.
```cpp
--8<-- "examples/meta.cpp"
```
Output:
```json
--8<-- "examples/meta.output"
```
Version history
- Added in version 2.1.0.