Trait FromRequestParts 

pub trait FromRequestParts<S>: Sized {
    type Rejection: IntoResponse;

    // Required method
    fn from_request_parts(
        parts: &mut Parts,
        state: &S,
    ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send;
}

Types that can be created from request parts.

Extractors that implement FromRequestParts cannot consume the request body and can thus be run in any order for handlers.

If your extractor needs to consume the request body then you should implement FromRequest and not FromRequestParts.

See axum::extract for more general docs about extractors.

Required Associated Types

type Rejection: IntoResponse

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

Required Methods

fn from_request_parts( parts: &mut Parts, state: &S, ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send

Perform the extraction.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl<S, E1, E2, E3, E4, E5, E6, E7, E8> FromRequestParts<S> for Either8<E1, E2, E3, E4, E5, E6, E7, E8>

where E1: FromRequestParts<S>, E2: FromRequestParts<S>, E3: FromRequestParts<S>, E4: FromRequestParts<S>, E5: FromRequestParts<S>, E6: FromRequestParts<S>, E7: FromRequestParts<S>, E8: FromRequestParts<S>, S: Send + Sync,

type Rejection = <E8 as FromRequestParts<S>>::Rejection

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Either8<E1, E2, E3, E4, E5, E6, E7, E8>, <Either8<E1, E2, E3, E4, E5, E6, E7, E8> as FromRequestParts<S>>::Rejection>

impl<S, E1, E2, E3, E4, E5, E6, E7> FromRequestParts<S> for Either7<E1, E2, E3, E4, E5, E6, E7>

where E1: FromRequestParts<S>, E2: FromRequestParts<S>, E3: FromRequestParts<S>, E4: FromRequestParts<S>, E5: FromRequestParts<S>, E6: FromRequestParts<S>, E7: FromRequestParts<S>, S: Send + Sync,

type Rejection = <E7 as FromRequestParts<S>>::Rejection

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Either7<E1, E2, E3, E4, E5, E6, E7>, <Either7<E1, E2, E3, E4, E5, E6, E7> as FromRequestParts<S>>::Rejection>

impl<S, E1, E2, E3, E4, E5, E6> FromRequestParts<S> for Either6<E1, E2, E3, E4, E5, E6>

where E1: FromRequestParts<S>, E2: FromRequestParts<S>, E3: FromRequestParts<S>, E4: FromRequestParts<S>, E5: FromRequestParts<S>, E6: FromRequestParts<S>, S: Send + Sync,

type Rejection = <E6 as FromRequestParts<S>>::Rejection

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Either6<E1, E2, E3, E4, E5, E6>, <Either6<E1, E2, E3, E4, E5, E6> as FromRequestParts<S>>::Rejection>

impl<S, E1, E2, E3, E4, E5> FromRequestParts<S> for Either5<E1, E2, E3, E4, E5>

where E1: FromRequestParts<S>, E2: FromRequestParts<S>, E3: FromRequestParts<S>, E4: FromRequestParts<S>, E5: FromRequestParts<S>, S: Send + Sync,

type Rejection = <E5 as FromRequestParts<S>>::Rejection

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Either5<E1, E2, E3, E4, E5>, <Either5<E1, E2, E3, E4, E5> as FromRequestParts<S>>::Rejection>

impl<S, E1, E2, E3, E4> FromRequestParts<S> for Either4<E1, E2, E3, E4>

where E1: FromRequestParts<S>, E2: FromRequestParts<S>, E3: FromRequestParts<S>, E4: FromRequestParts<S>, S: Send + Sync,

type Rejection = <E4 as FromRequestParts<S>>::Rejection

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Either4<E1, E2, E3, E4>, <Either4<E1, E2, E3, E4> as FromRequestParts<S>>::Rejection>

impl<S, E1, E2, E3> FromRequestParts<S> for Either3<E1, E2, E3>

where E1: FromRequestParts<S>, E2: FromRequestParts<S>, E3: FromRequestParts<S>, S: Send + Sync,

type Rejection = <E3 as FromRequestParts<S>>::Rejection

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Either3<E1, E2, E3>, <Either3<E1, E2, E3> as FromRequestParts<S>>::Rejection>

impl<S, E1, E2> FromRequestParts<S> for Either<E1, E2>

where E1: FromRequestParts<S>, E2: FromRequestParts<S>, S: Send + Sync,

type Rejection = <E2 as FromRequestParts<S>>::Rejection

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Either<E1, E2>, <Either<E1, E2> as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, T7: FromRequestParts<S> + Send, T8: FromRequestParts<S> + Send, T9: FromRequestParts<S> + Send, T10: FromRequestParts<S> + Send, T11: FromRequestParts<S> + Send, T12: FromRequestParts<S> + Send, T13: FromRequestParts<S> + Send, T14: FromRequestParts<S> + Send, T15: FromRequestParts<S> + Send, T16: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16), <(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, T7: FromRequestParts<S> + Send, T8: FromRequestParts<S> + Send, T9: FromRequestParts<S> + Send, T10: FromRequestParts<S> + Send, T11: FromRequestParts<S> + Send, T12: FromRequestParts<S> + Send, T13: FromRequestParts<S> + Send, T14: FromRequestParts<S> + Send, T15: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15), <(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, T7: FromRequestParts<S> + Send, T8: FromRequestParts<S> + Send, T9: FromRequestParts<S> + Send, T10: FromRequestParts<S> + Send, T11: FromRequestParts<S> + Send, T12: FromRequestParts<S> + Send, T13: FromRequestParts<S> + Send, T14: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14), <(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, T7: FromRequestParts<S> + Send, T8: FromRequestParts<S> + Send, T9: FromRequestParts<S> + Send, T10: FromRequestParts<S> + Send, T11: FromRequestParts<S> + Send, T12: FromRequestParts<S> + Send, T13: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13), <(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, T7: FromRequestParts<S> + Send, T8: FromRequestParts<S> + Send, T9: FromRequestParts<S> + Send, T10: FromRequestParts<S> + Send, T11: FromRequestParts<S> + Send, T12: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12), <(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, T7: FromRequestParts<S> + Send, T8: FromRequestParts<S> + Send, T9: FromRequestParts<S> + Send, T10: FromRequestParts<S> + Send, T11: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11), <(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, T7: FromRequestParts<S> + Send, T8: FromRequestParts<S> + Send, T9: FromRequestParts<S> + Send, T10: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10), <(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6, T7, T8, T9)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, T7: FromRequestParts<S> + Send, T8: FromRequestParts<S> + Send, T9: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9), <(T1, T2, T3, T4, T5, T6, T7, T8, T9) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6, T7, T8> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6, T7, T8)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, T7: FromRequestParts<S> + Send, T8: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8), <(T1, T2, T3, T4, T5, T6, T7, T8) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6, T7> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6, T7)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, T7: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6, T7), <(T1, T2, T3, T4, T5, T6, T7) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5, T6> FromRequestParts<S> for (T1, T2, T3, T4, T5, T6)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, T6: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5, T6), <(T1, T2, T3, T4, T5, T6) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4, T5> FromRequestParts<S> for (T1, T2, T3, T4, T5)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, T5: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4, T5), <(T1, T2, T3, T4, T5) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3, T4> FromRequestParts<S> for (T1, T2, T3, T4)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, T4: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3, T4), <(T1, T2, T3, T4) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2, T3> FromRequestParts<S> for (T1, T2, T3)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, T3: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2, T3), <(T1, T2, T3) as FromRequestParts<S>>::Rejection>

