Trait actix_web::dev::FromParam

source ·
pub trait FromParam: Sized {
    type Err: ResponseError;

    fn from_param(s: &str) -> Result<Self, Self::Err>;
}
Expand description

A trait to abstract the idea of creating a new instance of a type from a path parameter.

Required Associated Types

The associated error which can be returned from parsing.

Required Methods

Parses a string s to return a value of this type.

Implementations on Foreign Types

Creates a PathBuf from a path parameter. The returned PathBuf is percent-decoded. If a segment is equal to “..”, the previous segment (if any) is skipped.

For security purposes, if a segment meets any of the following conditions, an Err is returned indicating the condition met:

  • Decoded segment starts with any of: . (except ..), *
  • Decoded segment ends with any of: :, >, <
  • Decoded segment contains any of: /
  • On Windows, decoded segment contains any of: ’'
  • Percent-encoding results in invalid UTF8.

As a result of these conditions, a PathBuf parsed from request path parameter is safe to interpolate within, or use as a suffix of, a path without additional checks.

Implementors