Struct WebSocketUpgrade 

pub struct WebSocketUpgrade {
    pub key: String,
    pub on_upgrade: Option<OnUpgrade>,
    pub extensions: Extensions,
}

Extractor for WebSocket upgrade requests

Example

async fn ws_handler(ws: WebSocketUpgrade) -> Result<Response> {
    Ok(ws.on_upgrade(|socket| async move {
        // use socket
    }))
}

Fields

key: String

on_upgrade: Option<OnUpgrade>

extensions: Extensions

Implementations

impl WebSocketUpgrade

pub fn response(&self) -> Response

Create the required 101 Switching Protocols response for the upgrade

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

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

Perform the upgrade and call the handler with the socket and captured extensions

Trait Implementations

impl FromRequest for WebSocketUpgrade

async fn from_request(req: &mut OxiditeRequest) -> Result<Self>

Perform the extraction from the request.