Enum tungstenite::error::Error

pub enum Error {
    ConnectionClosed,
    AlreadyClosed,
    Io(Error),
    Capacity(Cow<'static, str>),
    Protocol(Cow<'static, str>),
    SendQueueFull(Message),
    Utf8,
    Url(Cow<'static, str>),
    Http(StatusCode),
    HttpFormat(Error),
}

Possible WebSocket errors

Variants

ConnectionClosed

WebSocket connection closed normally. This informs you of the close. It’s not an error as such and nothing wrong happened.

This is returned as soon as the close handshake is finished (we have both sent and received a close frame) on the server end and as soon as the server has closed the underlying connection if this endpoint is a client.

Thus when you receive this, it is safe to drop the underlying connection.

Receiving this error means that the WebSocket object is not usable anymore and the only meaningful action with it is dropping it.

AlreadyClosed

Trying to work with already closed connection.

Trying to read or write after receiving ConnectionClosed causes this.

As opposed to ConnectionClosed, this indicates your code tries to operate on the connection when it really shouldn’t anymore, so this really indicates a programmer error on your part.

Io(Error)

Tuple Fields

0: Error

Input-output error. Apart from WouldBlock, these are generally errors with the underlying connection and you should probably consider them fatal.

Capacity(Cow<'static, str>)

Tuple Fields

0: Cow<'static, str>

• When reading: buffer capacity exhausted.
• When writing: your message is bigger than the configured max message size (64MB by default).

Protocol(Cow<'static, str>)

Tuple Fields

0: Cow<'static, str>

Protocol violation.

SendQueueFull(Message)

Tuple Fields

0: Message

Message send queue full.

Utf8

UTF coding error

Url(Cow<'static, str>)

Tuple Fields

0: Cow<'static, str>

Invalid URL.

Http(StatusCode)

Tuple Fields

0: StatusCode

HTTP error.

HttpFormat(Error)

Tuple Fields

0: Error

HTTP format error.

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)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.

impl<Role: HandshakeRole> From<Error> for HandshakeError<Role>

fn from(err: Error) -> Self

Performs the conversion.

impl From<FromUtf8Error> for Error

fn from(_: FromUtf8Error) -> Self

Performs the conversion.

impl From<InvalidHeaderName> for Error

fn from(err: InvalidHeaderName) -> Self

Performs the conversion.

impl From<InvalidHeaderValue> for Error

fn from(err: InvalidHeaderValue) -> Self

Performs the conversion.

impl From<InvalidStatusCode> for Error

fn from(err: InvalidStatusCode) -> Self

Performs the conversion.

impl From<InvalidUri> for Error

fn from(err: InvalidUri) -> Self

Performs the conversion.

impl From<ToStrError> for Error

fn from(_: ToStrError) -> Self

Performs the conversion.

impl From<Utf8Error> for Error

fn from(_: Utf8Error) -> Self

Performs the conversion.

impl NonBlockingError for Error

fn into_non_blocking(self) -> Option<Self>

Convert WouldBlock to None and don’t touch other errors.