Enum WsError 

pub enum WsError {
    Protocol(String),
    TooLarge {
        size: usize,
        limit: usize,
    },
    InvalidUtf8,
    Idle,
    Full,
    Closed,
    Io(Error),
}

Variants

Protocol(String)

The peer broke the framing rules: a reserved bit set, an unmasked client frame, a continuation that started nothing.

TooLarge

A frame or a reassembled message exceeded the configured limit.

Fields

size: usize

limit: usize

InvalidUtf8

A text frame whose payload was not valid UTF-8. RFC 6455 is explicit that this closes with 1007 rather than being passed to the application.

Idle

The peer stopped answering pings within the idle timeout.

Full

The peer’s send queue is full: it is not reading fast enough to keep up. The only safe answer is to drop it, so this is a distinct variant rather than an I/O error.

Closed

The connection is already closed, so there is nothing to send on.

Io(Error)

Implementations

impl WsError

pub fn protocol(message: impl Into<String>) -> Self

pub fn close_code(&self) -> CloseCode

The close code this failure should be reported to the peer with.

Trait Implementations

impl Debug for WsError

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

Formats the value using the given formatter.

impl Display for WsError

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

Formats the value using the given formatter.

impl Error for WsError

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 WsError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<WsError> for Error

So a handler that talks to a socket can still use ? alongside the rest of the framework’s error type.

fn from(e: WsError) -> Self

Converts to this type from the input type.