Enum TransportError 

pub enum TransportError {
    Io(Error),
    Handshake(String),
    InvalidUrl(String),
    Tls(String),
    Protocol(String),
    ClosedByPeer(Option<CloseFrame>),
    ConnectionClosed,
    ConnectionReset,
    MessageTooLarge,
    FrameTooLarge,
    InvalidUtf8,
    Other(String),
}

A backend-agnostic WebSocket transport error.

Each backend translates its native error type into this enum via From impls so the higher layers operate against a single error surface.

Variants

Io(Error)

Underlying I/O error from the socket.

Handshake(String)

HTTP upgrade handshake failed.

InvalidUrl(String)

URL was invalid or unsupported.

Tls(String)

TLS-layer failure during connect or stream operation.

Protocol(String)

WebSocket protocol violation reported by the peer or detected locally.

ClosedByPeer(Option<CloseFrame>)

Peer sent a close frame and the connection is closing.

ConnectionClosed

Connection closed without a close frame (abnormal).

ConnectionReset

Connection reset by peer.

MessageTooLarge

Message exceeded the configured maximum size.

FrameTooLarge

Frame exceeded the configured maximum size.

InvalidUtf8

UTF-8 validation failed on a text frame.

Only emitted by backends that validate (e.g. tokio-tungstenite); the in-house HFT backend does not validate and will not produce this.

Other(String)

Backend returned an error not covered by other variants. Carries a short description; consumers should treat as fatal.

Implementations

impl TransportError

pub fn is_fatal(&self) -> bool

Returns true if the error indicates the connection is no longer usable.

InvalidUrl is the only non-fatal variant: a bad URL is a caller-side configuration mistake that does not damage an existing connection. Everything else (including Io and the catch-all Other) implies the underlying transport cannot be reused.

pub fn is_closed(&self) -> bool

Returns true for connection-closed style errors.

Trait Implementations

impl Debug for TransportError

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

Formats the value using the given formatter.

impl Display for TransportError

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

Formats the value using the given formatter.

impl Error for TransportError

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<Error> for TransportError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TransportError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TransportError

fn from(value: SockudoError) -> Self

Converts to this type from the input type.