Enum HandshakeError 

pub enum HandshakeError {
    NotAGet(Method),
    MissingUpgrade,
    NotWebSocket(String),
    MissingConnection,
    ConnectionNotUpgrade(String),
    MissingVersion,
    UnsupportedVersion(String),
    MissingKey,
    MalformedKey(String),
}

Why a handshake was refused.

Each variant becomes a 400 whose body names the header that was wrong, because the person reading it is usually holding a half-written client.

Variants

NotAGet(Method)

MissingUpgrade

NotWebSocket(String)

MissingConnection

ConnectionNotUpgrade(String)

MissingVersion

UnsupportedVersion(String)

MissingKey

MalformedKey(String)

Implementations

impl HandshakeError

pub fn message(&self) -> String

Trait Implementations

impl Clone for HandshakeError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HandshakeError

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

Formats the value using the given formatter.

impl Display for HandshakeError

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

Formats the value using the given formatter.

impl Eq for HandshakeError

impl Error for HandshakeError

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 IntoResponse for HandshakeError

A refused handshake answers 400 and says what was wrong, plus the version header a client would need to retry with — which is what the RFC asks for and what makes the failure debuggable from the browser console.

fn into_response(self) -> Response

impl PartialEq for HandshakeError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for HandshakeError