Struct axum_core::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>) -> Self

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 fn try_into_request(self) -> Result<Request<B>, Error>

Convert this RequestParts back into a Request.

Fails if

• The full HeaderMap has been extracted, that is take_headers have been called.
• The full Extensions has been extracted, that is take_extensions have been called.
• The request body has been extracted, that is take_body have been called.

pub fn method(&self) -> &Method

Gets a reference 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 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) -> Option<&HeaderMap>

Gets a reference to the request headers.

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

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

Gets a mutable reference to the request headers.

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

pub fn take_headers(&mut self) -> Option<HeaderMap>

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

pub fn extensions(&self) -> Option<&Extensions>

Gets a reference to the request extensions.

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

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

Gets a mutable reference to the request extensions.

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

pub fn take_extensions(&mut self) -> Option<Extensions>

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

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) -> Option<&mut 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> Debug for RequestParts<B>

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

Formats the value using the given formatter.