Enum Error 

pub enum Error {
    Io(Error),
    Protocol(ProtocolError),
    Encode(EncodeError),
    Handshake(HandshakeError),
    Tls(TlsError),
    InvalidUrl(String),
    TlsNotEnabled,
}

Unified error type for WebSocket stream operations.

Variants

Io(Error)

I/O error from the underlying stream.

Protocol(ProtocolError)

WebSocket protocol error.

Encode(EncodeError)

Encoding error (e.g., control frame payload too large).

Handshake(HandshakeError)

HTTP handshake failed.

Tls(TlsError)

TLS error during connection setup (handshake, certificate validation, SNI hostname verification).

Steady-state TLS protocol errors (decrypt failure, peer alert, malformed record received during a frame) on the async nexus-async-web paths surface as Error::Io instead — the underlying TlsError is wrapped via io::Error::other and reachable via io_err.source() or io_err.get_ref(). This asymmetry stems from the WireStream trait returning io::Result for poll methods. Sync WS surfaces Tls directly because its TlsStream exposes TlsError natively. Pattern- match on both Io and Tls if you need to distinguish TLS- protocol failures from generic transport failures across both surfaces.

InvalidUrl(String)

Invalid WebSocket URL.

TlsNotEnabled

wss:// URL used without the tls feature enabled.

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

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<EncodeError> for Error

fn from(e: EncodeError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<HandshakeError> for Error

fn from(e: HandshakeError) -> Self

Converts to this type from the input type.

impl From<ProtocolError> for Error

fn from(e: ProtocolError) -> Self

Converts to this type from the input type.

impl From<TlsError> for Error

Available on crate feature tls only.

fn from(e: TlsError) -> Self

Converts to this type from the input type.