Enum arti::cfg::ConfigBuildError

#[non_exhaustive]
pub(crate) enum ConfigBuildError {
    MissingField {
        field: String,
    },
    Invalid {
        field: String,
        problem: String,
    },
    Inconsistent {
        fields: Vec<String, Global>,
        problem: String,
    },
    NoCompileTimeSupport {
        field: String,
        problem: String,
    },
}

An error related to an option passed to Arti via a configuration builder.

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.

MissingField

Fields

field: String

The name of the missing field.

A mandatory field was not present.

Invalid

Fields

field: String

The name of the invalid field

problem: String

A description of the problem.

A single field had a value that proved to be unusable.

Inconsistent

Fields

fields: Vec<String, Global>

The names of the inconsistent fields

problem: String

The problem that makes them inconsistent

Multiple fields are inconsistent.

NoCompileTimeSupport

Fields

field: String

The names of the (primary) field requesting the unsupported configuration

problem: String

The description of the problem

The requested configuration is not supported in this build

Implementations

impl ConfigBuildError

pub fn within(&self, prefix: &str) -> ConfigBuildError

Return a new ConfigBuildError that prefixes its field name with prefix and a dot.

Trait Implementations

impl Clone for ConfigBuildError

fn clone(&self) -> ConfigBuildError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigBuildError

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

Formats the value using the given formatter.

impl Display for ConfigBuildError

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

Formats the value using the given formatter.

impl Error for ConfigBuildError

fn source(&self) -> Option<&(dyn Error + 'static)>

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 self, req: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl From<SubfieldBuildError<ConfigBuildError>> for ConfigBuildError

fn from(e: SubfieldBuildError<ConfigBuildError>) -> ConfigBuildError

Converts to this type from the input type.

impl From<UninitializedFieldError> for ConfigBuildError

fn from(val: UninitializedFieldError) -> ConfigBuildError

Converts to this type from the input type.

impl HasKind for ConfigBuildError

fn kind(&self) -> ErrorKind

Return the kind of this error.