Struct Body

pub struct Body(/* private fields */);

The body type used in axum requests and responses.

Implementations

impl Body

pub fn new<B>(body: B) -> Self

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

Create a new Body that wraps another http_body::Body.

pub fn empty() -> Self

Create an empty body.

pub fn from_stream<S>(stream: S) -> Self

where S: TryStream + Send + 'static, S::Ok: Into<Bytes>, S::Error: Into<BoxError>,

Create a new Body from a Stream.

pub fn into_data_stream(self) -> BodyDataStream

Convert the body into a Stream of data frames.

Non-data frames (such as trailers) will be discarded. Use http_body_util::BodyStream if you need a Stream of all frame types.

Trait Implementations

impl Body for Body

type Data = Bytes

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

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.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

impl Debug for Body

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

Formats the value using the given formatter.

impl Default for Body

fn default() -> Self

Returns the “default value” for a type.

impl From<&'static [u8]> for Body

fn from(buf: &'static [u8]) -> Self

Converts to this type from the input type.

impl From<&'static str> for Body

fn from(buf: &'static str) -> Self

Converts to this type from the input type.

impl From<()> for Body

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<Bytes> for Body

fn from(buf: Bytes) -> Self

Converts to this type from the input type.

impl From<Cow<'static, [u8]>> for Body

fn from(buf: Cow<'static, [u8]>) -> Self

Converts to this type from the input type.

impl From<Cow<'static, str>> for Body

fn from(buf: Cow<'static, str>) -> Self

Converts to this type from the input type.

impl From<String> for Body

fn from(buf: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Body

fn from(buf: Vec<u8>) -> Self

Converts to this type from the input type.

impl<S> FromRequest<S> for Body

where S: Send + Sync,

type Rejection = Infallible

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request<'life0, 'async_trait>( req: Request, _: &'life0 S, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Perform the extraction.

impl IntoResponse for Body

fn into_response(self) -> Response

Create a response.