Zen

Source string Source string

type: table cell
521/10000 · 521

The string is read-only.

Key English Actions
Requirements
In this table:
* `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&`].
Valid expressions
Expression
Type
Semantics, Pre/Post-conditions
45
`G::const_buffers_type`
A type which meets the requirements of __ConstBufferSequence__. This is the type of buffer returned by `g.prepare(ec)`.
`c.is_done()`
`bool`
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.
`g.prepare(ec)`
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.
`g.consume(n)`
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.
`is_buffers_generator<G>`
`std::bool_constant`
An alias for `std::true_type` for `G`, otherwise an alias for `std::false_type`.
Exemplar
122
```
135
```
Models
* [link beast.ref.boost__beast__http__message_generator `http::message_generator`]
Algorithms
* [link beast.ref.boost__beast__async_write `async_write`]
* [link beast.ref.boost__beast__write `write`]
Key English Actions
Algorithms
* `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&`].
Valid expressions
Expression
Type
Semantics, Pre/Post-conditions
Models
* [link beast.ref.boost__beast__http__message_generator `http::message_generator`]
BuffersGenerator
A type which meets the requirements of __ConstBufferSequence__. This is the type of buffer returned by `g.prepare(ec)`.
`c.is_done()`
`bool`
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.
`g.prepare(ec)`
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.
`g.consume(n)`
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.
`is_buffers_generator<G>`
`std::bool_constant`
An alias for `std::true_type` for `G`, otherwise an alias for `std::false_type`.
Exemplar
122
```
135
```
45
`G::const_buffers_type`

Loading…

User avatar admin

String added in the repository
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.
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.
06/05/2026
Browse all string changes

Glossary

English English
No related strings found in the glossary.

String information

Component
Boost Beast Translation (zh_Hans)/Doc / Qbk / 07 Concepts / Buffersgenerator (qbk)
Source string description
type: table cell
Flags
read-only
Unit identifier
56481
Source string location
string ID 45
String age
06/05/2026
Last updated
06/05/2026
Source string age
06/05/2026
Translation file QuickBook file
doc/qbk/07_concepts/BuffersGenerator.qbk, string 23