Struct ErrorCode 

pub struct ErrorCode(/* private fields */);

A stable, machine-readable error code for logs and API responses.

Codes follow a domain.reason convention (e.g. config.missing_required, data.unavailable). They are usually &'static str constants, but a dynamic String is supported for codes assembled at runtime.

Implementations

impl ErrorCode

pub const fn new(code: &'static str) -> Self

A code from a static string — the common case.

Examples found in repository

examples/error_kernel.rs (line 38)

    fn code(&self) -> ErrorCode {
        match self {
            OrderError::NotFound => ErrorCode::new("order.not_found"),
            OrderError::PaymentDeclined => ErrorCode::new("order.payment_declined"),
            OrderError::LedgerUnavailable => ErrorCode::new("order.ledger_unavailable"),
        }
    }

pub fn from_string(code: String) -> Self

A code assembled at runtime.

pub fn as_str(&self) -> &str

The code as a string slice.

Examples found in repository

examples/error_kernel.rs (line 53)

fn main() {
    let errors = [OrderError::NotFound, OrderError::PaymentDeclined, OrderError::LedgerUnavailable];

    println!("{:<32} {:<28} {:>4}  retryable", "error", "code", "http");
    for err in &errors {
        let code = err.code();
        println!(
            "{err:<32} {:<28} {:>4}  {}",
            code.as_str(),
            err.http_status(),
            err.is_retryable(),
        );
    }
}

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorCode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ErrorCode

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

Formats the value using the given formatter.

impl Eq for ErrorCode

impl From<&'static str> for ErrorCode

fn from(code: &'static str) -> Self

Converts to this type from the input type.

impl From<String> for ErrorCode

fn from(code: String) -> Self

Converts to this type from the input type.

impl Hash for ErrorCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ErrorCode

fn eq(&self, other: &ErrorCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ErrorCode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ErrorCode