[][src]Struct actix_web::Path

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

Extract typed information from the request's path. Information from the path is URL decoded. Decoding of special characters can be disabled through PathConfig.

Example

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

/// 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::{http, App, Path, Result};

#[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>
[src]

Deconstruct to an inner value

Trait Implementations

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

Configuration for conversion process

Future that resolves to a Self

Convert request to a Self Read more

impl<T: PartialOrd> PartialOrd<Path<T>> for Path<T>
[src]

impl<T: Ord> Ord for Path<T>
[src]

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

impl<T: PartialEq> PartialEq<Path<T>> for Path<T>
[src]

impl<T> From<T> for Path<T>
[src]

impl<T> AsRef<T> for Path<T>
[src]

impl<T: Eq> Eq for Path<T>
[src]

impl<T: Display> Display for Path<T>
[src]

impl<T: Debug> Debug for Path<T>
[src]

impl<T> Deref for Path<T>
[src]

The resulting type after dereferencing.

impl<T> DerefMut for Path<T>
[src]

Auto Trait Implementations

impl<T> Send for Path<T> where
    T: Send

impl<T> Sync for Path<T> where
    T: Sync

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T> From for T
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Erased for T

impl<Q, K> Equivalent for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized
[src]