Struct Path 

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

Extract typed information from the request’s path.

If the path segments cannot be deserialized into T, extraction fails with PathError, which the default error domain renders as 404 Not Found.

Path segments are percent-decoded after the path is split on /, so extracted values can contain any character, including /. For example /files/..%2F..%2Fetc matches /files/{name} with name set to ../../etc. Validate such values before using them, e.g. as a file system path.

Example

use ntex::web;

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

fn main() {
    let app = web::App::default().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 std::convert::Infallible;
use ntex::web;

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

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

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

Implementations

impl<T> Path<T>

pub fn into_inner(self) -> T

Deconstruct to an inner value

Trait Implementations

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

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

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

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Deref for Path<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Path<T>

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

Mutably dereferences the value.

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

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

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

fn from(inner: T) -> Path<T>

Converts to this type from the input type.

impl<T, St: State> FromRequest<St> for Path<T>

where T: DeserializeOwned,

Extract typed information from the request’s path.

Example

use ntex::web;

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

fn main() {
    let app = web::App::default().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 std::convert::Infallible;
use ntex::web;

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

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

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

type Error = PathError

The error returned when extraction fails.

async fn from_request( _: &St, req: &HttpRequest, _: &mut Payload, ) -> Result<Self, Self::Error>

Creates the extractor value for this request.

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

fn cmp(&self, other: &Path<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

fn eq(&self, other: &Path<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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

fn partial_cmp(&self, other: &Path<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: PartialEq> StructuralPartialEq for Path<T>