Struct ErrorContext

pub struct ErrorContext {
    pub message: String,
    pub source_location: Option<ErrorSource>,
    pub recovery_suggestion: Option<String>,
    pub metadata: HashMap<String, String>,
    pub severity: ErrorSeverity,
    pub timestamp: Option<SystemTime>,
    pub correlation_id: Option<String>,
    pub component: Option<String>,
    pub tags: Vec<String>,
    pub diagnostic_info: Option<DiagnosticResult>,
}

Additional structured context for an error

Fields

message: String

Main error message

source_location: Option<ErrorSource>

Source location information for the error

recovery_suggestion: Option<String>

Optional suggestion for how to recover from the error

metadata: HashMap<String, String>

Additional key-value metadata associated with the error

severity: ErrorSeverity

Severity level of the error

timestamp: Option<SystemTime>

Timestamp when the error occurred

correlation_id: Option<String>

Correlation ID for tracking related errors across systems

component: Option<String>

Component or subsystem where the error occurred

tags: Vec<String>

Tags for categorizing or filtering errors

diagnostic_info: Option<DiagnosticResult>

Detailed diagnostic information if available

Implementations

impl ErrorContext

pub fn new(message: impl Into<String>) -> ErrorContext

Creates a new ErrorContext with the given message

Parameters

• message - Main error message

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

Sets the severity level of the error

Parameters

• severity - Severity level to set

pub fn with_source_location(self, source_location: ErrorSource) -> ErrorContext

Adds source location information to the error context

Parameters

• source_location - Source location information

pub fn with_recovery_suggestion( self, suggestion: impl Into<String>, ) -> ErrorContext

Adds a recovery suggestion to the error context

Parameters

• suggestion - Suggestion for how to recover from the error

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> ErrorContext

Adds a metadata key-value pair to the error context

Parameters

• key - Metadata key
• value - Metadata value

pub fn with_correlation_id(self, id: impl Into<String>) -> ErrorContext

Adds a correlation ID to the error context

Parameters

• id - Correlation ID for tracking related errors

pub fn with_component(self, component: impl Into<String>) -> ErrorContext

Adds a component name to the error context

Parameters

• component - Component or subsystem where the error occurred

pub fn add_tag(self, tag: impl Into<String>) -> ErrorContext

Adds a tag to the error context

Parameters

• tag - Tag for categorizing or filtering errors

pub fn with_diagnostic_info(self, diagnostic: DiagnosticResult) -> ErrorContext

Adds detailed diagnostic information to the error context

Parameters

• diagnostic - Detailed diagnostic information

pub fn with_location(self, location: Location) -> ErrorContext

Adds location information from a Location struct

Parameters

• location - Location information

pub fn add_metadata(&mut self, key: impl Into<String>, value: impl Into<String>)

Adds metadata using a mutable reference (for macro usage)

Parameters

• key - Metadata key
• value - Metadata value

Trait Implementations

impl Clone for ErrorContext

fn clone(&self) -> ErrorContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorContext

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

Formats the value using the given formatter.