impl<S, T1, T2> FromRequestParts<S> for (T1, T2)

where T1: FromRequestParts<S> + Send, T2: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1, T2), <(T1, T2) as FromRequestParts<S>>::Rejection>

impl<S, T1> FromRequestParts<S> for (T1,)

where T1: FromRequestParts<S> + Send, S: Send + Sync,

type Rejection = Response<Body>

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<(T1,), <(T1,) as FromRequestParts<S>>::Rejection>

impl<S, T> FromRequestParts<S> for Option<T>

where T: OptionalFromRequestParts<S>, S: Send + Sync,

type Rejection = <T as OptionalFromRequestParts<S>>::Rejection

fn from_request_parts( parts: &mut Parts, state: &S, ) -> impl Future<Output = Result<Option<T>, <Option<T> as FromRequestParts<S>>::Rejection>>

impl<S, T> FromRequestParts<S> for Result<T, <T as FromRequestParts<S>>::Rejection>

where T: FromRequestParts<S>, S: Send + Sync,

type Rejection = Infallible

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Result<T, <T as FromRequestParts<S>>::Rejection>, <Result<T, <T as FromRequestParts<S>>::Rejection> as FromRequestParts<S>>::Rejection>

impl<S> FromRequestParts<S> for ()

where S: Send + Sync,

