Struct WithRejection

pub struct WithRejection<E, R>(pub E, pub PhantomData<R>);

Extractor for customizing extractor rejections

WithRejection wraps another extractor and gives you the result. If the extraction fails, the Rejection is transformed into R and returned as a response

E is expected to implement FromRequest

R is expected to implement IntoResponse and From<E::Rejection>

Example

use axum::extract::rejection::JsonRejection;
use axum::response::{Response, IntoResponse};
use axum::Json;
use axum_extra::extract::WithRejection;
use serde::Deserialize;

struct MyRejection { /* ... */ }

impl From<JsonRejection> for MyRejection {
    fn from(rejection: JsonRejection) -> MyRejection {
        // ...
    }
}

impl IntoResponse for MyRejection {
    fn into_response(self) -> Response {
        // ...
    }
}
#[derive(Debug, Deserialize)]
struct Person { /* ... */ }

async fn handler(
    // If the `Json` extractor ever fails, `MyRejection` will be sent to the
    // client using the `IntoResponse` impl
    WithRejection(Json(Person), _): WithRejection<Json<Person>, MyRejection>
) { /* ... */ }

Tuple Fields

0: E

1: PhantomData<R>

Implementations

impl<E, R> WithRejection<E, R>

pub fn into_inner(self) -> E

Returns the wrapped extractor

Trait Implementations

impl<E, R> Clone for WithRejection<E, R>

where E: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E, R> Debug for WithRejection<E, R>

where E: Debug,

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

Formats the value using the given formatter.

impl<E: Default, R> Default for WithRejection<E, R>

fn default() -> Self

Returns the “default value” for a type.

impl<E, R> Deref for WithRejection<E, R>

type Target = E

The resulting type after dereferencing.

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

Dereferences the value.

impl<E, R> DerefMut for WithRejection<E, R>

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

Mutably dereferences the value.

impl<E, R> Display for WithRejection<E, R>

where E: Display,

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

Formats the value using the given formatter.

impl<E, R, S> FromRequest<S> for WithRejection<E, R>

where S: Send + Sync, E: FromRequest<S>, R: From<E::Rejection> + IntoResponse,

type Rejection = R

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, state: &'life0 S, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Perform the extraction.

impl<E, R, S> FromRequestParts<S> for WithRejection<E, R>

where S: Send + Sync, E: FromRequestParts<S>, R: From<E::Rejection> + IntoResponse,

type Rejection = R

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_parts<'life0, 'life1, 'async_trait>( parts: &'life0 mut Parts, state: &'life1 S, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform the extraction.

impl<E, R> TypedPath for WithRejection<E, R>

where E: TypedPath,

Available on crate feature typed-routing only.

const PATH: &'static str = E::PATH

The path with optional captures such as /users/:id.

fn to_uri(&self) -> Uri

Convert the path into a Uri.

fn with_query_params<T>(self, params: T) -> WithQueryParams<Self, T>

where T: Serialize, Self: Sized,

Add query parameters to a path.

impl<E, R> Copy for WithRejection<E, R>

where E: Copy,