Struct ErrorContext

pub struct ErrorContext {
    pub message: String,
    pub source: Option<Box<dyn Error + Send + Sync + 'static>>,
    pub metadata: Option<HashMap<String, String>>,
    pub timestamp: String,
    pub trace_id: String,
}

A context wrapper for errors with additional metadata.

ErrorContext provides a way to enrich errors with contextual information, making them more useful for debugging and logging. Each error context includes:

• A descriptive message
• An optional source error
• Optional key-value metadata
• A timestamp (automatically generated)
• A unique trace ID (automatically generated)

This structure implements both Display and std::error::Error traits, making it suitable for use in error handling chains.

Fields

message: String

The error message

source: Option<Box<dyn Error + Send + Sync + 'static>>

The source error that caused this error

metadata: Option<HashMap<String, String>>

Additional metadata about the error

timestamp: String

The timestamp of the error in RFC 3339 format

trace_id: String

The unique identifier for the error (UUID v4)

Implementations

impl ErrorContext

pub fn new( message: impl Into<String>, source: Option<Box<dyn Error + Send + Sync + 'static>>, metadata: Option<HashMap<String, String>>, ) -> Self

Creates a new error context with the given message, source, and metadata.

Arguments

• message - A descriptive error message
• source - An optional source error that caused this error
• metadata - Optional key-value pairs providing additional context

Returns

A new ErrorContext instance with automatically generated timestamp and trace ID.

pub fn new_with_log( message: impl Into<String>, source: Option<Box<dyn Error + Send + Sync + 'static>>, metadata: Option<HashMap<String, String>>, ) -> Self

Creates a new error context and logs it with the given message, source, and metadata.

Arguments

• message - A descriptive error message
• source - An optional source error that caused this error
• metadata - Optional key-value pairs providing additional context

Returns

A new ErrorContext instance with automatically generated timestamp and trace ID.

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

Adds a single key-value metadata pair to the error context.

This method creates the metadata HashMap if it doesn’t already exist.

Arguments

• key - The metadata key
• value - The metadata value

Returns

The modified ErrorContext with the new metadata added.

pub fn format_with_metadata(&self) -> String

Formats the error message with its metadata appended in a readable format.

The format is: "message [key1=value1, key2=value2, ...]". Metadata keys are sorted alphabetically for consistent output.

Returns

A formatted string containing the error message and its metadata.

Trait Implementations

impl Debug for ErrorContext

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

Formats the value using the given formatter.

impl Display for ErrorContext

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

Formats the value using the given formatter.

impl Error for ErrorContext

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 Send for ErrorContext

impl Sync for ErrorContext