Struct Path 

pub struct Path<T>(pub T);

Typed path-parameter extractor (axum parity).

T may be a single primitive (Path<u64>), a tuple (Path<(u64, String)>), a Vec<T> for repeated captures, an Option<T> (None when no captures matched), or a struct deriving serde::Deserialize.

Internally delegates to the path-params deserializer in tako-core, which has been extended in v2 to support tuples, sequences, and primitive destructuring on top of the original struct/map mode.

Examples

use tako::extractors::path::Path;

// Single primitive
async fn by_id(Path(id): Path<u64>) -> String { format!("id={id}") }

// Tuple
async fn pair(Path((a, b)): Path<(String, u32)>) -> String { format!("{a}/{b}") }

// Struct
#[derive(serde::Deserialize)]
struct UserKey { tenant: String, user_id: u64 }
async fn user(Path(key): Path<UserKey>) -> String {
  format!("{}:{}", key.tenant, key.user_id)
}

Tuple Fields

0: T

Trait Implementations

impl<'a, T> FromRequest<'a> for Path<T>

where T: DeserializeOwned + Send + 'a,

type Error = ParamsError

Error type returned when extraction fails.

fn from_request( req: &'a mut Request<TakoBody>, ) -> impl Future<Output = Result<Path<T>, <Path<T> as FromRequest<'a>>::Error>> + Send + 'a

Extracts the type from the HTTP request.

impl<'a, T> FromRequestParts<'a> for Path<T>

where T: DeserializeOwned + Send + 'a,

type Error = ParamsError

Error type returned when extraction fails.

fn from_request_parts( parts: &'a mut Parts, ) -> impl Future<Output = Result<Path<T>, <Path<T> as FromRequestParts<'a>>::Error>> + Send + 'a

Extracts the type from the HTTP request parts.