Type Alias axum_core::body::BoxBody

pub type BoxBody = UnsyncBoxBody<Bytes, Error>;

A boxed Body trait object.

This is used in axum as the response body type for applications. It’s necessary to unify multiple response bodies types into one.

Aliased Type

struct BoxBody { /* private fields */ }

Implementations

impl<D, E> UnsyncBoxBody<D, E>

pub fn new<B>(body: B) -> UnsyncBoxBody<D, E>

where B: Body<Data = D, Error = E> + Send + 'static, D: Buf,

Create a new BoxBody.

Trait Implementations

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

where D: Buf,

type Data = D

Values yielded by the Body.

type Error = E

The error type this Body might generate.

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

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

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

Poll for an optional single HeaderMap of trailers.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

fn data(&mut self) -> Data<'_, Self>

where Self: Sized + Unpin,

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

fn trailers(&mut self) -> Trailers<'_, Self>

where Self: Sized + Unpin,

Returns future that resolves to trailers, if any.

fn map_data<F, B>(self, f: F) -> MapData<Self, F>

where Self: Sized, F: FnMut(Self::Data) -> B, B: Buf,

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

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>

where Self: Sized, F: FnMut(Self::Error) -> E,

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

fn collect(self) -> Collect<Self>

where Self: Sized,

Turn this body into Collected body which will collect all the DATA frames and trailers.

fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>

where Self: Sized + Send + 'static,

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

impl<D, E> Debug for UnsyncBoxBody<D, E>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<D, E> Default for UnsyncBoxBody<D, E>

where D: Buf + 'static,

fn default() -> UnsyncBoxBody<D, E>

Returns the “default value” for a type.

impl<E> IntoResponse for UnsyncBoxBody<Bytes, E>

where E: Into<BoxError> + 'static,

fn into_response(self) -> Response

Create a response.