Trait rama::http::dep::http_body::Body

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§

type Data: Buf

Values yielded by the Body.

type Error

The error type this Body might generate.

Required Methods§

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§

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.

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§

§

impl Body for String

§

type Data = Bytes

§

type Error = Infallible

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

§

impl Body for Incoming

§

type Data = Bytes

§

type Error = Error

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

§

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

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

§

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

§

type Data = <T as Body>::Data

§

type Error = <T as Body>::Error

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

§

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

§

type Data = <T as Body>::Data

§

type Error = <T as Body>::Error

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

Implementors§

§

impl Body for RetryBody

§

type Data = Bytes

§

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

§

impl Body for Body

§

type Data = Bytes

§

type Error = OpaqueError

§

impl Body for BodyDataStream

§

type Data = Bytes

§

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

§

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

§

type Data = Bytes

§

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

§

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

§

type Data = Bytes

§

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

§

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

§

type Data = <B as Body>::Data

§

type Error = <B as Body>::Error

§

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

§

type Data = <B as Body>::Data

§

type Error = <B as Body>::Error

§

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

§

type Data = <B as Body>::Data

§

type Error = <B as Body>::Error

§

impl<B> Body for Collected<B>
where B: Buf,

§

type Data = B

§

type Error = Infallible

§

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

§

type Data = <B as Body>::Data

§

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

§

impl<B, C, OnBodyChunkT, OnEosT, OnFailureT> Body for ResponseBody<B, C, OnBodyChunkT, OnEosT, OnFailureT>
where B: Body, <B as Body>::Error: Display, C: ClassifyEos, OnEosT: OnEos, OnBodyChunkT: OnBodyChunk<<B as Body>::Data>, OnFailureT: OnFailure<<C as ClassifyEos>::FailureClass>,

§

type Data = <B as Body>::Data

§

type Error = <B as Body>::Error

§

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

§

type Data = B2

§

type Error = <B as Body>::Error

§

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

§

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

§

type Data = D

§

type Error = Infallible

§

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

§

type Data = D

§

type Error = Infallible

§

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

§

type Data = D

§

type Error = E

§

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

§

type Data = D

§

type Error = E

§

impl<L, R, Data> Body for Either<L, R>
where L: Body<Data = Data>, R: Body<Data = Data>, <L as Body>::Error: Into<Box<dyn Error + Send + Sync>>, <R as Body>::Error: Into<Box<dyn Error + Send + Sync>>, Data: Buf,

§

type Data = Data

§

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

§

impl<S, D, E> Body for StreamBody<S>
where S: Stream<Item = Result<Frame<D>, E>>, D: Buf,

§

type Data = D

§

type Error = E

§

impl<T> Body for AsyncReadBody<T>
where T: AsyncRead,

§

type Data = Bytes

§

type Error = Error

§

impl<T, F> Body for WithTrailers<T, F>
where T: Body, F: Future<Output = Option<Result<HeaderMap, <T as Body>::Error>>>,

§

type Data = <T as Body>::Data

§

type Error = <T as Body>::Error