Enum tungstenite::error::Error

source ·
pub enum Error {
    ConnectionClosed,
    AlreadyClosed,
    Io(Error),
    Tls(TlsError),
    Capacity(CapacityError),
    Protocol(ProtocolError),
    WriteBufferFull(Message),
    Utf8,
    AttackAttempt,
    Url(UrlError),
    Http(Response<Option<Vec<u8>>>),
    HttpFormat(Error),
}
Expand description

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)

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

§

Tls(TlsError)

TLS error.

Note that this error variant is enabled unconditionally even if no TLS feature is enabled, to provide a feature-agnostic API surface.

§

Capacity(CapacityError)

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

Protocol(ProtocolError)

Protocol violation.

§

WriteBufferFull(Message)

Message write buffer is full.

§

Utf8

UTF coding error.

§

AttackAttempt

Attack attempt detected.

§

Url(UrlError)

Invalid URL.

§

Http(Response<Option<Vec<u8>>>)

HTTP error.

§

HttpFormat(Error)

HTTP format error.

Trait Implementations§

source§

impl Debug for Error

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Error

source§

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

Formats the value using the given formatter. Read more
source§

impl Error for Error

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

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. Read more
source§

impl From<CapacityError> for Error

source§

fn from(source: CapacityError) -> Self

Converts to this type from the input type.
source§

impl From<Error> for Error

source§

fn from(err: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for Error

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for Error

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

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

source§

fn from(err: Error) -> Self

Converts to this type from the input type.
source§

impl From<FromUtf8Error> for Error

source§

fn from(_: FromUtf8Error) -> Self

Converts to this type from the input type.
source§

impl From<InvalidHeaderName> for Error

source§

fn from(err: InvalidHeaderName) -> Self

Converts to this type from the input type.
source§

impl From<InvalidHeaderValue> for Error

source§

fn from(err: InvalidHeaderValue) -> Self

Converts to this type from the input type.
source§

impl From<InvalidStatusCode> for Error

source§

fn from(err: InvalidStatusCode) -> Self

Converts to this type from the input type.
source§

impl From<InvalidUri> for Error

source§

fn from(err: InvalidUri) -> Self

Converts to this type from the input type.
source§

impl From<ProtocolError> for Error

source§

fn from(source: ProtocolError) -> Self

Converts to this type from the input type.
source§

impl From<TlsError> for Error

source§

fn from(source: TlsError) -> Self

Converts to this type from the input type.
source§

impl From<ToStrError> for Error

source§

fn from(_: ToStrError) -> Self

Converts to this type from the input type.
source§

impl From<UrlError> for Error

source§

fn from(source: UrlError) -> Self

Converts to this type from the input type.
source§

impl From<Utf8Error> for Error

source§

fn from(_: Utf8Error) -> Self

Converts to this type from the input type.
source§

impl NonBlockingError for Error

source§

fn into_non_blocking(self) -> Option<Self>

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

Auto Trait Implementations§

§

impl !Freeze for Error

§

impl !RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl !UnwindSafe for Error

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T