Struct axum::extract::RequestParts

source · [−]

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

Expand description

The type used with FromRequest to extract data from requests.

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

Implementations

source

impl RequestParts

source

pub fn new(req: Request) -> RequestParts

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.

source

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

source

pub fn method(&self) -> &Method

Gets a reference the request method.

source

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

Gets a mutable reference to the request method.

source

pub fn uri(&self) -> &Uri

Gets a reference the request URI.

source

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

Gets a mutable reference to the request URI.

source

pub fn version(&self) -> Version

Get the request HTTP version.

source

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

Gets a mutable reference to the request HTTP version.

source

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

Gets a reference to the request headers.

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

source

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

Gets a mutable reference to the request headers.

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

source

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

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

source

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

Gets a reference to the request extensions.

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

source

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.

source

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

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

source

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

Gets a reference to the request body.

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

source

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.

source

pub fn take_body(&mut self) -> Option

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

Trait Implementations

source

impl Debug for RequestParts where
B: Debug,

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for RequestParts

impl Send for RequestParts where
B: Send,

impl Sync for RequestParts where
B: Sync,

impl Unpin for RequestParts where
B: Unpin,

impl !UnwindSafe for RequestParts

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> PolicyExt for T where
T: ?Sized,

source

pub fn and<P, B, E>(self, other: P) -> And<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

source

pub fn or<P, B, E>(self, other: P) -> Or<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct axum::extract::RequestParts

Implementations

impl<B> RequestParts<B>

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

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

pub fn method(&self) -> &Method

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

pub fn uri(&self) -> &Uri

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

pub fn version(&self) -> Version

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

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

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

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

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

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

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

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

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

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

Trait Implementations

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

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

Auto Trait Implementations

impl<B> !RefUnwindSafe for RequestParts<B>

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

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

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

impl<B> !UnwindSafe for RequestParts<B>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> PolicyExt for T where T: ?Sized,

pub fn and<P, B, E>(self, other: P) -> And<T, P> where T: Policy<B, E>, P: Policy<B, E>,

pub fn or<P, B, E>(self, other: P) -> Or<T, P> where T: Policy<B, E>, P: Policy<B, E>,

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> PolicyExt for T where
T: ?Sized,

pub fn and<P, B, E>(self, other: P) -> And<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

pub fn or<P, B, E>(self, other: P) -> Or<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,