Enum ConfigError

pub enum ConfigError {
    TypeMismatch {
        path: String,
        expected: Type,
        actual: Type,
        span: Span,
    },
    InvalidValue {
        path: String,
        valid: String,
        actual: String,
        span: Span,
    },
    UnknownOption {
        path: String,
        span: Span,
    },
    MissingRequiredColumn {
        path: String,
        column: &'static str,
        span: Span,
    },
    Deprecated {
        path: String,
        suggestion: &'static str,
        span: Span,
    },
    ShellError(ShellError),
}

The errors that may occur when updating the config

Variants

TypeMismatch

Fields

path: String

expected: Type

actual: Type

span: Span

InvalidValue

Fields

path: String

valid: String

actual: String

span: Span

UnknownOption

Fields

path: String

span: Span

MissingRequiredColumn

Fields

path: String

column: &'static str

span: Span

Deprecated

Fields

path: String

suggestion: &'static str

span: Span

ShellError(ShellError)

Trait Implementations

impl Clone for ConfigError

fn clone(&self) -> ConfigError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigError

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

Formats the value using the given formatter.

impl Diagnostic for ConfigError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related(&self) -> Option<Box<dyn Iterator<Item = &dyn Diagnostic> + '_>>

Additional related Diagnostics.

fn url(&self) -> Option<Box<dyn Display + '_>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

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

fn from(source: ShellError) -> Self

Converts to this type from the input type.

impl PartialEq for ConfigError

fn eq(&self, other: &ConfigError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConfigError