Zen

Source string Source string

type: table cell
500/10000 · 500

The string is read-only.

English Actions
* Saving body data to a file
Associated Types
* [link beast.ref.boost__beast__http__is_body_reader `is_body_reader`]
* __Body__
Requirements
These requirements may undergo non-backward compatible
In this table:
* `R` denotes a type meeting the requirements of [*BodyReader].
* `B` denotes a __Body__ where
* `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&`].
Valid expressions
Expression
Type
Semantics, Pre/Post-conditions
`R{h,v};`
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.
`a.init(n, ec)`
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.
`a.put(b,ec)`
`std::size_t`
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.
`a.finish(ec)`
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.
`is_body_reader<B>`
`std::true_type`
An alias for `std::true_type` for `B`, otherwise an alias for `std::false_type`.
Exemplar
Models
* [link beast.ref.boost__beast__http__basic_dynamic_body.reader `basic_dynamic_body::reader`]
* [link beast.ref.boost__beast__http__basic_file_body__reader `basic_file_body::reader`]
* [link beast.ref.boost__beast__http__basic_string_body.reader `basic_string_body::reader`]
* [link beast.ref.boost__beast__http__buffer_body.reader `buffer_body::reader`]
* [link beast.ref.boost__beast__http__empty_body.reader `empty_body::reader`]
* [link beast.ref.boost__beast__http__span_body.reader `span_body::reader`]
* [link beast.ref.boost__beast__http__vector_body.reader `vector_body::reader`]
English Actions
* Saving body data to a file
Associated Types
* [link beast.ref.boost__beast__http__is_body_reader `is_body_reader`]
* __Body__
Requirements
These requirements may undergo non-backward compatible
In this table:
* `R` denotes a type meeting the requirements of [*BodyReader].
* `B` denotes a __Body__ where
* `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&`].
Valid expressions
Expression
Type
Semantics, Pre/Post-conditions
`R{h,v};`
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.
`a.init(n, ec)`
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.
`a.put(b,ec)`
`std::size_t`
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.
`a.finish(ec)`
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.
`is_body_reader<B>`
`std::true_type`
An alias for `std::true_type` for `B`, otherwise an alias for `std::false_type`.
Exemplar
Models
* [link beast.ref.boost__beast__http__basic_dynamic_body.reader `basic_dynamic_body::reader`]
* [link beast.ref.boost__beast__http__basic_file_body__reader `basic_file_body::reader`]
* [link beast.ref.boost__beast__http__basic_string_body.reader `basic_string_body::reader`]
* [link beast.ref.boost__beast__http__buffer_body.reader `buffer_body::reader`]
* [link beast.ref.boost__beast__http__empty_body.reader `empty_body::reader`]
* [link beast.ref.boost__beast__http__span_body.reader `span_body::reader`]
* [link beast.ref.boost__beast__http__vector_body.reader `vector_body::reader`]

Loading…

User avatar admin

String added in the repository
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.
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.
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 / Bodyreader (qbk)
Source string description
type: table cell
Flags
read-only
Unit identifier
56447
Source string location
string ID 49
String age
06/05/2026
Last updated
06/05/2026
Source string age
06/05/2026
Translation file QuickBook file
doc/qbk/07_concepts/BodyReader.qbk, string 19