Trait StreamingBody 

pub trait StreamingBody {
    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 { ... }
}

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 frame of this stream.

Return value

This function returns:

• Poll::Pending if the next frame is not ready yet.
• Poll::Ready(Some(Ok(frame))) when the next frame is available.
• Poll::Ready(Some(Err(error))) when an error has been reached.
• Poll::Ready(None) means that all of the frames in this stream have been returned, and that the end of the stream has been reached.

If Poll::Ready(Some(Err(error))) is returned, this body should be discarded.

Once the end of the stream is reached, implementations should continue to return Poll::Ready(None).

Provided Methods

fn is_end_stream(&self) -> bool

A hint that may return 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. Combinators or other implementations may not be able to know the end of stream has been reached for this hint.

Returning true allows consumers of this body to optimize, such as not calling poll_frame again.

fn size_hint(&self) -> SizeHint

A hint that 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.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

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<B> Body for RamaBody<B>

where B: Body,

type Data = <B as Body>::Data

type Error = RamaBodyError<<B as Body>::Error>

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

type Data = Bytes

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

impl Body for BodyDataStream

type Data = Bytes

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

impl Body for RetryBody

type Data = Bytes

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

impl<A, B, C, D, Data> Body for Either4<A, B, C, D>

where A: Body<Data = Data>, B: Body<Data = Data>, C: Body<Data = Data>, D: Body<Data = Data>, <A as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <C as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <D as Body>::Error: Into<Box<dyn Error + Sync + Send>>, Data: Buf,

type Data = Data

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

impl<A, B, C, D, E, Data> Body for Either5<A, B, C, D, E>

where A: Body<Data = Data>, B: Body<Data = Data>, C: Body<Data = Data>, D: Body<Data = Data>, E: Body<Data = Data>, <A as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <C as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <D as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <E as Body>::Error: Into<Box<dyn Error + Sync + Send>>, Data: Buf,

type Data = Data

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

impl<A, B, C, D, E, F, Data> Body for Either6<A, B, C, D, E, F>

where A: Body<Data = Data>, B: Body<Data = Data>, C: Body<Data = Data>, D: Body<Data = Data>, E: Body<Data = Data>, F: Body<Data = Data>, <A as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <C as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <D as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <E as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <F as Body>::Error: Into<Box<dyn Error + Sync + Send>>, Data: Buf,

type Data = Data

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

impl<A, B, C, D, E, F, G, Data> Body for Either7<A, B, C, D, E, F, G>

where A: Body<Data = Data>, B: Body<Data = Data>, C: Body<Data = Data>, D: Body<Data = Data>, E: Body<Data = Data>, F: Body<Data = Data>, G: Body<Data = Data>, <A as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <C as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <D as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <E as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <F as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <G as Body>::Error: Into<Box<dyn Error + Sync + Send>>, Data: Buf,

type Data = Data

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

impl<A, B, C, D, E, F, G, H, Data> Body for Either8<A, B, C, D, E, F, G, H>

where A: Body<Data = Data>, B: Body<Data = Data>, C: Body<Data = Data>, D: Body<Data = Data>, E: Body<Data = Data>, F: Body<Data = Data>, G: Body<Data = Data>, H: Body<Data = Data>, <A as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <C as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <D as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <E as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <F as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <G as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <H as Body>::Error: Into<Box<dyn Error + Sync + Send>>, Data: Buf,

type Data = Data

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

impl<A, B, C, D, E, F, G, H, I, Data> Body for Either9<A, B, C, D, E, F, G, H, I>

where A: Body<Data = Data>, B: Body<Data = Data>, C: Body<Data = Data>, D: Body<Data = Data>, E: Body<Data = Data>, F: Body<Data = Data>, G: Body<Data = Data>, H: Body<Data = Data>, I: Body<Data = Data>, <A as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <C as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <D as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <E as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <F as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <G as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <H as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <I as Body>::Error: Into<Box<dyn Error + Sync + Send>>, Data: Buf,

type Data = Data

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

impl<A, B, C, Data> Body for Either3<A, B, C>

