[]Struct paperclip::actix::web::Path

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

Extract typed information from the request's path.

PathConfig allows to configure extraction process.

Example

use actix_web::{web, App};

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

fn main() {
    let app = App::new().service(
        web::resource("/{username}/{count}/index.html") // <- define path parameters
             .route(web::get().to(index))               // <- register handler with `Path` extractor
    );
}

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

use actix_web::{web, App, Error};
use serde_derive::Deserialize;

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

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

fn main() {
    let app = App::new().service(
        web::resource("/{username}/index.html") // <- define path parameters
             .route(web::get().to(index)) // <- use handler with Path` extractor
    );
}

Methods

impl<T> Path<T>

pub fn into_inner(self) -> T

Deconstruct to an inner value

Trait Implementations

impl<A, B, C, D, E> Apiv2Schema for Path<(A, B, C, D, E)> where
    A: Apiv2Schema,
    B: Apiv2Schema,
    C: Apiv2Schema,
    D: Apiv2Schema,
    E: Apiv2Schema
[src]

impl<T> Apiv2Schema for Path<T> where
    T: Apiv2Schema
[src]

impl<A> Apiv2Schema for Path<(A,)> where
    A: Apiv2Schema
[src]

impl<A, B, C, D> Apiv2Schema for Path<(A, B, C, D)> where
    A: Apiv2Schema,
    B: Apiv2Schema,
    C: Apiv2Schema,
    D: Apiv2Schema
[src]

impl<A, B, C> Apiv2Schema for Path<(A, B, C)> where
    A: Apiv2Schema,
    B: Apiv2Schema,
    C: Apiv2Schema
[src]

impl<A, B> Apiv2Schema for Path<(A, B)> where
    A: Apiv2Schema,
    B: Apiv2Schema
[src]

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

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

impl<T> Deref for Path<T>

type Target = T

The resulting type after dereferencing.

impl<T> DerefMut for Path<T>

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

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

impl<T> From<T> for Path<T>

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

Extract typed information from the request's path.

Example

use actix_web::{web, App};

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

fn main() {
    let app = App::new().service(
        web::resource("/{username}/{count}/index.html") // <- define path parameters
             .route(web::get().to(index)) // <- register handler with `Path` extractor
    );
}

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

use actix_web::{web, App, Error};
use serde_derive::Deserialize;

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

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

fn main() {
    let app = App::new().service(
        web::resource("/{username}/index.html") // <- define path parameters
             .route(web::get().to(index)) // <- use handler with Path` extractor
    );
}

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Path<T>, Error>>

Future that resolves to a Self

type Config = PathConfig

Configuration for this extractor

impl<A, B> OperationModifier for Path<(A, B)> where
    A: Apiv2Schema,
    B: Apiv2Schema
[src]

impl<A, B, C, D, E> OperationModifier for Path<(A, B, C, D, E)> where
    A: Apiv2Schema,
    B: Apiv2Schema,
    C: Apiv2Schema,
    D: Apiv2Schema,
    E: Apiv2Schema
[src]

impl<A> OperationModifier for Path<(A,)> where
    A: Apiv2Schema
[src]

impl<A, B, C, D> OperationModifier for Path<(A, B, C, D)> where
    A: Apiv2Schema,
    B: Apiv2Schema,
    C: Apiv2Schema,
    D: Apiv2Schema
[src]

impl<T> OperationModifier for Path<T> where
    T: Apiv2Schema
[src]

impl<A, B, C> OperationModifier for Path<(A, B, C)> where
    A: Apiv2Schema,
    B: Apiv2Schema,
    C: Apiv2Schema
[src]

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

impl<T> PartialEq<Path<T>> for Path<T> where
    T: PartialEq<T>, 

impl<T> PartialOrd<Path<T>> for Path<T> where
    T: PartialOrd<T>, 

impl<T> StructuralEq for Path<T>

impl<T> StructuralPartialEq for Path<T>

Auto Trait Implementations

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

impl<T, A, P> Access<T> for P where
    A: Access<T>,
    P: Deref<Target = A>, 
[src]

type Guard = <A as Access<T>>::Guard

A guard object containing the value and keeping it alive. Read more

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

impl<T> Apiv2Schema for T where
    T: TypedData
[src]

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

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

impl<T, A> DynAccess<T> for A where
    A: Access<T>,
    <A as Access<T>>::Guard: 'static, 
[src]

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

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

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Err = <U as TryFrom<T>>::Err

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,