Enum ConfigError 

#[non_exhaustive]
pub enum ConfigError {
    Read {
        path: PathBuf,
        source: Error,
    },
    Yaml {
        line: usize,
        column: usize,
        reason: String,
    },
    DocumentCount {
        found: usize,
    },
    Invalid {
        path: String,
        line: usize,
        column: usize,
        reason: String,
    },
}

A workspace configuration failure.

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.

Read

The workspace file could not be read.

Fields

path: PathBuf

The file that was asked for.

source: Error

Why it could not be read.

Yaml

The document was not valid YAML.

Fields

line: usize

The line the parser stopped on, counting from 1.

column: usize

The column the parser stopped on, counting from 1.

reason: String

What the parser expected and did not find.

DocumentCount

The document was empty, or held more than one workspace.

Fields

found: usize

How many documents the file held.

Invalid

A required key was absent or the wrong shape.

Fields

path: String

Where, as a key path such as windows[0].panes[1].

line: usize

The line of the offending value, counting from 1. A missing key is placed at the mapping that should have held it.

column: usize

The column of the offending value, counting from 1.

reason: String

What was wrong, in terms of the configuration’s own vocabulary.

Trait Implementations

impl Debug for ConfigError

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

Formats the value using the given formatter.

impl Display for ConfigError

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

Formats the value using the given formatter.

impl Error for ConfigError

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<ConfigError> for BuildError

fn from(source: ConfigError) -> Self

Converts to this type from the input type.

impl From<ScanError> for ConfigError

fn from(error: ScanError) -> Self

Converts to this type from the input type.