Struct ProtocolError 

pub struct ProtocolError {
    pub message: String,
    pub retriable: bool,
    pub details: Option<Value>,
    pub class: Option<String>,
    pub retry_after_ms: Option<u64>,
}

Fields

message: String

retriable: bool

details: Option<Value>

Structured diagnostics for the failure — the machine-readable half of message.

Worth its own field because message is prose: without this, a child with anything structured to say has to format JSON into a sentence and hope the reader parses it back out.

class: Option<String>

What kind of failure this was, using domarinn’s error-class vocabulary (provider_auth, provider_rate_limit, provider_timeout, …).

Without it every exec failure is indistinguishable from every other, so a child that knows perfectly well its credential was rejected cannot say so. Unrecognized values are kept verbatim, same as empty_reason.

retry_after_ms: Option<u64>

How long to wait before retrying, in milliseconds — a Retry-After the child received and would otherwise have to swallow. Only meaningful alongside retriable: true.

Trait Implementations

impl Clone for ProtocolError

fn clone(&self) -> ProtocolError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolError

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

Formats the value using the given formatter.

impl Default for ProtocolError

fn default() -> ProtocolError

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProtocolError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProtocolError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.