a11::nodes::FinalizeOptions Struct Reference

How an AsyncNode::Finalize() call ends the stream. More...

#include <cpp/a11/nodes/async_node.h>

Public Attributes
bool	wait = false
	Whether to resolve only once the store confirmed the write and, if close is set, closed.
bool	close = true
	Whether to close the writer after the final chunk.
std::optional< std::uint32_t >	seq = {}
	Explicit sequence number for the final chunk; assigned in order when omitted.
std::string_view	mimetype = {}
	MIME type selecting the encoding of a typed value.

Detailed Description

How an AsyncNode::Finalize() call ends the stream.

The defaults are the ordinary case: mark the logical end, close the writer, and let the writer's pump carry both out after the producer has moved on.

Member Data Documentation

close

bool a11::nodes::FinalizeOptions::close = true

Whether to close the writer after the final chunk.

Clear it to finalise now and close later – a producer closing several nodes at once, say.

mimetype

std::string_view a11::nodes::FinalizeOptions::mimetype = {}

MIME type selecting the encoding of a typed value.

Ignored by the no-value and raw-chunk overloads.

seq

std::optional<std::uint32_t> a11::nodes::FinalizeOptions::seq = {}

Explicit sequence number for the final chunk; assigned in order when omitted.

wait

bool a11::nodes::FinalizeOptions::wait = false

Whether to resolve only once the store confirmed the write and, if close is set, closed.

Leave it false to hand both to the writer's pump.

---

The documentation for this struct was generated from the following file:

• cpp/a11/nodes/async_node.h