Rocket/contrib/ws
Sergio Benitez 5cecc9f0be Detect and handle MessageStream WebSocket closure. 2024-05-31 13:36:32 -05:00
..
src Detect and handle MessageStream WebSocket closure. 2024-05-31 13:36:32 -05:00
Cargo.toml Use workspace lints. Resolve new nightly warnings. 2024-05-20 13:39:14 -05:00
LICENSE-APACHE Symlink license files in all crate directories. 2024-04-06 20:46:07 -07:00
LICENSE-MIT Symlink license files in all crate directories. 2024-04-06 20:46:07 -07:00
README.md Update 'SergioBenitez/Rocket' to 'rwf2/Rocket'. 2023-11-21 16:32:25 +01: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" }
    
  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.