Struct WebSocketUpgrade

pub struct WebSocketUpgrade { /* private fields */ }

Implementations

impl WebSocketUpgrade

pub fn protocol(&self) -> Option<&RequestSecWebsocketProtocol>

pub fn select_protocol<S, P>( self, protocols: impl IntoIterator<Item = (S, P)>, ) -> (WebSocketResponse, PendingWebSocket, Option<P>)

where S: for<'a> PartialEq<&'a str> + TryInto<HeaderValue>,

Select a subprotocol from the ones provided, and prepare a response for the client.

pub fn ignore_protocol(self) -> (WebSocketResponse, PendingWebSocket)

Prepare a response with no subprotocol selected.

pub fn into_response( self, protocol: Option<ResponseSecWebsocketProtocol>, ) -> (WebSocketResponse, PendingWebSocket)

Prepare a response with the given subprotocol.

Trait Implementations

impl<S> FromRequestParts<S> for WebSocketUpgrade

type Rejection = WebSocketUpgradeRejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request_parts<'life0, 'life1, 'async_trait>( parts: &'life0 mut Parts, _state: &'life1 S, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform the extraction.