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 master branch, built from commit d5168985da.

value_stack::reset

Prepare to build a new document.

Synopsis

void
reset(
    storage_ptr sp = {}) noexcept;

Description

This function must be called before constructing a new top-level value. Any previously existing partial or complete elements are destroyed, but internal dynamically allocated memory is preserved which may be reused to build new values.

Exception Safety

No-throw guarantee.

Parameters

Name	Description
`sp`	A pointer to the `boost::container::pmr::memory_resource` to use for top-level `value` and all child values. The stack will acquire shared ownership of the memory resource until `release` or `reset` is called, or when the stack is destroyed.