Struct WebSocketError 

#[non_exhaustive]
pub struct WebSocketError(/* private fields */);

WebSocket transport error reported by the underlying WebSocket client.

As with HttpError, the inner third-party type is private and diagnostics are exposed via accessor methods returning primitive types.

Implementations

impl WebSocketError

pub fn is_connection_closed(&self) -> bool

true if the peer cleanly closed the connection.

pub fn is_already_closed(&self) -> bool

true if the connection was already closed when the operation was attempted (caller bug or race).

pub fn is_io(&self) -> bool

true if the error wraps an underlying std::io::Error.

pub fn is_protocol(&self) -> bool

true if the error is a WebSocket protocol violation (malformed frame, invalid opcode, etc.).

pub fn is_capacity(&self) -> bool

true if a frame or message exceeded a configured size limit.

pub fn is_url(&self) -> bool

true if the WebSocket URL was invalid.

pub fn kind(&self) -> WebSocketErrorKind

Classify the error into a single category (bd:JMAP-6r7c.34).

Single-match alternative to the 6 is_* boolean accessors. Returns a WebSocketErrorKind so a caller can dispatch on the failure mode without chained-if-else.

Precedence (highest first): ConnectionClosed, AlreadyClosed, Url, Protocol, Capacity, Io, Other. The first three are exact tungstenite variants and are mutually exclusive; the remainder follow the is_* accessor order from this file. This method does not return retriability advice — make that decision at the call site using the kind as input.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for WebSocketError

fn source(&self) -> Option<&(dyn StdError + '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.