Struct ErrorEnvelope 

#[non_exhaustive]
pub struct ErrorEnvelope {
    pub kind: ErrorKind,
    pub message: String,
    pub attempt_id: Option<String>,
    pub account: Option<String>,
    pub status: Option<u16>,
    pub retry_after: Option<u64>,
    pub duration: Option<u64>,
    pub code: Option<String>,
}

Wire form of an Error with enough structure to rebuild the typed variant on the other side of a process boundary.

message is the variant’s own detail (or the fixed Display text for payload-free variants), never the full Display string, so decoding does not double-prefix. Error::Broker details are omitted on purpose; only the upstream status crosses the boundary. Errors wrapping foreign types (auth, network, web_socket, url_parse, stream) cannot be rebuilt and decode to Error::Unknown carrying their Display text.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: ErrorKind

message: String

attempt_id: Option<String>

account: Option<String>

status: Option<u16>

Upstream HTTP status for broker, http and remote.

retry_after: Option<u64>

Seconds to wait for rate_limit.

duration: Option<u64>

Seconds elapsed for timeout.

code: Option<String>

Schwab error code for api.

Trait Implementations

impl Clone for ErrorEnvelope

fn clone(&self) -> Self

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 From<&Error> for ErrorEnvelope

fn from(error: &Error) -> Self

Converts to this type from the input type.

impl From<ErrorEnvelope> for Error

fn from(envelope: ErrorEnvelope) -> Self

Converts to this type from the input type.

impl PartialEq for ErrorEnvelope

fn eq(&self, other: &Self) -> 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