Struct CodedError

pub struct CodedError<E> {
    pub error: E,
    pub code: String,
    pub fatal: bool,
}

An error with an associated error code

Fields

error: E

The original error

code: String

The error code

fatal: bool

Whether this error is fatal

Implementations

impl<E> CodedError<E>

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

Create a new coded error

pub fn code_info(&self) -> Option<ErrorCodeInfo>

Get information about this error code from the registry

pub fn with_retryable(self, _retryable: bool) -> Self

Set whether this error is retryable

pub fn with_fatal(self, fatal: bool) -> Self

Set whether this error is fatal

pub fn with_status(self, _status: u16) -> Self

Set the HTTP status code for this error

Trait Implementations

impl<E: Debug> Debug for CodedError<E>

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

Formats the value using the given formatter.

impl<E: Display> Display for CodedError<E>

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

Formats the value using the given formatter.

impl<E: Error + 'static> Error for CodedError<E>

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<E: ForgeError> ForgeError for CodedError<E>

fn kind(&self) -> &'static str

Returns the kind of error, typically matching the enum variant

fn caption(&self) -> &'static str

Returns a human-readable caption for the error

fn is_retryable(&self) -> bool

Returns true if the operation can be retried

fn is_fatal(&self) -> bool

Returns true if the error is fatal and should terminate the program

fn status_code(&self) -> u16

Returns an appropriate HTTP status code for the error

fn exit_code(&self) -> i32

Returns an appropriate process exit code for the error

fn user_message(&self) -> String

Returns a user-facing message that can be shown to end users

fn dev_message(&self) -> String

Returns a detailed technical message for developers/logs

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

Returns a backtrace if available

fn register(&self)

Registers the error with the central error registry