type Rejection = Infallible

async fn from_request_parts( _: &mut Parts, _: &S, ) -> Result<(), <() as FromRequestParts<S>>::Rejection>

impl<S> FromRequestParts<S> for Extensions

where S: Send + Sync,

type Rejection = Infallible

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Extensions, <Extensions as FromRequestParts<S>>::Rejection>

impl<S> FromRequestParts<S> for HeaderMap

where S: Send + Sync,

Clone the headers from the request.

Prefer using TypedHeader to extract only the headers you need.

type Rejection = Infallible

async fn from_request_parts( parts: &mut Parts, _: &S, ) -> Result<HeaderMap, <HeaderMap as FromRequestParts<S>>::Rejection>

impl<S> FromRequestParts<S> for Host

where S: Send + Sync,

type Rejection = HostRejection

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Host, <Host as FromRequestParts<S>>::Rejection>

impl<S> FromRequestParts<S> for Method

where S: Send + Sync,

type Rejection = Infallible

async fn from_request_parts( parts: &mut Parts, _: &S, ) -> Result<Method, <Method as FromRequestParts<S>>::Rejection>

impl<S> FromRequestParts<S> for Parts

where S: Send + Sync,

type Rejection = Infallible

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Parts, <Parts as FromRequestParts<S>>::Rejection>

impl<S> FromRequestParts<S> for Uri

where S: Send + Sync,

type Rejection = Infallible

async fn from_request_parts( parts: &mut Parts, _: &S, ) -> Result<Uri, <Uri as FromRequestParts<S>>::Rejection>

impl<S> FromRequestParts<S> for Version

where S: Send + Sync,

type Rejection = Infallible

async fn from_request_parts( parts: &mut Parts, _: &S, ) -> Result<Version, <Version as FromRequestParts<S>>::Rejection>

impl<T, S> FromRequestParts<S> for OptionalQuery<T>

where T: DeserializeOwned, S: Send + Sync,

type Rejection = OptionalQueryRejection

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<OptionalQuery<T>, <OptionalQuery<T> as FromRequestParts<S>>::Rejection>

Implementors

impl<OuterState, InnerState> FromRequestParts<OuterState> for State<InnerState>

where InnerState: FromRef<OuterState>, OuterState: Send + Sync,

type Rejection = Infallible

impl<S, T> FromRequestParts<S> for ConnectInfo<T>

where S: Send + Sync, T: Clone + Send + Sync + 'static,

type Rejection = <Extension<ConnectInfo<T>> as FromRequestParts<S>>::Rejection

impl<S> FromRequestParts<S> for NestedPath

where S: Send + Sync,

type Rejection = NestedPathRejection

impl<S> FromRequestParts<S> for RawPathParams

where S: Send + Sync,

type Rejection = RawPathParamsRejection

impl<S> FromRequestParts<S> for RawQuery

where S: Send + Sync,

type Rejection = Infallible

impl<T, S> FromRequestParts<S> for Extension<T>

where T: Clone + Send + Sync + 'static, S: Send + Sync,

type Rejection = ExtensionRejection

impl<T, S> FromRequestParts<S> for Path<T>

where T: DeserializeOwned + Send, S: Send + Sync,

type Rejection = PathRejection

impl<T, S> FromRequestParts<S> for Query<T>

where T: DeserializeOwned, S: Send + Sync,

type Rejection = QueryRejection