Enum obsidian_export::ExportError

#[non_exhaustive]
pub enum ExportError {
    ReadError {
        path: PathBuf,
        source: Error,
    },
    WriteError {
        path: PathBuf,
        source: Error,
    },
    WalkDirError {
        path: PathBuf,
        source: Error,
    },
    PathDoesNotExist {
        path: PathBuf,
    },
    CharacterEncodingError {
        source: Utf8Error,
    },
    RecursionLimitExceeded {
        file_tree: Vec<PathBuf>,
    },
    FileExportError {
        path: PathBuf,
        source: Box<ExportError>,
    },
    FrontMatterDecodeError {
        path: PathBuf,
        source: Box<Error>,
    },
    FrontMatterEncodeError {
        path: PathBuf,
        source: Box<Error>,
    },
}

ExportError represents all errors which may be returned when using this crate.

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.

ReadError

Fields

path: PathBuf

source: Error

This occurs when a read IO operation fails.

WriteError

Fields

path: PathBuf

source: Error

This occurs when a write IO operation fails.

WalkDirError

Fields

path: PathBuf

source: Error

This occurs when an error is encountered while trying to walk a directory.

PathDoesNotExist

Fields

path: PathBuf

This occurs when an operation is requested on a file or directory which does not exist.

CharacterEncodingError

Fields

source: Utf8Error

This error may occur when invalid UTF8 is encountered.

Currently, operations which assume UTF8 perform lossy encoding however.

RecursionLimitExceeded

Fields

file_tree: Vec<PathBuf>

This error occurs when embedded notes are too deeply nested or cause an infinite loop.

When this happens, file_tree contains a list of all the files which were processed leading up to this error.

FileExportError

Fields

path: PathBuf

source: Box<ExportError>

This occurs when a file fails to export successfully.

FrontMatterDecodeError

Fields

path: PathBuf

source: Box<Error>

FrontMatterEncodeError

Fields

path: PathBuf

source: Box<Error>

Trait Implementations

impl Debug for ExportError

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

Formats the value using the given formatter.

impl Display for ExportError

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

Formats the value using the given formatter.

impl Error for ExportError

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)>

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 ExportError

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.