Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the develop branch, built from commit f8f3d75ae3.

serializer::serializer (3 of 3 overloads)

Constructor.

Synopsis

serializer(
    storage_ptr sp,
    unsigned char* buf = nullptr,
    std::size_t buf_size = 0,
    serialize_options const& opts = {});

Description

This constructs a serializer with no value. The value may be set later by calling reset. If serialization is attempted with no value, the output is as if a null value is serialized.

Complexity

Constant.

Exception Safety

No-throw guarantee.

Parameters

Name	Description
`sp`	A pointer to the `boost::container::pmr::memory_resource` to use when producing partial output. Shared ownership of the memory resource is retained until the serializer is destroyed.
`buf`	An optional static buffer to use for temporary storage when producing partial output.
`buf_size`	The number of bytes of valid memory pointed to by `buf`.
`opts`	The options for the serializer. If this parameter is omitted, the serializer will output only standard JSON.