where A: Body<Data = Data>, B: Body<Data = Data>, C: Body<Data = Data>, <A as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <C as Body>::Error: Into<Box<dyn Error + Sync + Send>>, Data: Buf,

type Data = Data

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

impl<A, B, Data> Body for Either<A, B>

where A: Body<Data = Data>, B: Body<Data = Data>, <A as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>, Data: Buf,

type Data = Data

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

impl<A, B> Body for Chain<A, B>

where A: Body, B: Body<Data = <A as Body>::Data>, <A as Body>::Error: Into<Box<dyn Error + Sync + Send>>, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>,

type Data = <A as Body>::Data

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

impl<B, C, OnBodyChunkT, OnEosT, OnFailureT> Body for ResponseBody<B, C, OnBodyChunkT, OnEosT, OnFailureT>

where B: StreamingBody<Error: Display>, C: ClassifyEos, OnEosT: OnEos, OnBodyChunkT: OnBodyChunk<B::Data>, OnFailureT: OnFailure<C::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<B, F> Body for InspectErr<B, F>

where B: Body, F: FnMut(&<B as Body>::Error),

type Data = <B as Body>::Data

type Error = <B as Body>::Error

impl<B, F> Body for InspectFrame<B, F>

where B: Body, F: FnMut(&Frame<<B as Body>::Data>),

type Data = <B as Body>::Data

type Error = <B as Body>::Error

impl<B, F> Body for OnDropBody<B, F>

where B: Body, F: FnOnce(),

type Data = <B as Body>::Data

type Error = <B as Body>::Error

impl<B, G> Body for GuardedBody<B, G>

where B: Body,

type Data = <B as Body>::Data

type Error = <B as Body>::Error

impl<B, H> Body for HtmlRewriteBody<B, H>

where B: StreamingBody<Error: Into<BoxError>>, H: ElementContentHandler,

Available on crate feature html only.

type Data = Bytes

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

impl<B, H> Body for JsonCaptureBody<B, H>

where B: StreamingBody<Error: Into<BoxError>>, H: CaptureHandler,

type Data = Bytes

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

impl<B, H> Body for JsonRewriteBody<B, H>

where B: StreamingBody<Error: Into<BoxError>>, H: JsonValueHandler,

type Data = Bytes

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

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

where B: StreamingBody<Data = Bytes, Error: Into<BoxError>> + Send + Sync + 'static,

Available on crate feature opentelemetry only.

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

where B: StreamingBody<Error: Into<BoxError>>,

Available on crate feature compression only.

type Data = Bytes

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

impl<B> Body for DeadlineBody<B>

where B: StreamingBody, B::Error: Into<BoxError>,

type Data = <B as Body>::Data

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

impl<B> Body for DecompressionBody<B>

where B: StreamingBody<Error: Into<BoxError>>,

Available on crate feature compression only.

type Data = Bytes

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

impl<B> Body for Fuse<B>

where B: Body + Unpin,

type Data = <B as Body>::Data

type Error = <B as Body>::Error

impl<B> Body for Limited<B>

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

type Data = <B as Body>::Data

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

impl<B> Body for OptionalBody<B>

where B: Body,

type Data = <B as Body>::Data

type Error = <B as Body>::Error

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

where B: StreamingBody, B::Data: Buf, B::Error: Into<BoxError>,

Available on crate feature compression only.

type Data = Bytes

type Error = Error

impl<B> Body for TimeoutBody<B>

where B: StreamingBody, B::Error: Into<BoxError>,

type Data = <B as Body>::Data

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

impl<D, E> Body for BoxBody<D, E>

where D: Buf,

type Data = D

type Error = E

impl<D, E> Body for Channel<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<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<S, D, E> Body for StreamBody<S>

where S: Stream<Item = Result<Frame<D>, E>>, D: Buf,

type Data = D

type Error = E

impl<S, E, T> Body for SseResponseBody<S>

where S: Stream<Item = Result<Event<T>, E>>, E: Into<Box<dyn Error + Sync + Send>>, T: EventDataWrite,

type Data = Bytes

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

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

impl<T> Body for AsyncReadBody<T>

where T: AsyncRead,

type Data = Bytes

type Error = Error