Struct ClientErrorEnvelope 

pub struct ClientErrorEnvelope {
    pub code: ClientErrorCode,
    pub retryable: bool,
    pub retry_after_ms: Option<u64>,
    pub message: String,
}

Stable error envelope.

Fields

code: ClientErrorCode

Stable machine-readable error code.

retryable: bool

Whether the SDK may retry.

retry_after_ms: Option<u64>

Optional retry-after in milliseconds.

message: String

Redacted message for humans.

Implementations

impl ClientErrorEnvelope

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

Create a redacted error envelope.

pub fn with_retry_after_ms(self, retry_after_ms: u64) -> Self

Attach retry-after.

Trait Implementations

impl Clone for ClientErrorEnvelope

fn clone(&self) -> ClientErrorEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientErrorEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientErrorEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ClientErrorEnvelope

impl PartialEq for ClientErrorEnvelope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ClientErrorEnvelope

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 ClientErrorEnvelope