Struct axum_extra::extract::OptionalPath

pub struct OptionalPath<T>(pub Option<T>);

Extractor that extracts path arguments the same way as Path, except if there aren’t any.

This extractor can be used in place of Path when you have two routes that you want to handle in mostly the same way, where one has a path parameter and the other one doesn’t.

Example

use std::num::NonZeroU32;
use axum::{
    response::IntoResponse,
    routing::get,
    Router,
};
use axum_extra::extract::OptionalPath;

async fn render_blog(OptionalPath(page): OptionalPath<NonZeroU32>) -> impl IntoResponse {
    // Convert to u32, default to page 1 if not specified
    let page = page.map_or(1, |param| param.get());
    // ...
}

let app = Router::new()
    .route("/blog", get(render_blog))
    .route("/blog/:page", get(render_blog));

Tuple Fields

0: Option<T>

Trait Implementations

impl<T: Debug> Debug for OptionalPath<T>

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

Formats the value using the given formatter.

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

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

type Rejection = PathRejection

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, _: &'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.