Enum PathSecurityError 

pub enum PathSecurityError {
    EmptyPath,
    InteriorNul,
    ParentTraversal(PathBuf),
    OutsideBase {
        path: PathBuf,
        base: PathBuf,
    },
    SymlinkDenied(PathBuf),
    NotRegularFile(PathBuf),
    TooLarge {
        size: u64,
        limit: u64,
    },
    Io {
        path: PathBuf,
        source: Error,
    },
}

Errors that can occur while securely resolving and opening an input path.

Variants

EmptyPath

The supplied path was empty.

InteriorNul

The supplied path contained an interior NUL byte.

ParentTraversal(PathBuf)

A .. component was present while a base directory was configured.

OutsideBase

The resolved path lay outside the configured base directory.

Fields

path: PathBuf

The fully resolved (canonical) path that was rejected.

base: PathBuf

The configured base directory (canonical).

SymlinkDenied(PathBuf)

A symbolic link was encountered while symlinks were disallowed.

NotRegularFile(PathBuf)

The path resolved to something other than a regular file.

TooLarge

The input exceeded the configured byte limit.

Fields

size: u64

Observed size in bytes (at least limit + 1 for streamed inputs).

limit: u64

The configured limit in bytes.

Io

An underlying I/O error occurred while accessing the path.

Fields

path: PathBuf

The path that was being accessed.

source: Error

The underlying I/O error.

Trait Implementations

impl Debug for PathSecurityError

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

Formats the value using the given formatter.

impl Display for PathSecurityError

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

Formats the value using the given formatter.

impl Error for PathSecurityError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.