Struct ErrorEnvelope 

pub struct ErrorEnvelope {
    pub exit_code: i32,
    pub error_code: String,
    pub message: String,
    pub remote_exit_code: Option<i32>,
    pub error_class: ErrorClass,
    pub retryable: bool,
    pub suggestion: Option<String>,
    pub target_resolved: Option<String>,
    pub target_source: Option<TargetSource>,
    pub host_resolved: Option<String>,
    pub host_source: Option<TargetSource>,
    pub active_fallback: Option<bool>,
}

Stderr failure envelope when JSON errors mode is active.

Agents must read retryable / error_class before re-invoking (Rules Rust — retry/backoff). Historical clients that only inspect exit_code remain valid (additionalProperties / unknown-field ignore on the consumer side).

Fields

exit_code: i32

Process exit code (sysexits-inspired).

error_code: String

Stable machine code (vps_not_found, tls, …) — G-ERR-08.

message: String

Human-readable message (may be localized).

remote_exit_code: Option<i32>

Optional remote shell exit when process exit is general failure.

error_class: ErrorClass

High-level class (transient | permanent | cancelled).

retryable: bool

Whether an agent may re-invoke with the same argv after backoff.

suggestion: Option<String>

Optional short remediation hint for agents.

target_resolved: Option<String>

Host this process had resolved when the failure occurred (canonical name).

GAP-SSH-EXEC-ENVELOPE-002 asks for the audit fields on the error path because the failing step is where the target matters most: a step-zero failure on the wrong machine and one on the right machine were byte-identical envelopes.

Absent — not empty — when the failure predates target resolution, which is most usage errors. None says “no host was chosen”; "" would assert that a host was chosen and is nameless. Only one of those is true.

target_source: Option<TargetSource>

How Self::target_resolved was obtained (canonical name).

host_resolved: Option<String>

Compatibility alias of Self::target_resolved (0.5.5 spelling).

Written from the same value, never independently — see crate::json_wire::TargetEcho for why both spellings ship.

host_source: Option<TargetSource>

Compatibility alias of Self::target_source (0.5.5 spelling).

active_fallback: Option<bool>

Whether that host came from the active marker instead of argv.

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 Eq for ErrorEnvelope

impl PartialEq for ErrorEnvelope

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

Equality operator ==.

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

Inequality operator !=.

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.

impl StructuralPartialEq for ErrorEnvelope