Trait hyper::body::HttpBody [−][src]
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.
Associated Types
type Data: Buf
[src]
Values yielded by the Body
.
type Error
[src]
The error type this Body
might generate.
Required methods
pub fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>
Attempt to pull out the next data buffer of this stream.
pub fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, Self::Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<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
pub fn is_end_stream(&self) -> bool
[src]
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
.
pub fn size_hint(&self) -> SizeHint
[src]
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.
pub fn data(&mut self) -> Data<'_, Self> where
Self: Unpin,
[src]
Self: Unpin,
Returns future that resolves to next data chunk, if any.
pub fn trailers(&mut self) -> Trailers<'_, Self> where
Self: Unpin,
[src]
Self: Unpin,
Returns future that resolves to trailers, if any.
Implementations on Foreign Types
impl<P> Body for Pin<P> where
P: Unpin + DerefMut,
<P as Deref>::Target: Body,
[src]
P: Unpin + DerefMut,
<P as Deref>::Target: Body,
type Data = <<P as Deref>::Target as Body>::Data
type Error = <<P as Deref>::Target as Body>::Error
pub fn poll_data(
self: Pin<&mut Pin<P>>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<Pin<P> as Body>::Data, <Pin<P> as Body>::Error>>>
[src]
self: Pin<&mut Pin<P>>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<Pin<P> as Body>::Data, <Pin<P> as Body>::Error>>>
pub fn poll_trailers(
self: Pin<&mut Pin<P>>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Pin<P> as Body>::Error>>
[src]
self: Pin<&mut Pin<P>>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Pin<P> as Body>::Error>>
pub fn is_end_stream(&self) -> bool
[src]
pub fn size_hint(&self) -> SizeHint
[src]
impl<'_, T> Body for &'_ mut T where
T: Body + Unpin + ?Sized,
[src]
T: Body + Unpin + ?Sized,
type Data = <T as Body>::Data
type Error = <T as Body>::Error
pub fn poll_data(
self: Pin<&mut &'_ mut T>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<&'_ mut T as Body>::Data, <&'_ mut T as Body>::Error>>>
[src]
self: Pin<&mut &'_ mut T>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<&'_ mut T as Body>::Data, <&'_ mut T as Body>::Error>>>
pub fn poll_trailers(
self: Pin<&mut &'_ mut T>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <&'_ mut T as Body>::Error>>
[src]
self: Pin<&mut &'_ mut T>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <&'_ mut T as Body>::Error>>
pub fn is_end_stream(&self) -> bool
[src]
pub fn size_hint(&self) -> SizeHint
[src]
impl<T> Body for Box<T, Global> where
T: Body + Unpin + ?Sized,
[src]
T: Body + Unpin + ?Sized,
type Data = <T as Body>::Data
type Error = <T as Body>::Error
pub fn poll_data(
self: Pin<&mut Box<T, Global>>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<Box<T, Global> as Body>::Data, <Box<T, Global> as Body>::Error>>>
[src]
self: Pin<&mut Box<T, Global>>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<Box<T, Global> as Body>::Data, <Box<T, Global> as Body>::Error>>>
pub fn poll_trailers(
self: Pin<&mut Box<T, Global>>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Box<T, Global> as Body>::Error>>
[src]
self: Pin<&mut Box<T, Global>>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Box<T, Global> as Body>::Error>>
pub fn is_end_stream(&self) -> bool
[src]
pub fn size_hint(&self) -> SizeHint
[src]
Implementors
impl Body for Body
[src]
type Data = Bytes
type Error = Error
fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>
fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>
fn is_end_stream(&self) -> bool
[src]
fn size_hint(&self) -> SizeHint
[src]
impl<B> Body for Request<B> where
B: Body,
[src]
B: Body,
type Data = <B as Body>::Data
type Error = <B as Body>::Error
pub fn poll_data(
self: Pin<&mut Request<B>>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<Request<B> as Body>::Data, <Request<B> as Body>::Error>>>
[src]
self: Pin<&mut Request<B>>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<Request<B> as Body>::Data, <Request<B> as Body>::Error>>>
pub fn poll_trailers(
self: Pin<&mut Request<B>>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Request<B> as Body>::Error>>
[src]
self: Pin<&mut Request<B>>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Request<B> as Body>::Error>>
pub fn is_end_stream(&self) -> bool
[src]
pub fn size_hint(&self) -> SizeHint
[src]
impl<B> Body for Response<B> where
B: Body,
[src]
B: Body,
type Data = <B as Body>::Data
type Error = <B as Body>::Error
pub fn poll_data(
self: Pin<&mut Response<B>>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<Response<B> as Body>::Data, <Response<B> as Body>::Error>>>
[src]
self: Pin<&mut Response<B>>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<Response<B> as Body>::Data, <Response<B> as Body>::Error>>>
pub fn poll_trailers(
self: Pin<&mut Response<B>>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Response<B> as Body>::Error>>
[src]
self: Pin<&mut Response<B>>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Response<B> as Body>::Error>>