Struct ProtocolError 

pub struct ProtocolError {
    pub code: ErrorCode,
    pub message: String,
    pub detail: Option<String>,
    pub retryable: bool,
}

A refusal on the wire.

message is prose for a human and is never parsed. detail carries the one machine-readable hint a caller legitimately needs — which service was unknown, which limit was exceeded — and is deliberately a flat string rather than an open object, so an error can never become a second payload channel carrying local state off the machine.

Fields

code: ErrorCode

message: String

detail: Option<String>

retryable: bool

Repeated from ErrorCode::retryable so a peer that does not know the code still knows what to do with it. A peer that does know the code must trust its own table over this field — otherwise a hostile relay could mark a timeout retryable and drive a double mutation.

Implementations

impl ProtocolError

pub fn new(code: ErrorCode, message: impl Into<String>) -> Self

pub fn with_detail(self, detail: impl Into<String>) -> Self

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<'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 Eq for ProtocolError

impl PartialEq for ProtocolError

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

Equality operator ==.

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

Inequality operator !=.

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.

impl StructuralPartialEq for ProtocolError