Struct ErrorEnvelope 

pub struct ErrorEnvelope {
    pub kind: String,
    pub code: Option<String>,
    pub terminal_reason: Option<LlmTerminalReason>,
    pub user_message: String,
    pub raw: Option<String>,
    pub retryable: Option<bool>,
    pub provider_failure_kind: Option<ProviderFailureKind>,
}

Structured error payload carried on SessionEvent::Error (and SessionEvent::RetryStatus).

Durability: this type appears inside persisted session snapshots and turn checkpoints, so every field added after the initial shape must stay additive — #[serde(default)] on decode and #[serde(skip_serializing_if = "Option::is_none")] on encode — to keep old snapshots decodable and new snapshots readable by older readers.

Fields

kind: String

code: Option<String>

terminal_reason: Option<LlmTerminalReason>

user_message: String

raw: Option<String>

retryable: Option<bool>

Whether the failing operation is safe to retry, when the source carries a typed signal (provider transports classify retryability). None means the source did not know.

provider_failure_kind: Option<ProviderFailureKind>

Typed provider-failure classification, set only when the error came from an LLM provider/transport failure whose kind was classified (an unclassified Unknown kind is surfaced as None).

Trait Implementations

impl Clone for ErrorEnvelope

fn clone(&self) -> ErrorEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorEnvelope

fn deserialize<__D>( __deserializer: __D, ) -> Result<ErrorEnvelope, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ErrorEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.