Struct ErrorEnvelope 

pub struct ErrorEnvelope {
    pub category: ErrorCategory,
    pub severity: ErrorSeverity,
    pub recoverable: bool,
    pub code: String,
    pub message: String,
    pub hint: Option<String>,
}

Unified envelope used when crossing subsystem boundaries.

Fields

category: ErrorCategory

severity: ErrorSeverity

recoverable: bool

code: String

message: String

hint: Option<String>

Actionable user hint (HTTP error.hint, TUI status line).

Implementations

impl ErrorEnvelope

pub fn new( category: ErrorCategory, severity: ErrorSeverity, recoverable: bool, code: impl Into<String>, message: impl Into<String>, ) -> Self

pub fn is_network_retryable(&self) -> bool

Whether stream/turn outer retries should consume budget for this envelope (A3.2).

pub fn to_wire_error_body(&self, http_status: u16) -> Value

JSON body for HTTP ApiError and desktop clients (error object).

pub fn transient(message: impl Into<String>) -> Self

Recoverable internal error — stream stalls, transient retries, generic engine errors that the user can resolve by retrying. Severity is Warning so the UI surfaces it in amber rather than red.

pub fn fatal(message: impl Into<String>) -> Self

Non-recoverable internal error — missing client, spawn failure, etc. Flips the session into offline mode.

pub fn fatal_auth(message: impl Into<String>) -> Self

Authentication failure — fatal and blocks the session.

pub fn context_overflow(message: impl Into<String>) -> Self

Context length / overflow — invalid input, recoverable via /compact.

pub fn network(message: impl Into<String>) -> Self

Recoverable network / transport hiccup.

pub fn tool(message: impl Into<String>) -> Self

Tool execution failure.

impl ErrorEnvelope

pub fn classify(message: impl Into<String>, recoverable: bool) -> Self

Build an envelope by classifying a raw error message string. Used at boundaries where the underlying error type was already stringified.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ErrorEnvelope

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

Formats the value using the given formatter.

impl Error for ErrorEnvelope

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 From<ToolError> for ErrorEnvelope

fn from(value: ToolError) -> Self

Converts to this type from the input type.

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.