Enum ws::ErrorKind

pub enum ErrorKind {
    Internal,
    Capacity,
    Protocol,
    Encoding(Utf8Error),
    Io(Error),
    Http(Error),
    Queue(SendError<Command>),
    Custom(Box<dyn StdError + Send + Sync>),
}

The type of an error, which may indicate other kinds of errors as the underlying cause.

Variants

Internal

Indicates an internal application error. If panic_on_internal is true, which is the default, then the application will panic. Otherwise the WebSocket will automatically attempt to send an Error (1011) close code.

Capacity

Indicates a state where some size limit has been exceeded, such as an inability to accept any more new connections. If a Connection is active, the WebSocket will automatically attempt to send a Size (1009) close code.

Protocol

Indicates a violation of the WebSocket protocol. The WebSocket will automatically attempt to send a Protocol (1002) close code, or if this error occurs during a handshake, an HTTP 400 response will be generated.

Encoding(Utf8Error)

Indicates that the WebSocket received data that should be utf8 encoded but was not. The WebSocket will automatically attempt to send a Invalid Frame Payload Data (1007) close code.

Io(Error)

Indicates an underlying IO Error. This kind of error will result in a WebSocket Connection disconnecting.

Http(Error)

Indicates a failure to parse an HTTP message. This kind of error should only occur during a WebSocket Handshake, and a HTTP 500 response will be generated.

Queue(SendError<Command>)

Indicates a failure to send a signal on the internal EventLoop channel. This means that the WebSocket is overloaded. In order to avoid this error, it is important to set Settings::max_connections and Settings:queue_size high enough to handle the load. If encountered, retuning from a handler method and waiting for the EventLoop to consume the queue may relieve the situation.

Custom(Box<dyn StdError + Send + Sync>)

A custom error kind for use by applications. This error kind involves extra overhead because it will allocate the memory on the heap. The WebSocket ignores such errors by default, simply passing them to the Connection Handler.

Trait Implementations

impl Debug for Kind

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

Formats the value using the given formatter.