Enum ConfigError 

#[non_exhaustive]
pub enum ConfigError {
    Io {
        path: PathBuf,
        source: Error,
    },
    Interpolation {
        line: usize,
        column: usize,
        reason: String,
    },
    Parse {
        path: String,
        source: Error,
    },
    Component {
        context: String,
        message: String,
    },
    Validation(String),
}

Why a pipeline configuration could not be loaded or is invalid.

Every variant carries enough context to act on without opening the source code: file paths, YAML paths (source.kafka.brokers), or line/column positions.

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.

Io

The configuration file could not be read.

Fields

path: PathBuf

File that could not be read.

source: Error

Underlying I/O error.

Interpolation

${VAR} environment interpolation failed before parsing.

Fields

line: usize

1-based line of the offending $.

column: usize

1-based byte column of the offending $.

reason: String

What went wrong (undefined variable, malformed syntax, …).

Parse

The YAML did not match the expected schema.

Fields

path: String

Dotted YAML path to the offending value (best effort; . when the error is not attributable to a specific field).

source: Error

Underlying YAML/serde error.

Component

A component section (source:, sink:, deserializer:) is not a single-key mapping, or its opaque body failed to deserialize into the component’s typed config.

Fields

context: String

Where in the config the problem is, e.g. source.kafka.brokers.

message: String

What went wrong.

Validation(String)

The YAML parsed but violates a cross-field rule.

Trait Implementations

impl Debug for ConfigError

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

Formats the value using the given formatter.

impl Display for ConfigError

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

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

Converts to this type from the input type.