1
0
mirror of https://github.com/nlohmann/json.git synced 2025-07-29 23:01:16 +03:00

📝 add more API documentation

This commit is contained in:
Niels Lohmann
2020-08-15 15:18:07 +02:00
parent 1ce0ed5a52
commit d8ed98a7af
12 changed files with 396 additions and 26 deletions

View File

@ -0,0 +1,29 @@
# basic_json::get_binary
```cpp
binary_t& get_binary();
const binary_t& get_binary() const;
```
Returns a reference to the stored binary value.
## Return value
Reference to binary value.
## Exception safety
Strong exception safety: if an exception occurs, the original value stays intact.
## Exceptions
Throws [`type_error.302`](../../home/exceptions.md#jsonexceptiontype_error302) if the value is not binary
## Complexity
Constant.
## Version history
- Added in version 3.8.0.