Enum DecrustError

pub enum DecrustError {
    Io {
        source: Error,
        path: Option<PathBuf>,
        operation: String,
        backtrace: DecrustBacktrace,
    },
    Parse {
        source: Box<dyn Error + Send + Sync>,
        kind: String,
        context_info: String,
        backtrace: DecrustBacktrace,
    },
    Network {
        source: Box<dyn Error + Send + Sync>,
        url: Option<String>,
        kind: String,
        backtrace: DecrustBacktrace,
    },
    Config {
        message: String,
        path: Option<PathBuf>,
        source: OptionalError,
        backtrace: DecrustBacktrace,
    },
    Validation {
        field: String,
        message: String,
        backtrace: DecrustBacktrace,
        /* private fields */
    },
    Internal {
        message: String,
        source: OptionalError,
        backtrace: DecrustBacktrace,
        /* private fields */
    },
    CircuitBreakerOpen {
        name: String,
        retry_after: Option<Duration>,
        backtrace: DecrustBacktrace,
        /* private fields */
    },
    Timeout {
        operation: String,
        duration: Duration,
        backtrace: DecrustBacktrace,
    },
    ResourceExhausted {
        resource: String,
        limit: String,
        current: String,
        backtrace: DecrustBacktrace,
    },
    NotFound {
        resource_type: String,
        identifier: String,
        backtrace: DecrustBacktrace,
    },
    StateConflict {
        message: String,
        backtrace: DecrustBacktrace,
    },
    Concurrency {
        message: String,
        source: OptionalError,
        backtrace: DecrustBacktrace,
    },
    ExternalService {
        service_name: String,
        message: String,
        source: OptionalError,
        backtrace: DecrustBacktrace,
    },
    MissingValue {
        item_description: String,
        backtrace: DecrustBacktrace,
    },
    MultipleErrors {
        errors: Vec<DecrustError>,
        backtrace: DecrustBacktrace,
    },
    WithRichContext {
        context: ErrorContext,
        source: Box<DecrustError>,
    },
    Style {
        message: String,
        backtrace: DecrustBacktrace,
    },
    Oops {
        message: String,
        source: Box<dyn Error + Send + Sync>,
        backtrace: DecrustBacktrace,
    },
}

Unified error type for Decrust.

Variants

Io

I/O related errors

Fields

source: Error

The underlying I/O error

path: Option<PathBuf>

Optional path to the file or resource that caused the error

operation: String

Description of the operation that failed

backtrace: DecrustBacktrace

Backtrace captured at the error site

Parse

Parsing errors (JSON, YAML, etc.)

Fields

source: Box<dyn Error + Send + Sync>

The underlying parsing error

kind: String

The type of data being parsed (e.g., “JSON”, “YAML”)

context_info: String

Additional context information about the parsing operation

backtrace: DecrustBacktrace

Backtrace captured at the error site

Network

Network related errors

Fields

source: Box<dyn Error + Send + Sync>

The underlying network error

url: Option<String>

Optional URL that was being accessed

kind: String

The type of network operation (e.g., “HTTP”, “TCP”)

backtrace: DecrustBacktrace

Backtrace captured at the error site

Config

Configuration related errors

Fields

message: String

Error message describing the configuration issue

path: Option<PathBuf>

Optional path to the configuration file

source: OptionalError

Optional underlying error that caused the configuration issue

backtrace: DecrustBacktrace

Backtrace captured at the error site

Validation

Validation errors

Fields

field: String

Name of the field that failed validation

message: String

Description of the validation error

backtrace: DecrustBacktrace

Backtrace captured at the error site

Internal

Internal errors

Fields

message: String

Description of the internal error

source: OptionalError

Optional underlying error

backtrace: DecrustBacktrace

Backtrace captured at the error site

CircuitBreakerOpen

Circuit breaker is open

Fields

name: String

Name of the circuit breaker

retry_after: Option<Duration>

Optional duration after which the circuit breaker might transition to half-open

backtrace: DecrustBacktrace

Backtrace captured at the error site

Timeout

Operation timed out

Fields

operation: String

Name of the operation that timed out

duration: Duration

Duration after which the operation timed out

backtrace: DecrustBacktrace

Backtrace captured at the error site

ResourceExhausted

Resource exhaustion

Fields

resource: String

Name of the resource that was exhausted

limit: String

The limit of the resource

current: String

The current value that exceeded the limit

backtrace: DecrustBacktrace

Backtrace captured at the error site

NotFound

Resource not found

Fields

resource_type: String

Type of resource that was not found (e.g., “User”, “File”)

identifier: String

Identifier of the resource that was not found

backtrace: DecrustBacktrace

Backtrace captured at the error site

StateConflict

State conflict

Fields

