Struct ErrorEnvelope 

pub struct ErrorEnvelope {
    pub category: String,
    pub code: String,
    pub exit_code: i32,
    pub message: String,
    pub hint: Option<String>,
    pub details: Option<Value>,
}

Stable error payload carried in Envelope::error.

Field naming is locked by the machine-readable-output/error-handling specs.

Fields

category: String

Stable snake_case category from the closed SubXError set or the synthetic "argument_parsing" category for clap failures.

code: String

Stable upper-snake-case machine code (e.g. E_AI_SERVICE).

exit_code: i32

Process exit code returned alongside the envelope.

message: String

Human-readable message (English; matches user_friendly_message).

hint: Option<String>

Optional short remediation hint.

details: Option<Value>

Optional structured details (partial results, etc.).

Implementations

impl ErrorEnvelope

pub fn from_error(err: &SubXError) -> Self

Build an envelope from a SubXError.

pub fn argument_parsing(message: String, exit_code: i32) -> Self

Build the synthetic envelope used for clap argument-parsing failures. The category argument_parsing is intentionally NOT part of the closed SubXError-derived set.

Trait Implementations

impl Debug for ErrorEnvelope

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

Formats the value using the given formatter.

impl Serialize for ErrorEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.