Struct StructuredError 

pub struct StructuredError {
    pub code: String,
    pub message: String,
    pub category: ErrorCategory,
    pub severity: ErrorSeverity,
    pub retry_hint: RetryHint,
    pub source_step_id: Option<String>,
    pub attributes: HashMap<String, String>,
    pub cause: Option<Box<StructuredError>>,
}

Structured error with metadata for intelligent error handling.

This extends the basic error information with:

• Category: transient vs permanent (business errors are a subset of permanent)
• Severity: info/warning/error/critical for alerting
• Retry hint: whether and how to retry
• Attributes: additional context key-value pairs
• Cause: nested error for error chains

Fields

code: String

Machine-readable error code (e.g., “RATE_LIMITED”, “VALIDATION_ERROR”)

message: String

Human-readable error message

category: ErrorCategory

Error category for routing/retry decisions

severity: ErrorSeverity

Error severity for logging/alerting

retry_hint: RetryHint

Hint for retry behavior

source_step_id: Option<String>

Which step produced this error (if applicable)

attributes: HashMap<String, String>

Additional context as key-value pairs

cause: Option<Box<StructuredError>>

Nested cause error (for error chains)

Implementations

impl StructuredError

pub fn new(code: impl Into<String>, message: impl Into<String>) -> Self

Create a new structured error with minimal info.

pub fn transient(code: impl Into<String>, message: impl Into<String>) -> Self

Create a transient error (retry recommended).

pub fn permanent(code: impl Into<String>, message: impl Into<String>) -> Self

Create a permanent error (don’t retry).

Use for: validation errors, not found, authorization failures, business rule violations.

For business errors (expected outcomes like “credit limit exceeded”), use .with_severity(ErrorSeverity::Warning) to distinguish from technical failures.

pub fn with_step(self, step_id: impl Into<String>) -> Self

Set the source step ID.

pub fn with_attr(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add an attribute.

pub fn with_cause(self, cause: StructuredError) -> Self

Set a cause error.

pub fn with_severity(self, severity: ErrorSeverity) -> Self

Set the severity.

pub fn with_retry_hint(self, hint: RetryHint) -> Self

Set the retry hint.

pub fn is_transient(&self) -> bool

Returns true if this is a transient error.

pub fn is_permanent(&self) -> bool

Returns true if this is a permanent error.

pub fn should_retry(&self) -> bool

Returns true if this error should be retried.

Trait Implementations

impl Clone for StructuredError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructuredError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StructuredError

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

Formats the value using the given formatter.

impl Error for StructuredError

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<CoreError> for StructuredError

fn from(err: CoreError) -> Self

Converts to this type from the input type.

impl Serialize for StructuredError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.