Struct CodedError 

#[non_exhaustive]
pub struct CodedError<E> {
    pub error: E,
    pub code: String,
    pub retryable: Option<bool>,
    pub fatal: bool,
    pub status: Option<u16>,
}

An error with an associated error code.

Marked #[non_exhaustive] so future minor releases can add new fields without breaking callers. External code must not construct CodedError via struct-literal syntax; use CodedError::new or the WithErrorCode::with_code extension method.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

error: E

The original error

code: String

The error code

retryable: Option<bool>

Per-instance override for retryability

fatal: bool

Whether this error is fatal

status: Option<u16>

Per-instance override for status code

Implementations

impl<E> CodedError<E>

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

Wrap an error with a stable code.

The code is not auto-registered in the global registry. Pre-register the code at startup with register_error_code if you want documentation URLs, per-code descriptions, or retryability metadata to flow through CodedError::code_info / CodedError::is_retryable.

Behaviour change since 1.0.0

Prior 0.9.x releases auto-registered the code from inside CodedError::new, which took a write lock on the global registry on the first occurrence of every new code per process. That lazy-registration step is gone in 1.0 — the hot path is now a single allocation (the String from code.into()) and zero locking. Code metadata that was pre-registered via register_error_code continues to be consulted via CodedError::code_info / is_retryable.

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