Struct Error 

pub struct Error<C: ErrorCode> {
    pub code: C,
    pub message: String,
    pub hint: Option<String>,
    pub context: Option<String>,
    pub source: Option<Arc<dyn StdError + Send + Sync>>,
}

Generic error type that combines error codes with rich error context.

Fields

code: C

Error code for categorization and programmatic handling

message: String

User-facing error message

hint: Option<String>

Optional hint to help users resolve the issue

context: Option<String>

Context for debugging

source: Option<Arc<dyn StdError + Send + Sync>>

Source error chain for debugging

Implementations

impl<C: ErrorCode> Error<C>

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

Creates a new error with the given code and message.

pub fn with_hint(self, hint: impl Into<String>) -> Self

Adds a hint to help users resolve the issue.

Hints should provide actionable guidance for end users.

pub fn with_context(self, context: impl Into<String>) -> Self

Adds internal context for debugging.

Context is meant for developers and should include information about what the system was doing when the error occurred. TODO: currently unarmed, but can be used to log errors in a standardized way in the future.

pub fn with_source(self, source: impl StdError + Send + Sync + 'static) -> Self

Adds a source error for error chaining.

This is useful for preserving the original error that caused this error.

pub fn with_source_arc(self, source: Arc<dyn StdError + Send + Sync>) -> Self

Adds a source error from an existing Arc.

This is useful when forwarding errors that are already wrapped in an Arc, avoiding unnecessary allocations.

pub fn code(&self) -> i32

Returns the numeric error code.

This is a convenience method that calls code() on the error code.

pub fn map_code<T: ErrorCode>(self, new_code: T) -> Error<T>

Converts this error to use a different error code type.

This is useful when errors need to be converted between different modules or layers that use different error code enums.

Trait Implementations

impl<C: Clone + ErrorCode> Clone for Error<C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug + ErrorCode> Debug for Error<C>

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

Formats the value using the given formatter.

impl<C: ErrorCode> Display for Error<C>

Displays the error message.

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

Formats the value using the given formatter.

impl<C: ErrorCode> Error for Error<C>

Implements the standard error trait for error chaining.

fn source(&self) -> Option<&(dyn StdError + '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<C: ErrorCode + ErrorStatusConversionExt> From<Error<C>> for Status

Converts a GreenlightError into a tonic::Status for gRPC transmission.

The error details are JSON-encoded and included in the status details field. If JSON serialization fails, a fallback JSON string is used.

fn from(value: Error<C>) -> Self

Converts to this type from the input type.

impl<C: ErrorCode + RpcErrConversion> From<RpcError> for Error<C>

fn from(value: RpcError) -> Self

Converts to this type from the input type.

impl<C: ErrorCode> TryFrom<Status> for Error<C>

Attempts to convert a tonic::Status back into a GreenlightError.

This requires that:

1. The status contains valid JSON details in the expected format
2. The error code in the details can be mapped to a valid C variant

Returns an anyhow::Error if parsing fails or the error code is unknown.

type Error = ParsingError

The type returned in the event of a conversion error.

fn try_from(value: Status) -> Result<Self, Self::Error>

Performs the conversion.