Rocket/contrib/ws
Fenhl f950d3e0ec Upgrade 'tokio-tungstenite' to 0.20. 2023-10-09 17:05:03 -07:00
..
src Allow status customization in 'Forward' outcomes. 2023-04-11 12:47:20 -07:00
Cargo.toml Upgrade 'tokio-tungstenite' to 0.20. 2023-10-09 17:05:03 -07:00
README.md Fix contrib 'ws' README formatting. 2023-04-04 15:37:22 -07:00

README.md

ws ci.svg crates.io docs.svg

This crate provides WebSocket support for Rocket via integration with Rocket's [connection upgrades] API.

Usage

  1. Depend on rocket_ws, renamed here to ws:

    [dependencies]
    ws = { package = "rocket_ws", version ="=0.1.0-rc.3" }
    
  2. Use it!

    #[get("/echo")]
    fn echo_stream(ws: ws::WebSocket) -> ws::Stream!['static] {
        ws::stream! { ws =>
            for await message in ws {
                yield message?;
            }
        }
    }
    

See the crate docs for full details.