message: String

Description of the state conflict

backtrace: DecrustBacktrace

Backtrace captured at the error site

Concurrency

Concurrency related errors

Fields

message: String

Description of the concurrency error

source: OptionalError

Optional underlying error

backtrace: DecrustBacktrace

Backtrace captured at the error site

ExternalService

External service errors

Fields

service_name: String

Name of the external service that caused the error

message: String

Description of the error from the external service

source: OptionalError

Optional underlying error from the external service

backtrace: DecrustBacktrace

Backtrace captured at the error site

MissingValue

Missing value errors

Fields

item_description: String

Description of the missing value or item

backtrace: DecrustBacktrace

Backtrace captured at the error site

MultipleErrors

Multiple errors

Fields

errors: Vec<DecrustError>

Collection of errors that occurred

backtrace: DecrustBacktrace

Backtrace captured at the error site

WithRichContext

Error with rich context

Fields

context: ErrorContext

Rich context information attached to the error

source: Box<DecrustError>

The original error that is being wrapped with context

Style

Style and formatting errors

Fields

message: String

The style error message

backtrace: DecrustBacktrace

Backtrace captured at the error site

Oops

General purpose error wrapper

Fields

message: String

Custom error message

source: Box<dyn Error + Send + Sync>

The underlying error being wrapped

backtrace: DecrustBacktrace

Backtrace captured at the error site

Implementations

impl DecrustError

pub fn add_context(self, context: ErrorContext) -> DecrustError

Adds rich context to an error

This wraps the error in a WithRichContext variant, which allows for additional information to be attached to the error.

Parameters

• context - The error context to add

Returns

A new error with the context attached

pub fn add_context_msg(self, message: impl Into<String>) -> DecrustError

Adds a simple message context to an error

This is a convenience method that creates a simple ErrorContext with just a message and adds it to the error.

Parameters

• message - The message to add as context

Returns

A new error with the context attached

pub fn category(&self) -> ErrorCategory

Gets the category of this error

Returns

The ErrorCategory that best describes this error

pub fn severity(&self) -> ErrorSeverity

Gets the severity of this error

Returns

The ErrorSeverity level of this error

pub fn get_rich_context(&self) -> Option<&ErrorContext>

Gets the rich context attached to this error, if any

Returns

Some(context) if this is a WithRichContext error, None otherwise

Trait Implementations

impl AutocorrectableError for DecrustError

Implementation of AutocorrectableError for DecrustError

This implementation enables the Decrust error system to provide intelligent autocorrection suggestions for errors that occur during application execution. It integrates with the Decrust engine to analyze errors and suggest potential fixes.

The implementation:

1. Delegates autocorrection suggestion to the Decrust engine
2. Accesses diagnostic information embedded within rich error contexts
3. Supports the Diamond certification requirements for comprehensive error handling

fn suggest_autocorrection( &self, decrust_engine: &Decrust, source_code_context: Option<&str>, ) -> Option<Autocorrection>

Suggests a possible autocorrection for this error using the Decrust engine.

Arguments

• decrust_engine - The Decrust engine instance that will analyze the error
• source_code_context - Optional source code context that may help with generating more accurate suggestions

Returns

An Option<Autocorrection> containing a suggested fix, or None if no fix can be suggested

fn get_diagnostic_info(&self) -> Option<&DiagnosticResult>

Retrieves diagnostic information embedded within the error if available.

This method looks for diagnostic information in errors that contain rich context, which may have been generated by compilers, linters, or other diagnostic tools.

Returns

An Option<&DiagnosticResult> containing diagnostic information, or None if no such information exists

impl BacktraceCompat for DecrustError

fn backtrace(&self) -> Option<&DecrustBacktrace>

Get the backtrace associated with this error, if any

impl Clone for DecrustError

fn clone(&self) -> DecrustError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecrustError

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

Formats the value using the given formatter.

impl Display for DecrustError

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

Formats the value using the given formatter.

impl Error for DecrustError

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<Box<dyn Error>> for DecrustError

Implementation of From<Box<dyn std::error::Error>> for DecrustError (non-Send+Sync version)

fn from(err: Box<dyn Error>) -> DecrustError

Converts to this type from the input type.

impl From<Box<dyn Error + Send + Sync>> for DecrustError

Implementation of From<Box<dyn std::error::Error>> for DecrustError to support generic error handling

fn from(err: Box<dyn Error + Send + Sync>) -> DecrustError

Converts to this type from the input type.

impl From<Error> for DecrustError

Implementation of Fromstd::io::Error for DecrustError to support extension traits

fn from(err: Error) -> DecrustError

Converts to this type from the input type.

impl PartialEq for DecrustError

fn eq(&self, other: &DecrustError) -> 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.