Enum Error 

pub enum Error {
    UnableToSerializeYamlObject(Error),
    UnableToSerializeJsonObject(Error),
    Validation(String),
    ExecutionError(String),
    EndOfInput,
    UnableToSecureLock,
    DuplicateRegisteredName(String),
    InvalidValidationSchema(String),
    ConfigFailedValidation(String),
    ConfigurationItemNotFound(String),
    NotYetImplemented,
    UnableToSendToChannel(String),
    RecvChannelError(RecvError),
    ProcessingError(String),
    ConditionalCheckfailed,
    InputError(String),
    OutputError(String),
    NoInputToReturn,
}

Enum to capture errors occurred through the pipeline.

Uses thiserror for ergonomic error handling with proper std::error::Error implementation. Errors that wrap other errors use #[source] or #[from] for proper error chaining.

Variants

UnableToSerializeYamlObject(Error)

Yaml parsing errors found within the declarative language provided

UnableToSerializeJsonObject(Error)

JSON serialization is primarily utilized as a preparser to passing the declarative language to the given module by utilizing jsonschema to validate the input. This is unlikely to occur in practice since the yaml configuration object is converted to json for this step.

Validation(String)

Validation errors discovered by the jsonschema evaluation of the declarative configuration language provided to a given module

ExecutionError(String)

Error with the processing pipeline due to a failure of internal libraries or utilized modules

EndOfInput

EndOfInput is an error enum variant to indicate that the input module has finished and will not receive additional input. This error triggers a graceful shutdown of the processing pipeline

UnableToSecureLock

Unable to secure internal mutex lock

DuplicateRegisteredName(String)

A plugin of the same category (input, processing, output) has already been provided

InvalidValidationSchema(String)

The provided jsonschema configuration for a module is incorrect

ConfigFailedValidation(String)

Configuration provided to a module is invalid

ConfigurationItemNotFound(String)

Module is not registered with the runtime.

NotYetImplemented

Not yet implemented functionality

UnableToSendToChannel(String)

Failure to send to an internal channel processing crate::Messages

RecvChannelError(RecvError)

Failure to receive from internal raw channel

ProcessingError(String)

Processing module failed with an unrecoverable error. Processing of crate::Message is stopped and crate::Status is returned to the input module once all messages in this lineage have been processed

ConditionalCheckfailed

Conditional check has failed for crate::Message, such as use with [crate::modules::processors::switch] conditions

InputError(String)

Error encountered while calling crate::Input::read on an input module

OutputError(String)

Error encountered while calling crate::Output::write or crate::OutputBatch::write_batch on an output module

NoInputToReturn

Error returned by input module to indicate there are no messages to process

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<RecvError> for Error

fn from(source: RecvError) -> Self

Converts to this type from the input type.