Struct axum::extract::RawBody

pub struct RawBody<B = Body>(pub B);

Extractor that extracts the raw request body.

Since extracting the raw request body requires consuming it, the RawBody extractor must be last if there are multiple extractors in a handler. See “the order of extractors”

Example

use axum::{
    extract::RawBody,
    routing::get,
    Router,
};
use futures_util::StreamExt;

async fn handler(RawBody(body): RawBody) {
    // ...
}

let app = Router::new().route("/users", get(handler));

Tuple Fields

0: B

Trait Implementations

impl<B: Clone> Clone for RawBody<B>

fn clone(&self) -> RawBody<B>

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B: Debug> Debug for RawBody<B>

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

Formats the value using the given formatter.

impl<B: Default> Default for RawBody<B>

fn default() -> RawBody<B>

Returns the “default value” for a type.

impl<T> Deref for RawBody<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for RawBody<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<S, B> FromRequest<S, B, ViaRequest> for RawBody<B>where
    B: Send,
    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<B>,
    _state: &'life0 S
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Perform the extraction.