[−][src]Trait tower_grpc::codegen::client::tower::HttpBody
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.
Associated Types
Loading content...Required methods
fn poll_data(&mut self) -> Result<Async<Option<Self::Data>>, Self::Error>
Attempt to pull out the next data buffer of this stream.
fn poll_trailers(
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, Self::Error>
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, Self::Error>
Poll for an optional single HeaderMap
of trailers.
This function should only be called once poll_data
returns None
.
Provided methods
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.
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
.
Implementors
impl Body for Body
[src]
type Data = Chunk
type Error = Error
fn poll_data(
&mut self
) -> Result<Async<Option<<Body as Body>::Data>>, <Body as Body>::Error>
[src]
&mut self
) -> Result<Async<Option<<Body as Body>::Data>>, <Body as Body>::Error>
fn poll_trailers(
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <Body as Body>::Error>
[src]
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <Body as Body>::Error>
fn is_end_stream(&self) -> bool
[src]
fn size_hint(&self) -> SizeHint
[src]
impl Body for BoxBody
[src]
type Data = <Bytes as IntoBuf>::Buf
type Error = Status
fn is_end_stream(&self) -> bool
[src]
fn poll_data(&mut self) -> Poll<Option<Self::Data>, Self::Error>
[src]
fn poll_trailers(&mut self) -> Poll<Option<HeaderMap>, Self::Error>
[src]
impl<T> Body for tower_grpc::Encode<T> where
T: Stream<Error = Status>,
T::Item: Message,
[src]
T: Stream<Error = Status>,
T::Item: Message,
type Data = <Encode<Encoder<T::Item>, T> as HttpBody>::Data
type Error = <Encode<Encoder<T::Item>, T> as HttpBody>::Error
fn is_end_stream(&self) -> bool
[src]
fn poll_data(&mut self) -> Poll<Option<Self::Data>, Self::Error>
[src]
fn poll_trailers(&mut self) -> Poll<Option<HeaderMap>, Self::Error>
[src]
impl<T> Body for T where
T: BufStream,
[src]
T: BufStream,
type Data = <T as BufStream>::Item
type Error = <T as BufStream>::Error
fn poll_data(
&mut self
) -> Result<Async<Option<<T as Body>::Data>>, <T as Body>::Error>
[src]
&mut self
) -> Result<Async<Option<<T as Body>::Data>>, <T as Body>::Error>
fn size_hint(&self) -> SizeHint
[src]
fn poll_trailers(
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <T as Body>::Error>
[src]
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <T as Body>::Error>
fn is_end_stream(&self) -> bool
[src]
impl<T, U> Body for tower_grpc::generic::Encode<T, U> where
T: Encoder<Item = U::Item>,
U: Stream,
U::Error: Into<Box<dyn Error + Send + Sync>>,
[src]
T: Encoder<Item = U::Item>,
U: Stream,
U::Error: Into<Box<dyn Error + Send + Sync>>,