Struct actix_web_lab::extract::Path

pub struct Path<T>(pub T);

Extract typed data from request path segments.

Alternative to web::Path extractor from Actix Web that allows deconstruction, but omits the implementation of Deref.

Unlike, HttpRequest::match_info, this extractor will fully percent-decode dynamic segments, including /, %, and +.

Examples

use actix_web::get;
use actix_web_lab::extract::Path;

// 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((name, count)): Path<(String, u32)>) -> String {
    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;
use actix_web_lab::extract::Path;
use serde::Deserialize;

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

// extract `Info` from a path using serde
#[get("/{name}")]
async fn index(info: Path<Info>) -> String {
    let info = info.into_inner();
    format!("Welcome {}!", info.name)
}

Tuple Fields

0: T

Implementations

impl<T> Path<T>

pub fn into_inner(self) -> T

Unwrap into inner T 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> Display for Path<T>where T: Display,

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

See here for example of usage as an extractor.

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Path<T>, <Path<T> as FromRequest>::Error>>

Future that resolves to a Self.

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.

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) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd<Path<T>> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

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

impl<T> StructuralEq for Path<T>

impl<T> StructuralPartialEq for Path<T>