Enum WebSocketError 

pub enum WebSocketError {
    Connect(Error),
    Handshake(WebSocketError),
    InvalidDomain(InvalidDnsNameError),
    MissingHost,
    TlsStream(Error),
    TlsConfig(Error),
    BuildRequest(Error),
    UnsupportedScheme(String),
    Runtime(WebSocketError),
}

Errors that surface from the streamer transport (TCP / TLS / WebSocket handshake plus any frame-level error after the socket is up).

Variants

Connect(Error)

TCP connect failed.

Handshake(WebSocketError)

WebSocket upgrade handshake failed.

InvalidDomain(InvalidDnsNameError)

streamerSocketUrl host is not a valid DNS name.

MissingHost

streamerSocketUrl did not include a host component.

TlsStream(Error)

TLS handshake failed on top of the TCP socket.

TlsConfig(Error)

Building the rustls client config failed.

BuildRequest(Error)

Building the HTTP upgrade request failed.

UnsupportedScheme(String)

streamerSocketUrl used a scheme that is not permitted for the current build. wss:// is always accepted; ws:// is accepted only in debug builds, because a plaintext WebSocket would carry the bearer token in the LOGIN frame in the clear. Any other scheme (or a URL with no scheme at all) is always rejected.

Runtime(WebSocketError)

Runtime frame error after the websocket is up: read/write/control frame failures from fastwebsockets.

Implementations

impl WebSocketError

pub fn is_retryable(&self) -> bool

Whether a fresh connect (and re-login) is worth attempting after this error. Returns false for configuration-shaped failures that will fail identically on retry (bad scheme, missing host, malformed upgrade request, rustls config error) and true for transport- or session-level failures (TCP connect, TLS handshake, WebSocket handshake, post-handshake frame errors).

Used by crate::Error::is_retryable to classify crate::Error::WebSocket.

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.

impl From<WebSocketError> for Error

fn from(source: WebSocketError) -> Self

Converts to this type from the input type.

impl From<WebSocketError> for WebSocketError

fn from(source: WebSocketError) -> Self

Converts to this type from the input type.