Enum WebSocketError 

pub enum WebSocketError {
    NotUpgradeRequest,
    UnsupportedSubprotocol,
    Upgrade(Error),
}

Errors from the WebSocket handshake.

Variants

NotUpgradeRequest

The request was not a valid WebSocket upgrade (missing/invalid Upgrade / Connection / Sec-WebSocket-Key).

UnsupportedSubprotocol

The client offered no subprotocol the server accepts: it didn’t offer DEFAULT_SUBPROTOCOL (h2ts), the handler’s selector declined, and AcceptOptions::allow_implicit_codec was off. Reject it with a 400 (see WebSocketError::rejection_response).

Upgrade(Error)

hyper failed to upgrade the connection after the 101 was sent.

Implementations

impl WebSocketError

pub fn rejection_response(&self) -> Response<Empty<Bytes>>

The HTTP response to reject this handshake with, for the pre-upgrade errors returned by accept / accept_with / accept_with_options: 426 Upgrade Required for a non-WebSocket request, 400 Bad Request for an unsupported subprotocol. (An Upgrade error happens after the 101 and has no meaningful rejection response; it maps to 500 for completeness.)

let (response, ws_fut) = match h2ts_server::accept(&mut req) {
    Ok(pair) => pair,
    Err(err) => return Ok(err.rejection_response()), // send the 4xx back
};

Trait Implementations

impl Debug for WebSocketError

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

Formats the value using the given formatter.

impl Display for WebSocketError

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

Formats the value using the given formatter.

impl Error for WebSocketError

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.