Struct WebSocketUpgrade 

pub struct WebSocketUpgrade { /* private fields */ }

Extractor that represents a pending WebSocket upgrade. A handler takes it as an argument, then calls on_upgrade.

Extraction fails with 426 Upgrade Required if the request is not a valid WebSocket handshake.

Implementations

impl WebSocketUpgrade

pub fn on_upgrade<F, Fut>(self, callback: F) -> Response

where F: FnOnce(WebSocket) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Finish the handshake: spawn a task that runs callback with the established WebSocket once the upgrade completes, and return the 101 Switching Protocols response the engine will send.

Trait Implementations

impl FromCallParts for WebSocketUpgrade

fn from_call_parts<'life0, 'async_trait>( call: &'life0 mut Call, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

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

Build Self from a mutable borrow of the call, or return an Error (which the handler renders as the response).