Enum VfsError 

#[non_exhaustive]
pub enum VfsError {
    Io {
        op: &'static str,
        source: Error,
    },
    Decode {
        layer: &'static str,
        offset: u64,
        detail: String,
        bytes: SmallHex,
    },
    Unrecognized {
        at: &'static str,
        offset: u64,
        bytes: SmallHex,
    },
    Ambiguous {
        candidates: Vec<&'static str>,
    },
    Bootstrap {
        stage: &'static str,
        detail: String,
    },
    Unsupported {
        layer: &'static str,
        scheme: String,
    },
    Budget {
        cap: &'static str,
        limit: u64,
    },
    NeedCredentials {
        scheme: &'static str,
        target: String,
    },
    OutOfRange {
        what: &'static str,
        offset: u64,
        len: u64,
        bound: u64,
    },
}

Every fallible operation in the VFS returns this. #[non_exhaustive] so a new variant is an additive, non-breaking change.

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.

Io

An OS/backing read failed. op names the operation for triage.

Fields

op: &'static str

source: Error

Decode

A prober said Yes/Maybe for this layer, then open failed to validate it. LOUD — never a silent downgrade to raw. Carries the offending bytes.

Fields

layer: &'static str

offset: u64

detail: String

bytes: SmallHex

Unrecognized

No prober recognized this source. The node is a typed Unknown leaf; the sniffed bytes are attached so an analyst can identify it by hand.

Fields

at: &'static str

offset: u64

bytes: SmallHex

Ambiguous

More than one prober returned Yes and auto_pick was off. The analyst disambiguates rather than the engine guessing.

Fields

candidates: Vec<&'static str>

Bootstrap

A prerequisite every downstream step depends on failed. ALWAYS loud; never absorbed into an empty result.

Fields

stage: &'static str

detail: String

Unsupported

A required decoder is not compiled in (should not happen — batteries included). Loud, names the capability.

Fields

layer: &'static str

scheme: String

Budget

A depth/source/byte cap tripped — a container/zip bomb, not a stack overflow or OOM.

Fields

cap: &'static str

limit: u64

NeedCredentials

A encryption layer needs credentials that were not supplied.

Fields

scheme: &'static str

target: String

OutOfRange

An offset/length read past the addressable bound. Returned instead of a panic by the bounded readers.

Fields

what: &'static str

offset: u64

len: u64

bound: u64

Trait Implementations

impl Debug for VfsError

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

Formats the value using the given formatter.

impl Display for VfsError

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

Formats the value using the given formatter.

impl Error for VfsError

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.