Enum Error 

pub enum Error {
    Io(Error),
    InvalidFrame(&'static str),
    InvalidUtf8,
    Protocol(&'static str),
    ConnectionClosed,
    MessageTooLarge,
    FrameTooLarge,
    InvalidHttp(&'static str),
    HandshakeFailed(&'static str),
    BufferFull,
    WouldBlock,
    ConnectionReset,
    InvalidState(&'static str),
    Closed(Option<CloseReason>),
    InvalidCloseCode(u16),
    Capacity(&'static str),
    Compression(String),
    ExtendedConnectNotSupported,
    StreamReset,
}

WebSocket error types

Variants

Io(Error)

I/O error from the underlying socket

InvalidFrame(&'static str)

Invalid WebSocket frame

InvalidUtf8

Invalid UTF-8 in text message

Protocol(&'static str)

Protocol violation

ConnectionClosed

Connection closed normally

MessageTooLarge

Message too large

FrameTooLarge

Frame too large

InvalidHttp(&'static str)

Invalid HTTP request

HandshakeFailed(&'static str)

Handshake failed

BufferFull

Buffer full (backpressure)

WouldBlock

Would block (non-blocking I/O)

ConnectionReset

Connection reset by peer

InvalidState(&'static str)

Invalid state

Closed(Option<CloseReason>)

Close frame received

InvalidCloseCode(u16)

Invalid close code

Capacity(&'static str)

Capacity exceeded

Compression(String)

Compression/decompression error

ExtendedConnectNotSupported

Extended CONNECT protocol not supported by server

StreamReset

Stream was reset by peer

Implementations

impl Error

pub fn kind(&self) -> ErrorKind

Get the error category/kind

Useful for metrics, logging, and error handling decisions.

pub fn is_fatal(&self) -> bool

Check if this error is fatal (connection cannot continue)

Fatal errors indicate the connection is broken and cannot be recovered. Non-fatal errors may allow the connection to continue after handling.

pub fn is_recoverable(&self) -> bool

Check if this error is recoverable

Recoverable errors are transient and the operation may succeed if retried.

pub fn is_timeout(&self) -> bool

Check if this error is a timeout

Note: Timeout errors are typically wrapped by the caller using tokio::time::timeout, but some transport errors may indicate timeouts.

pub fn is_connection_error(&self) -> bool

Check if this error is a connection error

pub fn is_protocol_error(&self) -> bool

Check if this error is a protocol error

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

Get a metric-friendly name for this error

Returns a short, lowercase, underscore-separated string suitable for use in metrics labels.

pub fn suggested_http_status(&self) -> u16

Get a suggested HTTP status code for this error

Useful when converting WebSocket errors to HTTP responses during handshake or in HTTP/2/HTTP/3 contexts.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.