pub struct Path<T>(/* private fields */);
Expand description
Extract typed data from request path segments.
Use PathConfig
to configure extraction option.
Unlike, HttpRequest::match_info
, this extractor will fully percent-decode dynamic segments,
including /
, %
, and +
.
§Examples
use actix_web::{get, web};
// extract path info from "/{name}/{count}/index.html" into tuple
// {name} - deserialize a String
// {count} - deserialize a u32
#[get("/{name}/{count}/index.html")]
async fn index(path: web::Path<(String, u32)>) -> String {
let (name, count) = path.into_inner();
format!("Welcome {}! {}", name, count)
}
Path segments also can be deserialized into any type that implements serde::Deserialize
.
Path segment labels will be matched with struct field names.
use actix_web::{get, web};
use serde::Deserialize;
#[derive(Deserialize)]
struct Info {
name: String,
}
// extract `Info` from a path using serde
#[get("/{name}")]
async fn index(info: web::Path<Info>) -> String {
format!("Welcome {}!", info.name)
}
Implementations§
source§impl<T> Path<T>
impl<T> Path<T>
sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Unwrap into inner T
value.
Trait Implementations§
source§impl<T> FromRequest for Path<T>where
T: DeserializeOwned,
impl<T> FromRequest for Path<T>where
T: DeserializeOwned,
See here for example of usage as an extractor.
§type Future = Ready<Result<Path<T>, <Path<T> as FromRequest>::Error>>
type Future = Ready<Result<Path<T>, <Path<T> as FromRequest>::Error>>
Future that resolves to a
Self
. Read moresource§fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
Create a
Self
from request parts asynchronously.source§impl<T: Ord> Ord for Path<T>
impl<T: Ord> Ord for Path<T>
source§impl<T: PartialEq> PartialEq for Path<T>
impl<T: PartialEq> PartialEq for Path<T>
source§impl<T: PartialOrd> PartialOrd for Path<T>
impl<T: PartialOrd> PartialOrd for Path<T>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moreimpl<T: Eq> Eq for Path<T>
impl<T> StructuralPartialEq for Path<T>
Auto Trait Implementations§
impl<T> Freeze for Path<T>where
T: Freeze,
impl<T> RefUnwindSafe for Path<T>where
T: RefUnwindSafe,
impl<T> Send for Path<T>where
T: Send,
impl<T> Sync for Path<T>where
T: Sync,
impl<T> Unpin for Path<T>where
T: Unpin,
impl<T> UnwindSafe for Path<T>where
T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.