Enum BundleError 

#[non_exhaustive]
pub enum BundleError {
    Io {
        kind: ErrorKind,
        message: String,
    },
    NotADirectory(PathBuf),
    Document {
        path: PathBuf,
        error: DocumentError,
    },
}

Errors raised when loading or operating on a bundle on disk.

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 I/O error occurred while reading the bundle.

The original std::io::Error is not Clone, so the kind and the rendered message are stored instead. The std::error::Error::source chain is therefore unavailable for this variant; use BundleError::io_kind to inspect the failure category.

Fields

kind: ErrorKind

The kind of I/O failure (NotFound, PermissionDenied, …).

message: String

The rendered message of the original error, which preserves any path context the OS or stdlib attached.

NotADirectory(PathBuf)

The bundle root does not exist or is not a directory.

Document

A concept document failed to parse.

Fields

path: PathBuf

Path to the offending file.

error: DocumentError

The underlying document error.

Implementations

impl BundleError

pub const fn io_kind(&self) -> Option<ErrorKind>

The std::io::ErrorKind for an BundleError::Io variant, or None for any other variant. Convenient for matching on the failure category without downcasting.

Trait Implementations

impl Clone for BundleError

fn clone(&self) -> BundleError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BundleError

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

Formats the value using the given formatter.

impl Display for BundleError

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

Formats the value using the given formatter.

impl Error for BundleError

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<Error> for BundleError

fn from(e: Error) -> Self

Converts to this type from the input type.