Trait http_body::Body

source · [−]
pub trait Body {
    type Data: Buf;
    type Error;

    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>, Self::Error>>;

    fn is_end_stream(&self) -> bool { ... }
    fn size_hint(&self) -> SizeHint { ... }
    fn data(&mut self) -> Data<'_, Self>ⓘNotable traits for Data<'a, T>impl<'a, T: Body + Unpin + ?Sized> Future for Data<'a, T>    type Output = Option<Result<T::Data, T::Error>>;
    where
        Self: Unpin + Sized,
    { ... }
    fn trailers(&mut self) -> Trailers<'_, Self>ⓘNotable traits for Trailers<'a, T>impl<'a, T: Body + Unpin + ?Sized> Future for Trailers<'a, T>    type Output = Result<Option<HeaderMap>, T::Error>;
    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

Values yielded by the Body.

The error type this Body might generate.

Required Methods

Attempt to pull out the next data buffer of this stream.

Poll for an optional single HeaderMap of trailers.

This function should only be called once poll_data returns None.

Provided Methods

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.

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.

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

Returns future that resolves to trailers, if any.

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

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

Turn this body into a boxed trait object.

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

Implementations on Foreign Types

source

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

source

impl<P> Body for Pin<P>where
    P: Unpin + DerefMut,
    P::Target: Body,

source

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

source

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

source

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

source

impl Body for String

Implementors

source

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

source

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

source

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

source

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

source

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

source

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

source

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