Enum WebSocketErrorKind 

#[non_exhaustive]
pub enum WebSocketErrorKind {
    ConnectionClosed,
    AlreadyClosed,
    Url,
    Protocol,
    Capacity,
    Io,
    Other,
}

Classification of a WebSocketError returned by WebSocketError::kind.

#[non_exhaustive] so new variants may be added in minor releases without breaking callers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ConnectionClosed

Peer cleanly closed the connection (WebSocketError::is_connection_closed).

AlreadyClosed

Connection was already closed when the operation was attempted — caller bug or race (WebSocketError::is_already_closed).

Url

WebSocket URL was invalid (WebSocketError::is_url).

Protocol

WebSocket protocol violation — malformed frame, invalid opcode, etc. (WebSocketError::is_protocol).

Capacity

Frame or message exceeded a configured size limit (WebSocketError::is_capacity).

Io

Error wraps an underlying std::io::Error (WebSocketError::is_io).

Other

Categorisation did not match any of the variants above. May appear for tungstenite error variants not yet covered by this crate’s classification (e.g. Tls, Http, future additions).

Trait Implementations

impl Clone for WebSocketErrorKind

fn clone(&self) -> WebSocketErrorKind

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebSocketErrorKind

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

Formats the value using the given formatter.

impl Eq for WebSocketErrorKind

impl Hash for WebSocketErrorKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WebSocketErrorKind

fn eq(&self, other: &WebSocketErrorKind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WebSocketErrorKind