Enum Error

#[non_exhaustive]
pub enum Error {
    DirectoryTraversal {
        root: PathBuf,
        file: PathBuf,
    },
    Io {
        source: Error,
        message: String,
        backtrace: Backtrace,
        path: Option<PathBuf>,
    },
    Parse {
        source: ParseError,
    },
    Assemble {
        source: Error,
    },
    InvalidHex {
        path: PathBuf,
        source: Box<dyn Error>,
        backtrace: Backtrace,
    },
    RecursionLimit {
        backtrace: Backtrace,
    },
}

Errors that may arise during the assembly process.

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.

DirectoryTraversal

An included/imported file was outside of the root directory.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

root: PathBuf

The root directory.

file: PathBuf

The file that was to be included or imported.

Io

An i/o error.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: Error

The underlying source of this error.

message: String

Extra information about the i/o error.

backtrace: Backtrace

The location of the error.

path: Option<PathBuf>

The optional path where the error occurred.

Parse

An error that occurred while parsing a file.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: ParseError

The underlying source of this error.

Assemble

An error that occurred while assembling a file.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: Error

The underlying source of this error.

InvalidHex

An included fail failed to parse as hexadecimal.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

path: PathBuf

Path to the offending file.

source: Box<dyn Error>

The underlying source of this error.

backtrace: Backtrace

The location of the error.

RecursionLimit

A recursion limit was reached while including or importing a file.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

backtrace: Backtrace

The location of the error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

where Self: Debug + Display,

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 source(&self) -> Option<&(dyn Error + 'static)>

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

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

fn backtrace(&self) -> Option<&Backtrace>

Returns a Backtrace that may be printed.

fn iter_chain(&self) -> ChainCompat<'_>

where Self: AsErrorSource,

Returns an iterator for traversing the chain of errors, starting with the current error and continuing with recursive calls to Error::source.

impl From<Error> for Error

fn from(error: AssembleError) -> Self

Converts to this type from the input type.

impl From<ParseError> for Error

fn from(error: ParseError) -> Self

Converts to this type from the input type.