pavex::response::body::raw

Trait RawBody

pub trait RawBody {
    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 Response body.

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<B> Body for BodyStream<B>
where B: Body,

§

type Data = <B as Body>::Data

§

type Error = <B as Body>::Error

§

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

§

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

§

type Data = B

§

type Error = Infallible

§

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

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

§

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

§

type Data = <B as Body>::Data

§

type Error = <B as Body>::Error

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

§

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

§

type Data = <B as Body>::Data

§

type Error = <B as Body>::Error

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

§

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

§

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

§

fn is_end_stream(&self) -> bool

§

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

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

§

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

§

type Data = D

§

type Error = E

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

§

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

§

type Data = D

§

type Error = E

§

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

§

fn is_end_stream(&self) -> bool

§

fn size_hint(&self) -> SizeHint

§

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 + Sync + Send>>, <R as Body>::Error: Into<Box<dyn Error + Sync + Send>>, Data: Buf,

§

type Data = Data

§

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

§

fn poll_frame( self: Pin<&mut Either<L, R>>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<<Either<L, R> as Body>::Data>, <Either<L, R> 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<S, D, E> Body for StreamBody<S>
where S: Stream<Item = Result<Frame<D>, E>>, D: Buf,

§

type Data = D

§

type Error = E

§

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

§

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

§

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

§

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

§

fn size_hint(&self) -> SizeHint

Implementors§

source§

impl Body for RawIncomingBody

source§

type Data = <Incoming as Body>::Data

source§

type Error = <Incoming as Body>::Error

source§

impl Body for ResponseBody

§

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