Enum PathError 

pub enum PathError {
    EmptyPath,
    RelativePath {
        path: String,
    },
    DotComponent {
        path: String,
    },
    ParentComponent {
        path: String,
    },
    EmptyDisplayName,
    DisplayNameContainsSeparator {
        display_name: String,
    },
    ReservedDisplayName {
        display_name: String,
    },
    DisplayNameContainsControlCharacter {
        code_point: u32,
    },
    DisplayNameTooLong {
        byte_length: usize,
    },
    PathTooLong {
        byte_length: usize,
    },
    PathTooDeep {
        depth: usize,
    },
    UnportableDisplayName {
        display_name: String,
        reason: &'static str,
    },
    UnportableDisplayNameCharacter {
        display_name: String,
        character: char,
    },
    FoldedNameKeyTooLong {
        byte_length: usize,
    },
}

Describes why caller-supplied path or display-name text is not admissible.

Variants

EmptyPath

Reports an empty string where an absolute path was required.

RelativePath

Reports a path that does not begin at the namespace root.

Fields

path: String

Rejected path, preserved for an escaped diagnostic.

DotComponent

Reports an explicit current-directory component, which normalization never accepts.

Fields

path: String

Rejected path, preserved for an escaped diagnostic.

ParentComponent

Reports a parent-directory component, which could otherwise escape the requested path.

Fields

path: String

Rejected path, preserved for an escaped diagnostic.

EmptyDisplayName

Reports an empty string where one stored path component was required.

DisplayNameContainsSeparator

Reports a display name containing the path-component separator.

Fields

display_name: String

Rejected component spelling, preserved for an escaped diagnostic.

ReservedDisplayName

Reports . or .., whose navigation meaning prevents storing them as names.

Fields

display_name: String

Reserved spelling supplied by the caller.

DisplayNameContainsControlCharacter

Reports a Unicode control character that cannot appear in a stored display name.

Fields

code_point: u32

Unicode scalar value of the first rejected control character.

DisplayNameTooLong

Reports a display name exceeding the stored UTF-8 component limit.

Fields

byte_length: usize

UTF-8 byte length of the rejected display name.

PathTooLong

Reports a path exceeding the total canonical byte bound.

Fields

byte_length: usize

UTF-8 byte length of the rejected canonical path.

PathTooDeep

Reports a path nested deeper than the depth bound.

Fields

depth: usize

Component count of the rejected path.

UnportableDisplayName

Reports a display name no portable target filesystem can hold.

Fields

display_name: String

The rejected spelling.

reason: &'static str

Which portability rule it broke.

UnportableDisplayNameCharacter

Reports a display name holding a character Windows reserves.

Fields

display_name: String

The rejected spelling.

character: char

The first reserved character in the name, reading left to right.

FoldedNameKeyTooLong

Reports a valid display spelling whose canonical lookup key exceeds its durable bound.

Fields

byte_length: usize

UTF-8 byte length after normalization and case folding.

Implementations

impl PathError

pub fn invalid_path_input(&self) -> &str

Returns rejected path text suitable for an API error, omitting hostile or oversized names.

Trait Implementations

impl Clone for PathError

fn clone(&self) -> PathError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathError

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

Formats the value using the given formatter.

impl Display for PathError

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

Formats the value using the given formatter.

impl Eq for PathError

impl Error for PathError

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 PartialEq for PathError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PathError