Enum WebSocketError 

pub enum WebSocketError {
    Connection(String),
    Send(String),
    Receive(String),
    Protocol(String),
    Internal(String),
    Timeout(Duration),
    ReconnectFailed(u32),
    BinaryPayload(String),
    HeartbeatTimeout(Duration),
    SlowConsumer(Duration),
}

Available on crate feature websockets and non-WebAssembly only.

Errors that can occur during WebSocket operations.

Variants

Connection(String)

A connection-level error occurred.

Send(String)

Failed to send a message to the peer.

Receive(String)

Failed to receive a message from the peer.

Protocol(String)

A WebSocket protocol violation was detected.

Internal(String)

An internal server error occurred.

Timeout(Duration)

The connection timed out after the given duration of inactivity.

ReconnectFailed(u32)

Reconnection failed after the specified number of attempts.

BinaryPayload(String)

The binary payload was invalid or could not be decoded.

HeartbeatTimeout(Duration)

No pong response was received within the heartbeat timeout.

SlowConsumer(Duration)

The consumer could not keep up with the message rate.

Implementations

impl WebSocketError

pub fn client_message(&self) -> &'static str

Returns a sanitized error message safe for client-facing communication.

Internal details (buffer sizes, queue depths, connection state, type names) are stripped to prevent information leakage.

pub fn internal_detail(&self) -> String

Returns the internal detail message for logging purposes.

This MUST NOT be sent to clients as it may contain sensitive internal state information.

Trait Implementations

impl Debug for WebSocketError

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

Formats the value using the given formatter.

impl Display for WebSocketError

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

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.