Struct axum_template::Key

pub struct Key(pub String);

Extracts matched path of the request

Usage

async fn handler(
    Key(key): Key
) -> impl IntoResponse
{
    key
}

let router: Router<()> = Router::new()
    // key == "/some/route"
    .route("/some/route", get(handler))
    // key == "/:dynamic"
    .route("/:dynamic", get(handler));

Additional resources

• MatchedPath
• Example: custom_key.rs

Tuple Fields

0: String

Trait Implementations

impl AsRef<str> for Key

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl From<String> for Key

fn from(s: String) -> Self

Converts to this type from the input type.

impl<S> FromRequestParts<S> for Key

where S: Send + Sync,

type Rejection = MatchedPathRejection

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.

impl PartialEq for Key

fn eq(&self, other: &Key) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Key

impl StructuralPartialEq for Key