Struct axum::extract::RequestParts

pub struct RequestParts<B> { /* private fields */ }

The type used with FromRequest to extract data from requests.

Has several convenience methods for getting owned parts of the request.

Implementations

impl<B> RequestParts<B>

pub fn new(req: Request<B>) -> RequestParts<B>

Create a new RequestParts.

You generally shouldn’t need to construct this type yourself, unless using extractors outside of axum for example to implement a tower::Service.

pub async fn extract<E>(
    &mut self
) -> impl Future<Output = Result<E, <E as FromRequest<B>>::Rejection>> where
    E: FromRequest<B>, 

Apply an extractor to this RequestParts.

req.extract::<Extractor>() is equivalent to Extractor::from_request(req). This function simply exists as a convenience.

Example

use std::convert::Infallible;

use async_trait::async_trait;
use axum::extract::{FromRequest, RequestParts};
use http::{Method, Uri};

#[async_trait]
impl<B: Send> FromRequest<B> for MyExtractor {
    type Rejection = Infallible;

    async fn from_request(req: &mut RequestParts<B>) -> Result<Self, Infallible> {
        let method = req.extract::<Method>().await?;
        let path = req.extract::<Uri>().await?.path().to_owned();

        todo!()
    }
}

pub fn try_into_request(self) -> Result<Request<B>, BodyAlreadyExtracted>

Convert this RequestParts back into a Request.

Fails if The request body has been extracted, that is take_body has been called.

pub fn method(&self) -> &Method

Gets a reference to the request method.

pub fn method_mut(&mut self) -> &mut Method

Gets a mutable reference to the request method.

pub fn uri(&self) -> &Uri

Gets a reference to the request URI.

pub fn uri_mut(&mut self) -> &mut Uri

Gets a mutable reference to the request URI.

pub fn version(&self) -> Version

Get the request HTTP version.

pub fn version_mut(&mut self) -> &mut Version

Gets a mutable reference to the request HTTP version.

pub fn headers(&self) -> &HeaderMap<HeaderValue>

Gets a reference to the request headers.

pub fn headers_mut(&mut self) -> &mut HeaderMap<HeaderValue>

Gets a mutable reference to the request headers.

pub fn extensions(&self) -> &Extensions

Gets a reference to the request extensions.

pub fn extensions_mut(&mut self) -> &mut Extensions

Gets a mutable reference to the request extensions.

pub fn body(&self) -> Option<&B>

Gets a reference to the request body.

Returns None if the body has been taken by another extractor.

pub fn body_mut(&mut self) -> &mut Option<B>

Gets a mutable reference to the request body.

Returns None if the body has been taken by another extractor.

pub fn take_body(&mut self) -> Option<B>

Takes the body out of the request, leaving a None in its place.

Trait Implementations

impl<B> Debug for RequestParts<B> where
    B: Debug, 

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

Formats the value using the given formatter.