Enum WebSocketError 

pub enum WebSocketError {
    Configuration {
        reason: String,
    },
    Entitlement {
        cluster: WebSocketCluster,
    },
    StreamEntitlement {
        stream: String,
    },
    Timeout {
        operation: &'static str,
        endpoint: String,
    },
    Transport {
        operation: &'static str,
        endpoint: String,
        reason: String,
    },
    Server {
        event: String,
        status: Option<u16>,
        endpoint: String,
        body: String,
    },
    Protocol {
        endpoint: String,
        reason: String,
        body: String,
    },
    Closed {
        endpoint: String,
    },
}

A specific connection, configuration, server, or protocol failure.

Variants

Configuration

Invalid local configuration or subscription symbols.

Fields

reason: String

The actionable validation failure.

Entitlement

The account has no configured grant for this cluster.

Fields

cluster: WebSocketCluster

The requested cluster.

StreamEntitlement

The requested current market stream has no configured grant.

Fields

stream: String

The requested stream identifier.

Timeout

A bounded operation exceeded its configured timeout.

Fields

operation: &'static str

The operation that exceeded its deadline.

endpoint: String

The requested endpoint.

Transport

An HTTP upgrade or active transport operation failed.

Fields

operation: &'static str

The failed operation.

endpoint: String

The requested endpoint.

reason: String

The underlying error, including HTTP status/body when available.

Server

A server control explicitly rejected a request or authentication.

Fields

event: String

The failed control event.

status: Option<u16>

The provider’s top-level status code, if supplied.

endpoint: String

The requested endpoint.

body: String

The complete redacted server control payload.

Protocol

The remote payload failed strict runtime validation.

Fields

endpoint: String

The requested endpoint.

reason: String

The exact validation failure.

body: String

The credential-redacted payload.

Closed

A command was attempted after a completed remote close.

Fields

endpoint: String

The closed connection’s endpoint.

Trait Implementations

impl Debug for WebSocketError

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

Formats the value using the given formatter.

impl Display for WebSocketError

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

Formats the value using the given formatter.

impl Error for WebSocketError

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.