Enum SpotWsError 

#[non_exhaustive]
pub enum SpotWsError {
    Connect(WsError),
    ConnectTimeout(Duration),
    Closed {
        code: Option<u16>,
        reason: String,
    },
    Refused {
        code: i64,
        msg: String,
    },
    NoAnswer {
        id: u64,
        timeout: Duration,
    },
    Response {
        id: u64,
        raw: String,
    },
    TooManyStreams {
        path: StreamPath,
        limit: usize,
    },
    Frame {
        stream: String,
        raw: String,
        reason: String,
    },
    Stopped {
        cause: Option<StopCause>,
    },
}

Error type for the spot socket tiers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Connect(WsError)

The connection could not be opened, or failed mid-stream: the kit’s one socket error, read through its Kind. A server close and a connect timeout have variants of their own.

ConnectTimeout(Duration)

The connection did not open within the connect timeout.

Closed

The server closed the connection, with its close code and reason when it sent them: 1008 "Too many requests" after more than 5 incoming messages in a second.

Fields

code: Option<u16>

The close code.

reason: String

The close reason.

Refused

The server answered a request with {"error": {"code", "msg"}}.

Fields

code: i64

Binance’s code.

msg: String

Binance’s message.

NoAnswer

No answer to a request, or no pong to a ping (id 0), within the answer timeout.

Fields

id: u64

The request id.

timeout: Duration

How long the client waited.

Response

An answer that was not the documented shape.

Fields

id: u64

The request id.

raw: String

The answer as sent.

TooManyStreams

A subscribe that would take a connection past Binance’s cap. Nothing was sent: a 1025th stream is not one the client probes, since the server’s answer to it closes the connection and loses all 1024.

Fields

path: StreamPath

The path whose connection is full.

limit: usize

The cap.

Frame

A text frame that did not decode as an update.

Fields

stream: String

The envelope’s stream name, or empty when there was none.

raw: String

The frame as sent.

reason: String

Why it did not decode.

Stopped

The supervised tier has stopped; its handles can no longer be used.

cause is the error a path stopped on, as Classify read it, so a stream stopped by a reconnect refused with 451 is classed and tagged as that refusal is. None when the client stopped for another reason, such as a task that panicked, or before the stop’s cause was known.

Fields

cause: Option<StopCause>

The error a path stopped on.

Trait Implementations

impl Classify for SpotWsError

The transport by the one socket table (polyoxide_venue::impl_ws_classification!), a server close by its close code, a refused request a VenueRefusal with Binance’s code in decimal, an answer or frame that did not parse a Decode, and the client’s own refusals an InvalidRequest.

One row is Binance’s own, ahead of the table (D14): a handshake refused with 403 is Restricted, as on REST. Binance’s firewall answers it, and it is not a credential failure, since the streams need none.

Every error is a fault except a handshake refused with 451: Binance does not serve the caller’s region, a defined outcome, as SpotError::RegionBlocked is on REST. A 418 ban and a 403 from the firewall stay faults. A refused handshake’s Retry-After, of any status, is the error’s wait.

Stopped follows its cause, so a stop on a 451 refusal is Restricted and not a fault; one with no cause is an InvalidRequest and a fault.

fn class(&self) -> Class

The class of this error.

fn is_fault(&self) -> bool

Whether this error is a fault, rather than the venue answering as designed. False only for defined outcomes, such as a Fill-And-Kill order that matched nothing, or a venue that does not serve the caller’s region. Alerting should key on this; retrying should not.

fn retry_after(&self) -> Option<Duration>

How long the server asked the caller to wait. Defaults to the class’s own; an error whose wait outlives its class, such as a ban that says when it lifts, overrides it. Never Some of zero.

fn is_retriable(&self) -> bool

Whether retrying could plausibly succeed, read from the class (see Class::is_retriable).

impl Debug for SpotWsError

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

Formats the value using the given formatter.

impl Display for SpotWsError

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

Formats the value using the given formatter.

impl Error for SpotWsError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<WsError> for SpotWsError

A server close is SpotWsError::Closed, a connect timeout SpotWsError::ConnectTimeout, and every other socket failure SpotWsError::Connect.

fn from(err: WsError) -> Self

Converts to this type from the input type.