Enum WsError 

#[non_exhaustive]
pub enum WsError {
    Subprotocol {
        peer: String,
    },
    Handshake {
        peer: String,
        detail: String,
    },
}

What can go wrong establishing a WebSocket.

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.

Subprotocol

The peer never agreed to carry SIP.

Refusing is the point rather than an inconvenience: without the subprotocol there is no agreement about what the frames mean, and guessing is how a stack ends up parsing somebody else’s protocol as SIP.

Fields

peer: String

Who we were talking to.

Handshake

The upgrade itself failed.

Fields

peer: String

Who we were talking to.

detail: String

What went wrong.

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, __formatter: &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.