Enum UnsafePathError 

#[non_exhaustive]
pub enum UnsafePathError {
    ParentDir,
    Absolute,
    ReservedName,
    EscapesRoot,
}

Error returned when a path is rejected as unsafe.

Produced by sanitize_path and the safe-open helpers in this module (safe_open, safe_open_in, OpenOptions). Converts into an std::io::Error with std::io::ErrorKind::InvalidInput.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ParentDir

The path contained a parent-directory (..) component, which can be used to escape the intended directory (“dot-dot” traversal).

Absolute

An absolute path (or one carrying a root/drive/UNC prefix) was supplied where only a relative path is permitted (e.g. when confined to a root).

ReservedName

A component matched a reserved device name (e.g. Windows CON, NUL, COM1), which has special and surprising filesystem semantics.

EscapesRoot

The fully resolved path escaped the configured root directory, e.g. through a symbolic link pointing outside of it.

Trait Implementations

impl Clone for UnsafePathError

fn clone(&self) -> UnsafePathError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UnsafePathError

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

Formats the value using the given formatter.

impl Display for UnsafePathError

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

Formats the value using the given formatter.

impl Eq for UnsafePathError

impl Error for UnsafePathError

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.

impl From<UnsafePathError> for Error

fn from(err: UnsafePathError) -> Error

Converts to this type from the input type.

impl PartialEq for UnsafePathError

fn eq(&self, other: &UnsafePathError) -> 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 StructuralPartialEq for UnsafePathError