Struct actix_web::Path

pub struct Path<T> { /* fields omitted */ }

Extract typed information from the request's path.

Example

use actix_web::{App, Path, Result, http};

/// extract path info from "/{username}/{count}/index.html" url
/// {username} - deserializes to a String
/// {count} -  - deserializes to a u32
fn index(info: Path<(String, u32)>) -> Result<String> {
    Ok(format!("Welcome {}! {}", info.0, info.1))
}

fn main() {
    let app = App::new().resource(
       "/{username}/{count}/index.html",              // <- define path parameters
       |r| r.method(http::Method::GET).with(index));  // <- use `with` extractor
}

It is possible to extract path information to a specific type that implements Deserialize trait from serde.

#[macro_use] extern crate serde_derive;
use actix_web::{App, Path, Result, http};

#[derive(Deserialize)]
struct Info {
    username: String,
}

/// extract path info using serde
fn index(info: Path<Info>) -> Result<String> {
    Ok(format!("Welcome {}!", info.username))
}

fn main() {
    let app = App::new().resource(
       "/{username}/index.html",                // <- define path parameters
       |r| r.method(http::Method::GET).with(index));  // <- use `with` extractor
}

Methods

impl<T> Path<T>

pub fn into_inner(self) -> T

Deconstruct to an inner value

Trait Implementations

impl<T> AsRef<T> for Path<T>

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn as_ref(&self) -> &T

Performs the conversion.

impl<T> Deref for Path<T>

type Target = T

The resulting type after dereferencing.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Path<T>

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T, S> FromRequest<S> for Path<T> where
    T: DeserializeOwned, 

type Config = ()

Configuration for conversion process

type Result = Result<Self, Error>

Future that resolves to a Self

fn from_request(req: &HttpRequest<S>, _: &Self::Config) -> Self::Result

Convert request to a Self

fn extract(req: &HttpRequest<S>) -> Self::Result

Convert request to a Self