Struct WebSocketUpgrade 

pub struct WebSocketUpgrade { /* private fields */ }

WebSocket upgrade response

This type is returned from WebSocket handlers to initiate the upgrade handshake and establish a WebSocket connection.

Implementations

impl WebSocketUpgrade

pub fn heartbeat(self, config: WsHeartbeatConfig) -> Self

Enable WebSocket heartbeat

pub fn compress(self, config: WsCompressionConfig) -> Self

Enable WebSocket compression

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

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

Set the callback to handle the upgraded WebSocket connection

Example

ws.on_upgrade(|socket| async move {
    let (mut sender, mut receiver) = socket.split();
    while let Some(msg) = receiver.next().await {
        // Handle messages...
    }
})

pub fn protocol(self, protocol: &str) -> Self

Add a protocol to the response

Trait Implementations

impl IntoResponse for WebSocketUpgrade

fn into_response(self) -> Response<Full<Bytes>>

Convert self into a Response

impl ResponseModifier for WebSocketUpgrade

fn update_response(op: &mut Operation)

Update the operation with response information