pub trait HttpBody {
type Data: Buf;
type Error;
// Required methods
fn poll_data(&mut self) -> Result<Async<Option<Self::Data>>, Self::Error>;
fn poll_trailers(&mut self) -> Result<Async<Option<HeaderMap>>, Self::Error>;
// Provided methods
fn size_hint(&self) -> SizeHint { ... }
fn is_end_stream(&self) -> bool { ... }
}Expand description
Trait representing a streaming body of a Request or Response.
Data is streamed via the poll_data function, which asynchronously yields T: Buf values. The
size_hint function provides insight into the total number of bytes that will be streamed.
The poll_trailers function returns an optional set of trailers used to finalize the request /
response exchange. This is mostly used when using the HTTP/2.0 protocol.
§Relation with BufStream.
The Body trait is a superset of the BufStream trait. However, BufStream is not considered
a super trait of Body. Instead, a T: Body can be thought of as containing a BufStream as
well as the HTTP trailers.
There exists is a blanket implementation of Body for T: BufStream. In other words, any type
that implements BufStream also implements Body yielding no trailers.
Required Associated Types§
Required Methods§
Provided Methods§
Sourcefn size_hint(&self) -> SizeHint
fn size_hint(&self) -> SizeHint
Returns the bounds on the remaining length of the stream.
When the exact remaining length of the stream is known, the upper bound will be set and will equal the lower bound.
Sourcefn is_end_stream(&self) -> bool
fn is_end_stream(&self) -> bool
Returns true when the end of stream has been reached.
An end of stream means that both poll_data and poll_trailers will
return None.
A return value of false does not guarantee that a value will be
returned from poll_stream or poll_trailers.