Exit Zen
2
string ID 12
type: paragraph
English
A [*BuffersGenerator] provides a generalized interface for generating serialized data for sequential processing.
112/1120 · 112
3
string ID 15
type: paragraph
English
The generator will be asked to produce buffers. The consuming code will signal how much of the data has been consumed, and repeatedly query for buffers until no more data is available, or the generator indicates an error condition.
231/2310 · 231
4
string ID 19
type: paragraph
English
In this way, serializers can be adapted as [*BuffersGenerator], for example [link beast.ref.boost__beast__http__message_generator `http::message_generator`] which provides a type-erased interface for a variety of concrete http message types.
241/2410 · 241
5
string ID 24
type: paragraph
English
Overloads of [link beast.ref.boost__beast__write `write`] and [link beast.ref.boost__beast__async_write `async_write`] operations are provided as free functions. These operations will consume the output of a [*BuffersGenerator] and process the data by writing them to a __SyncWriteStream__ or __AsyncWriteStream__ respectively.
327/3270 · 327
6
string ID 30
type: heading
English
Associated Types
16/160 · 16
7
string ID 32
type: list
English
* [link beast.ref.boost__beast__is_buffers_generator `is_buffers_generator`]
* __ConstBufferSequence__
102/1020 · 102
8
string ID 35
type: heading
English
Requirements
12/120 · 12
9
string ID 37
type: paragraph
English
In this table:
14/140 · 14
10
string ID 39
type: list
English
* `G` denotes a type meeting the requirements of [*BuffersGenerator].
* `g` denotes a value of type `G`.
* `c` denotes a possibly-const value of type `G`.
* `n` is a value of type `std::size_t`.
* `ec` is a value of type [link beast.ref.boost__beast__error_code `error_code&`].
277/2770 · 277
11
string ID 45
type: table title
English
Valid expressions
17/170 · 17
14
string ID 45
type: table cell
English
Semantics, Pre/Post-conditions
30/300 · 30
16
string ID 45
type: table cell
English
A type which meets the requirements of __ConstBufferSequence__. This is the type of buffer returned by `g.prepare(ec)`.
119/1190 · 119
17
string ID 45
type: table cell
English
`c.is_done()`
13/130 · 13
19
string ID 45
type: table cell
English
Called to ask the generator for its completion status.

A generator has completed when no new buffer will be produced and previously produced buffers have been fully consumed.

[*Note:] The result of invoking `prepare` on `g` once it has completed is unspecified.
263/2630 · 263
21
string ID 45
type: table cell
English
Called to ask the generator to produce buffers containing data for processing.

The returned value is the __ConstBufferSequence__ representing unconsumed data.

The function will ensure that `ec.failed()` is `false` if there was no error or set to the appropriate error code if there was one.

If no unconsumed data is available, this operation shall make progress to eventually reach completion.

The result of invoking `prepare` after completion or encountered error(s) is defined by the generator implementation. It can not be assumed to be meaningful or safe to do so, in general.

The capacity of the buffer returned is defined by the generator implementation.

[*Note:] Any buffers obtained by previous calls to `prepare` are invalidated.
744/7440 · 744
23
string ID 45
type: table cell
English
This function is called to signal that the consumer (caller) of the generator has processed part of the data returned by the previous call to `prepare`.

The value of `n` indicates how much of the data processed (in bytes).

When `n` exceeds the number of bytes returned from the last call to `prepare`, `consume` shall behave as if `n` was equal to that number.

Remaining unconsumed data will be returned from subsequent calls to `prepare`.

[*Note:] Any buffers obtained by previous calls to `prepare` are invalidated.
521/5210 · 521
24
string ID 45
type: table cell
English
`is_buffers_generator<G>`
25/250 · 25
25
string ID 45
type: table cell
English
`std::bool_constant`
20/200 · 20
26
string ID 45
type: table cell
English
An alias for `std::true_type` for `G`, otherwise an alias for `std::false_type`.
80/800 · 80
27
string ID 120
type: heading
English
Exemplar
8/100 · 8