Struct WebSocket 

pub struct WebSocket { /* private fields */ }

WebSocket extractor for upgrading HTTP connections to WebSocket

Use this extractor in your handler to initiate a WebSocket upgrade. The extractor validates the upgrade request and returns a WebSocket that can be used to set up the connection handler.

Example

use rustapi_ws::{WebSocket, Message};

async fn ws_handler(ws: WebSocket) -> impl IntoResponse {
    ws.on_upgrade(|socket| async move {
        let (mut sender, mut receiver) = socket.split();
         
        while let Some(Ok(msg)) = receiver.next().await {
            match msg {
                Message::Text(text) => {
                    // Echo back
                    let _ = sender.send(Message::text(format!("Echo: {}", text))).await;
                }
                Message::Close(_) => break,
                _ => {}
            }
        }
    })
}

Implementations

impl WebSocket

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

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

Create a WebSocket upgrade response with a handler

The provided callback will be called with the established WebSocket stream once the upgrade is complete.

pub fn protocols(&self) -> &[String]

Get the requested protocols

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

Check if a specific protocol was requested

Trait Implementations

impl FromRequest for WebSocket

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

Extract from the full request

impl OperationModifier for WebSocket

fn update_operation(_op: &mut Operation)