History

Sergio Benitez 7d895eb9f6 Add initial implementation of 'rocket_ws'. This provides WebSocket support in Rocket's official 'contrib'.		2023-04-01 15:02:24 -07:00
..
src	Add initial implementation of 'rocket_ws'.	2023-04-01 15:02:24 -07:00
Cargo.toml	Add initial implementation of 'rocket_ws'.	2023-04-01 15:02:24 -07:00
README.md	Add initial implementation of 'rocket_ws'.	2023-04-01 15:02:24 -07:00

README.md

`ws`

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

Usage

Depend on rocket_ws, renamed here to ws:

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

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.