Niels Lohmann
63c10a51fc
* Review and extend the documentation, and check it in CI A review of all documentation pages found factual errors, dead links, missing cross-references, and gaps in examples. This fixes them and adds checks so the same problems are caught automatically. Fixes: - wrong signatures and version histories (operator!= C++20 member, binary() subtype type, get<PointerType>(), JSON_NO_THREAD_LOCAL, ...) - stale descriptions (number parsing since #5283, UBJSON table, SAX example that no longer compiled, tsl::ordered_map advice) - dead internal and external links; repology.org badges (the domain is suspended) replaced by badges that query the registries directly - deprecation notes link the migration guide; the guide itself fixed Additions: - "See also" sections, cross-references, 25 runnable examples, 12 Mermaid diagrams, new API pages for json_pointer::operator<=> and byte_container_with_subtype::operator==/!= - landing page, guides for untrusted input and performance - "unreleased" badge after versions newer than the latest release Checks: - strict documentation build (broken links/anchors fail it); CI and the publish workflow fetch the full history the build needs - weekly external link check, Mermaid syntax check in CI - check_structure.py: example titles, heading levels, alt texts, header links, docset index coverage; its unused-example check works again - all examples produce the same output on every platform Signed-off-by: Niels Lohmann <mail@nlohmann.me> * Keep the customer links that could not be fixed A dead link on the customers page is still the evidence of where the use of the library was documented. Keep the original URLs of the entries without a working replacement (Marne, Cisco Webex Desk Camera, Philips Hue, CyberArk) and exclude exactly these URLs from the link check. Signed-off-by: Niels Lohmann <mail@nlohmann.me> * Correct the duplicate-key recipe's claim about SAX positions The SAX interface's key() receives no position either; only parse_error() does. Also note that the recipe does not report the path to the repeated key (see discussion #5085). Signed-off-by: Niels Lohmann <mail@nlohmann.me> * Say the library is available as a single header and mention json_fwd.hpp Signed-off-by: Niels Lohmann <mail@nlohmann.me> * Correct documentation errors found while hunting for bugs - patch/patch_inplace: list the JSON pointer errors parse_error.106-109 and out_of_range.402/404, and quote the actual parse_error.105 message. - unflatten: list parse_error.106/107/108 and out_of_range.404. - to_bson: list out_of_range.415 (binary subtype above 255) and note that 412 and 415 are new in 3.13.0. - to_string: state that string_t must be convertible to std::string, also in the StringType requirements table. - JSON Lines: a `while (input >> j)` loop also throws after the last value for concatenated JSON values; show a loop that works for both. - BON8: a string gets 0xFF only if nothing follows it in the message; a string at the end of an array or object is ended by 0xFE. - custom_string_type.hpp: add operator+=(char), which the "Always required" list asks for (json_pointer::to_string, flatten, unflatten, and diff did not compile), and an ADL int_to_string for diff and items. Signed-off-by: Niels Lohmann <mail@nlohmann.me> * Cache the release headers with functools.lru_cache Codacy (Pylint) flagged the mutable default argument that header() used as its cache. functools.lru_cache keeps the same memoization without it. The script's output is unchanged. Signed-off-by: Niels Lohmann <mail@nlohmann.me> --------- Signed-off-by: Niels Lohmann <mail@nlohmann.me>
76 lines
2.4 KiB
Markdown
76 lines
2.4 KiB
Markdown
# <small>nlohmann::basic_json::</small>binary
|
|
|
|
```cpp
|
|
// (1)
|
|
static basic_json binary(const typename binary_t::container_type& init);
|
|
static basic_json binary(typename binary_t::container_type&& init);
|
|
|
|
// (2)
|
|
static basic_json binary(const typename binary_t::container_type& init,
|
|
typename binary_t::subtype_type subtype);
|
|
static basic_json binary(typename binary_t::container_type&& init,
|
|
typename binary_t::subtype_type subtype);
|
|
```
|
|
|
|
1. Creates a JSON binary array value from a given binary container.
|
|
2. Creates a JSON binary array value from a given binary container with subtype.
|
|
|
|
Binary values are part of various binary formats, such as CBOR, MessagePack, and BSON. This constructor is used to
|
|
create a value for serialization to those formats.
|
|
|
|
## Parameters
|
|
|
|
`init` (in)
|
|
: container containing bytes to use as a binary type
|
|
|
|
`subtype` (in)
|
|
: subtype to use in CBOR, MessagePack, and BSON
|
|
|
|
## Return value
|
|
|
|
JSON binary array value
|
|
|
|
## Exception safety
|
|
|
|
Strong guarantee: if an exception is thrown, there are no changes in the JSON value.
|
|
|
|
## Complexity
|
|
|
|
Linear in the size of `init`; constant for `typename binary_t::container_type&& init` versions.
|
|
|
|
## Notes
|
|
|
|
Note, this function exists because of the difficulty in correctly specifying the correct template overload in the
|
|
standard value ctor, as both JSON arrays and JSON binary arrays are backed with some form of a `std::vector`. Because
|
|
JSON binary arrays are a non-standard extension, it was decided that it would be best to prevent automatic
|
|
initialization of a binary array type, for backwards compatibility and so it does not happen on accident.
|
|
|
|
## Examples
|
|
|
|
??? example
|
|
|
|
The following code shows how to create a binary value.
|
|
|
|
```cpp
|
|
--8<-- "examples/binary.cpp"
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
--8<-- "examples/binary.output"
|
|
```
|
|
|
|
## See also
|
|
|
|
- [binary_t](binary_t.md) type for binary values
|
|
- [get_binary](get_binary.md) get a reference to the stored binary value
|
|
- [is_binary](is_binary.md) return whether the value is binary
|
|
- [byte_container_with_subtype](../byte_container_with_subtype/index.md) container for binary values with subtype
|
|
- [Binary Values](../../features/binary_values.md) - the article on binary values
|
|
|
|
## Version history
|
|
|
|
- Added in version 3.8.0.
|
|
- Changed the type of `subtype` from `std::uint8_t` to `binary_t::subtype_type` (`std::uint64_t`) in version 3.10.0.
|