Exit Zen
2
string ID 12
type: paragraph
English
A [*BodyReader] provides an online algorithm to transfer a series of zero or more buffers containing parsed body octets into a message container. The __parser__ creates an instance of this type when needed, and calls into it zero or more times to transfer buffers. The interface of [*BodyReader] is intended to allow the conversion of buffers into these scenarios for representation:
383/3830 · 383
3
string ID 19
type: list
English
* Storing a body in a dynamic buffer
* Storing a body in a user defined container with a custom allocator
* Transformation of incoming body data before storage, for example
172/1720 · 172
4
string ID 23
type: list
English
* Saving body data to a file
28/280 · 28
5
string ID 25
type: heading
English
Associated Types
16/160 · 16
6
string ID 27
type: list
English
* [link beast.ref.boost__beast__http__is_body_reader `is_body_reader`]
* __Body__
81/810 · 81
7
string ID 30
type: heading
English
Requirements
12/120 · 12
8
string ID 33
type: paragraph
English
These requirements may undergo non-backward compatible
54/540 · 54
9
string ID 37
type: paragraph
English
In this table:
14/140 · 14
10
string ID 39
type: list
English
* `R` denotes a type meeting the requirements of [*BodyReader].
* `B` denotes a __Body__ where
94/940 · 94
11
string ID 42
type: list
English
* `a` denotes a value of type `R`.
* `b` is an object whose type meets the requirements of __ConstBufferSequence__
* `h` denotes a value of type `header<isRequest, Fields>&`.
* `v` denotes a value of type `Body::value_type&`.
* `n` is a value of type `boost::optional<std::uint64_t>`.
* `ec` is a value of type [link beast.ref.boost__beast__error_code `error_code&`].
367/3670 · 367
12
string ID 49
type: table title
English
Valid expressions
17/170 · 17
15
string ID 49
type: table cell
English
Semantics, Pre/Post-conditions
30/300 · 30
17
string ID 49
type: table cell
English
Constructible from `h` and `v`. The lifetime of `h` and `v` is guaranteed to end no earlier than after the `R` is destroyed. The reader shall not access the contents of `h` or `v` before the first call to `init`, permitting lazy construction of the message.
257/2570 · 257
19
string ID 49
type: table cell
English
Called once to fully initialize the object before any calls to `put`. The message body is valid before entering this function, and remains valid until the reader is destroyed. The value of `n` will be set to the content length of the body if known, otherwise `n` will be equal to `boost::none`. Implementations of [*BodyReader] may use this information to optimize allocation.

The function will ensure that `!ec` is `true` if there was no error or set to the appropriate error code if there was one.
500/5000 · 500
21
string ID 49
type: table cell
English
`std::size_t`
13/130 · 13
22
string ID 49
type: table cell
English
This function is called to append some or all of the buffers specified by `b` into the body representation. The number of bytes inserted from `b` is returned. If the number of bytes inserted is less than the total input, the remainder of the input will be presented in the next call to `put`. The function will ensure that `!ec` is `true` if there was no error or set to the appropriate error code if there was one.
415/4150 · 415
24
string ID 49
type: table cell
English
This function is called when no more body octets are remaining. The function will ensure that `!ec` is `true` if there was no error or set to the appropriate error code if there was one.
186/1860 · 186
25
string ID 49
type: table cell
English
`is_body_reader<B>`
19/190 · 19
26
string ID 49
type: table cell
English
`std::true_type`
16/160 · 16
27
string ID 49
type: table cell
English
An alias for `std::true_type` for `B`, otherwise an alias for `std::false_type`.
80/800 · 80