Enum HandshakeError 

pub enum HandshakeError {
    GetMethodRequired,
    NoWebsocketUpgrade,
    NoConnectionUpgrade,
    NoVersionHeader,
    UnsupportedVersion,
    BadWebsocketKey,
    BadWebsocketProtocol,
}

Errors produced while validating a WebSocket opening handshake.

Variants

GetMethodRequired

Only get method is allowed

NoWebsocketUpgrade

Upgrade header if not set to websocket

NoConnectionUpgrade

Connection header is not set to upgrade

NoVersionHeader

Websocket version header is not set

UnsupportedVersion

Unsupported websocket version

BadWebsocketKey

Websocket key is not set or wrong

BadWebsocketProtocol

The selected WebSocket subprotocol was not requested by the client.

Trait Implementations

impl Clone for HandshakeError

fn clone(&self) -> HandshakeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HandshakeError

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, __formatter: &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<E> From<HandshakeError> for WsError<E>

fn from(source: HandshakeError) -> Self

Converts to this type from the input type.

impl PartialEq for HandshakeError

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

Equality operator ==.

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

Inequality operator !=.

impl ResponseError for HandshakeError

fn error_response(&self) -> Response

Creates an HTTP response for this error.

impl StructuralPartialEq for HandshakeError

impl<St> WebResponseError<St, DefaultError> for HandshakeError

Available on crate feature ws only.

Error renderer for ws::HandshakeError

fn error_response(&self, _: &St) -> HttpResponse

Generate response for error

fn into(self) -> Box<dyn WebResponseError<St, Err>>

where Self: Sized,

Convert the error into a boxed trait object.