Struct WebSocketUpgrade 

pub(super) struct WebSocketUpgrade {
    key: HeaderValue,
    on_upgrade: OnUpgrade,
    protocol: Option<&'static str>,
    config: WebSocketConfig,
}

A request which asks for a WebSocket, checked like RFC 6455 says.

Fields

key: HeaderValue

on_upgrade: OnUpgrade

protocol: Option<&'static str>

config: WebSocketConfig

Implementations

impl WebSocketUpgrade

pub(super) fn from_request<B>( request: &mut Request<B>, ) -> Result<Self, Box<Response<Body>>>

Check the request, the rejection is the response to send otherwise. The server speaks HTTP/1 only, where a WebSocket starts with a GET.

pub(super) fn protocol(self, protocol: Option<&'static str>) -> Self

The subprotocol the server picked out of the ones of the client.

pub(super) fn max_message_size(self, max: usize) -> Self

The largest message and frame the client may send.

pub(super) fn on_upgrade<C, F>(self, callback: C) -> Response<Body>

where C: FnOnce(WebSocketStream<ClientIo<TokioIo<Upgraded>>>) -> F + Send + 'static, F: Future<Output = ()> + Send + 'static,

Answer the request, the WebSocket goes to callback once the connection got upgraded.