Struct AlienError 

pub struct AlienError<T = GenericError>
where
    T: AlienErrorData + Clone + Debug + Serialize,
{
    pub code: String,
    pub message: String,
    pub context: Option<Value>,
    pub hint: Option<String>,
    pub retryable: bool,
    pub internal: bool,
    pub http_status_code: Option<u16>,
    pub source: Option<Box<AlienError<GenericError>>>,
    pub human_layer_presentation: HumanLayerPresentation,
    pub error: Option<T>,
}

Canonical error container that provides a structured way to represent errors with rich metadata including error codes, human-readable messages, context, and chaining capabilities for error propagation.

This struct is designed to be both machine-readable and user-friendly, supporting serialization for API responses and detailed error reporting in distributed systems.

Fields

code: String

A unique identifier for the type of error.

This should be a short, machine-readable string that can be used by clients to programmatically handle different error types. Examples: “NOT_FOUND”, “VALIDATION_ERROR”, “TIMEOUT”

message: String

Human-readable error message.

This message should be clear and actionable for developers or end-users, providing context about what went wrong and potentially how to fix it.

context: Option<Value>

Additional diagnostic information about the error context.

This optional field can contain structured data providing more details about the error, such as validation errors, request parameters that caused the issue, or other relevant context information.

hint: Option<String>

Optional human-facing remediation hint.

retryable: bool

Indicates whether the operation that caused the error should be retried.

When true, the error is transient and the operation might succeed if attempted again. When false, retrying the same operation is unlikely to succeed without changes.

internal: bool

Indicates if this is an internal error that should not be exposed to users.

When true, this error contains sensitive information or implementation details that should not be shown to end-users. Such errors should be logged for debugging but replaced with generic error messages in responses.

http_status_code: Option<u16>

HTTP status code for this error.

Used when converting the error to an HTTP response. If None, falls back to the error type’s default status code or 500.

source: Option<Box<AlienError<GenericError>>>

The underlying error that caused this error, creating an error chain.

This allows for proper error propagation and debugging by maintaining the full context of how an error occurred through multiple layers of an application.

human_layer_presentation: HumanLayerPresentation

error: Option<T>

The original error for pattern matching

Implementations

impl<T> AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize,

pub fn new(meta: T) -> Self

Create an AlienError from an AlienErrorData implementor

impl AlienError<GenericError>

pub fn from_std(err: &(dyn StdError + 'static)) -> Self

Create an AlienError from a standard error

impl<T> AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize,

pub fn into_generic(self) -> AlienError<GenericError>

Convert this AlienError to AlienError without losing data

pub fn human_report(&self) -> HumanErrorReport

Trait Implementations

impl<T> Clone for AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize + Clone,

fn clone(&self) -> AlienError<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E> ContextError<E> for AlienError<E>

where E: AlienErrorData + Clone + Debug + Serialize + 'static + Send + Sync,

fn context<M: AlienErrorData + Clone + Debug + Serialize>( self, meta: M, ) -> AlienError<M>

Add context to an AlienError, wrapping it with a new error

impl<T> Debug for AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize + Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize + Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize,

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

Formats the value using the given formatter.

impl<T> Eq for AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize + Eq,

impl<T> Error for AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize,

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<T> PartialEq for AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize + PartialEq,

fn eq(&self, other: &AlienError<T>) -> 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<T> Serialize for AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for AlienError<T>

where T: AlienErrorData + Clone + Debug + Serialize,