Trait hyper::body::Body

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

    // Required method
    fn poll_frame(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>>;

    // Provided methods
    fn is_end_stream(&self) -> bool { ... }
    fn size_hint(&self) -> SizeHint { ... }
}
Expand description

Trait representing a streaming body of a Request or Response.

Individual frames are streamed via the poll_frame function, which asynchronously yields instances of Frame<Data>.

Frames can contain a data buffer of type Self::Data. Frames can also contain an optional set of trailers used to finalize the request/response exchange. This is mostly used when using the HTTP/2.0 protocol.

The size_hint function provides insight into the total number of bytes that will be streamed.

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_frame( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>>

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

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 poll_frame will return None.

A return value of false does not guarantee that a value will be returned from poll_frame.

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.

Implementations on Foreign Types§

source§

impl Body for String

§

type Data = Bytes

§

type Error = Infallible

source§

fn poll_frame( self: Pin<&mut String>, _cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<<String as Body>::Data>, <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_frame( self: Pin<&mut Pin<P>>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<<Pin<P> as Body>::Data>, <Pin<P> as Body>::Error>>>

source§

fn is_end_stream(&self) -> bool

source§

fn size_hint(&self) -> SizeHint

source§

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

§

type Data = <T as Body>::Data

§

type Error = <T as Body>::Error

source§

fn poll_frame( self: Pin<&mut &mut T>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<<&mut T as Body>::Data>, <&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>
where T: Body + Unpin + ?Sized,

§

type Data = <T as Body>::Data

§

type Error = <T as Body>::Error

source§

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

source§

fn is_end_stream(&self) -> bool

source§

fn size_hint(&self) -> SizeHint

Implementors§

source§

impl Body for Incoming

§

type Data = Bytes

§

type Error = Error

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