Struct axum::extract::UrlParamsMap

pub struct UrlParamsMap(_);

Extractor that will get captures from the URL.

Example

use axum::prelude::*;

async fn users_show(params: extract::UrlParamsMap) {
    let id: Option<&str> = params.get("id");

    // ...
}

let app = route("/users/:id", get(users_show));

Note that you can only have one URL params extractor per handler. If you have multiple it’ll response with 500 Internal Server Error.

Implementations

impl UrlParamsMap

pub fn get(&self, key: &str) -> Option<&str>

Look up the value for a key.

pub fn get_typed<T>(&self, key: &str) -> Option<Result<T, T::Err>> where
    T: FromStr, 

Look up the value for a key and parse it into a value of type T.

Trait Implementations

impl Debug for UrlParamsMap

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

Formats the value using the given formatter.

impl<B> FromRequest<B> for UrlParamsMap where
    B: Send, 

type Rejection = MissingRouteParams

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

Perform the extraction.