Enum tokio_websockets::error::Error

#[non_exhaustive]
pub enum Error {
    AlreadyClosed,
    CannotResolveHost,
    NoUriConfigured,
    Protocol(ProtocolError),
    PayloadTooLong {
        len: usize,
        max_len: usize,
    },
    Io(Error),
    NativeTls(Error),
    InvalidDNSName(InvalidDnsNameError),
    Rustls(Error),
    UnsupportedScheme,
    Upgrade(Error),
}

Generic error when using WebSockets with this crate.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AlreadyClosed

Attempted to read from or write to a closed stream.

CannotResolveHost

DNS lookup failed.

NoUriConfigured

Available on crate feature client only.

Attempted to connect a client to a remote without configured URI.

Protocol(ProtocolError)

WebSocket protocol violation.

PayloadTooLong

Payload length limit was exceeded.

Fields

len: usize

max_len: usize

Io(Error)

I/O error.

NativeTls(Error)

Available on crate feature native-tls only.

TLS error originating in native_tls.

InvalidDNSName(InvalidDnsNameError)

Available on crate features rustls-webpki-roots or rustls-native-roots or rustls-platform-verifier only.

Attempted to connect to an invalid DNS name.

Rustls(Error)

Available on crate features rustls-webpki-roots or rustls-native-roots or rustls-platform-verifier only.

A general rustls error.

UnsupportedScheme

Available on crate feature client only.

An unsupported, i.e. not ws or wss, or no URI scheme was specified.

Upgrade(Error)

Available on crate features client or server only.

The HTTP/1.1 Upgrade failed.

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

Available on crate features client or server only.

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

Available on crate features rustls-webpki-roots or rustls-native-roots or rustls-platform-verifier only.

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

Available on crate feature native-tls only.

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<InvalidDnsNameError> for Error

Available on crate features rustls-webpki-roots or rustls-native-roots or rustls-platform-verifier only.

fn from(err: InvalidDnsNameError) -> Self

Converts to this type from the input type.

impl From<ProtocolError> for Error

fn from(err: ProtocolError) -> Self

Converts to this type from the input type.