Struct PathBufWrap 

pub struct PathBufWrap(/* private fields */);

Secure Path Traversal Guard

This struct parses a request-uri PathBuf

Implementations

impl PathBufWrap

pub fn parse_unprocessed_req( req: &HttpRequest, hidden_files: bool, ) -> Result<Self, UriSegmentError>

Parse a safe path from the unprocessed tail of a supplied HttpRequest, given the choice of allowing hidden files to be considered valid segments.

This uses HttpRequest::match_info and Path::unprocessed, which returns the part of the path not matched by route patterns. This is useful for mounted services (eg. Files), where only the tail should be parsed.

Path traversal is guarded by this method.

pub fn parse_req_path( req: &HttpRequest, hidden_files: bool, ) -> Result<Self, UriSegmentError>

Parse a safe path from the full request path of a supplied HttpRequest, given the choice of allowing hidden files to be considered valid segments.

This uses HttpRequest::path, and is more appropriate for non-mounted handlers that want the entire request path.

Path traversal is guarded by this method.

pub fn parse_path( path: &str, hidden_files: bool, ) -> Result<Self, UriSegmentError>

Parse a path, giving the choice of allowing hidden files to be considered valid segments.

Path traversal is guarded by this method.

Trait Implementations

impl AsRef<Path> for PathBufWrap

fn as_ref(&self) -> &Path

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

impl Debug for PathBufWrap

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

Formats the value using the given formatter.

impl FromRequest for PathBufWrap

type Error = UriSegmentError

The associated error which can be returned.

type Future = Ready<Result<PathBufWrap, <PathBufWrap 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 FromStr for PathBufWrap

type Err = UriSegmentError

The associated error which can be returned from parsing.

fn from_str(path: &str) -> Result<Self, Self::Err>

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

impl PartialEq for PathBufWrap

fn eq(&self, other: &PathBufWrap) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for PathBufWrap

impl StructuralPartialEq for PathBufWrap