Enum IncludeError 

pub enum IncludeError {
    Io(Error),
    Parse {
        format: &'static str,
        source: Box<dyn StdError + Send + Sync>,
    },
    UnknownFormat {
        path: PathBuf,
    },
    ReadOnly {
        path: PathBuf,
    },
    DuplicateId {
        id: String,
    },
    EntryNotFound {
        id: String,
    },
    InvalidId {
        id: String,
    },
    InvalidName,
    MissingEnv {
        expression: String,
    },
    UnknownExpression {
        expression: String,
    },
    Unterminated {
        input: String,
    },
    NotInTree,
    Cycle,
    Watch {
        source: Box<dyn StdError + Send + Sync>,
    },
    Message {
        message: String,
    },
}

Errors produced while reading entry trees and loader files.

Variants

Io(Error)

An underlying filesystem operation failed.

Parse

A config file could not be parsed or serialized.

Fields

format: &'static str

Which format was being processed ("yaml" or "json").

source: Box<dyn StdError + Send + Sync>

The parser or serializer error.

UnknownFormat

The file extension does not map to a supported format.

Fields

path: PathBuf

The path that was opened.

ReadOnly

The target file is read-only, so configuration cannot be written back.

Fields

path: PathBuf

The path that was opened.

DuplicateId

Two entries in one tree declare the same id.

Fields

id: String

The conflicting id.

EntryNotFound

No entry with the requested id exists in the tree.

Fields

id: String

The requested (possibly composite) id.

InvalidId

An entry id is empty or contains the : path separator.

Fields

id: String

The offending id.

InvalidName

An entry has no plugin name.

MissingEnv

A ${{ env.NAME }} template referenced an unset variable.

Fields

expression: String

The full expression that failed, e.g. env.MISSING.

UnknownExpression

A ${{ ... }} template used an unsupported expression.

Fields

expression: String

The unsupported expression.

Unterminated

A ${{ template was never closed with }}.

Fields

input: String

The input containing the dangling ${{.

NotInTree

The referenced entry does not belong to this tree.

Cycle

The requested move would place an entry inside its own subtree.

Watch

Setting up or running a file watcher failed (watch feature).

Fields

source: Box<dyn StdError + Send + Sync>

The underlying watcher error.

Message

Free-form message from layers composing multiple files (import cycles, unreadable sub-files).

Fields

message: String

The message.

Trait Implementations

impl Debug for IncludeError

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

Formats the value using the given formatter.

impl Display for IncludeError

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

Formats the value using the given formatter.

impl Error for IncludeError

fn source(&self) -> Option<&(dyn StdError + '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 IncludeError

fn from(error: Error) -> Self

Converts to this type from the input type.