Trait hyper::body::HttpBody

source ·
pub trait HttpBody {
    type Data: Buf;
    type Error;

    // Required methods
    fn poll_data(
        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<HeaderValue>>, Self::Error>>;

    // Provided methods
    fn is_end_stream(&self) -> bool { ... }
    fn size_hint(&self) -> SizeHint { ... }
    fn data(&mut self) -> Data<'_, Self>
       where Self: Unpin + Sized { ... }
    fn trailers(&mut self) -> Trailers<'_, Self>
       where Self: Unpin + Sized { ... }
    fn map_data<F, B>(self, f: F) -> MapData<Self, F>
       where Self: Sized,
             F: FnMut(Self::Data) -> B,
             B: Buf { ... }
    fn map_err<F, E>(self, f: F) -> MapErr<Self, F>
       where Self: Sized,
             F: FnMut(Self::Error) -> E { ... }
    fn boxed(self) -> BoxBody<Self::Data, Self::Error>
       where Self: Sized + Send + Sync + 'static { ... }
    fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>
       where Self: Sized + Send + 'static { ... }
}
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.

Required Associated Types§

source

type Data: Buf

Values yielded by the Body.

source

type Error

The error type this Body might generate.

Required Methods§

source

fn poll_data( 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.

source

fn poll_trailers( 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§

source

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.

source

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.

source

fn data(&mut self) -> Data<'_, Self>where Self: Unpin + Sized,

Returns future that resolves to next data chunk, if any.

source

fn trailers(&mut self) -> Trailers<'_, Self>where Self: Unpin + Sized,

Returns future that resolves to trailers, if any.

source

fn map_data<F, B>(self, f: F) -> MapData<Self, F>where Self: Sized, F: FnMut(Self::Data) -> B, B: Buf,

Maps this body’s data value to a different value.

source

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>where Self: Sized, F: FnMut(Self::Error) -> E,

Maps this body’s error value to a different value.

source

fn boxed(self) -> BoxBody<Self::Data, Self::Error>where Self: Sized + Send + Sync + 'static,

Turn this body into a boxed trait object.

source

fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>where Self: Sized + Send + 'static,

Turn this body into a boxed trait object that is !Sync.

Implementations on Foreign Types§

source§

impl Body for String

§

type Data = Bytes

§

type Error = Infallible

source§

fn poll_data( self: Pin<&mut String>, _cx: &mut Context<'_> ) -> Poll<Option<Result<<String as Body>::Data, <String as Body>::Error>>>

source§

fn poll_trailers( self: Pin<&mut String>, _cx: &mut Context<'_> ) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <String as Body>::Error>>

source§

fn is_end_stream(&self) -> bool

source§

fn size_hint(&self) -> SizeHint

source§

impl<P> Body for Pin<P>where 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

source§

fn poll_data( self: Pin<&mut Pin<P>>, cx: &mut Context<'_> ) -> Poll<Option<Result<<Pin<P> as Body>::Data, <Pin<P> as Body>::Error>>>

source§

fn poll_trailers( self: Pin<&mut Pin<P>>, cx: &mut Context<'_> ) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Pin<P> as Body>::Error>>

source§

fn is_end_stream(&self) -> bool

source§

fn size_hint(&self) -> SizeHint

source§

impl<T> Body for &mut Twhere T: Body + Unpin + ?Sized,

§

type Data = <T as Body>::Data

§

type Error = <T as Body>::Error

source§

fn poll_data( self: Pin<&mut &mut T>, cx: &mut Context<'_> ) -> Poll<Option<Result<<&mut T as Body>::Data, <&mut T as Body>::Error>>>

source§

fn poll_trailers( self: Pin<&mut &mut T>, cx: &mut Context<'_> ) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <&mut T as Body>::Error>>

source§

fn is_end_stream(&self) -> bool

source§

fn size_hint(&self) -> SizeHint

source§

impl<T> Body for Box<T, Global>where T: Body + Unpin + ?Sized,

§

type Data = <T as Body>::Data

§

type Error = <T as Body>::Error

source§

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>>>

source§

fn poll_trailers( self: Pin<&mut Box<T, Global>>, cx: &mut Context<'_> ) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Box<T, Global> as Body>::Error>>

source§

fn is_end_stream(&self) -> bool

source§

fn size_hint(&self) -> SizeHint

Implementors§

source§

impl Body for Body

§

type Data = Bytes

§

type Error = Error

source§

impl<B> Body for Limited<B>where B: Body, <B as Body>::Error: Into<Box<dyn Error + Sync + Send, Global>>,

§

type Data = <B as Body>::Data

§

type Error = Box<dyn Error + Sync + Send, Global>

source§

impl<B> Body for Request<B>where B: Body,

§

type Data = <B as Body>::Data

§

type Error = <B as Body>::Error

source§

impl<B> Body for Response<B>where B: Body,

§

type Data = <B as Body>::Data

§

type Error = <B as Body>::Error

source§

impl<B, F, B2> Body for MapData<B, F>where B: Body, F: FnMut(<B as Body>::Data) -> B2, B2: Buf,

§

type Data = B2

§

type Error = <B as Body>::Error

source§

impl<B, F, E> Body for MapErr<B, F>where B: Body, F: FnMut(<B as Body>::Error) -> E,

§

type Data = <B as Body>::Data

§

type Error = E

source§

impl<D> Body for Empty<D>where D: Buf,

§

type Data = D

§

type Error = Infallible

source§

impl<D> Body for Full<D>where D: Buf,

§

type Data = D

§

type Error = Infallible

source§

impl<D, E> Body for BoxBody<D, E>where D: Buf,

§

type Data = D

§

type Error = E

source§

impl<D, E> Body for UnsyncBoxBody<D, E>where D: Buf,

§

type Data = D

§

type Error = E