History

Sergio Benitez ab82064354 Update 'SergioBenitez/Rocket' to 'rwf2/Rocket'. Resolves rwf2/rwf2#5.		2023-11-22 21:41:51 +01:00
..
src	Update version numbers for 0.5.0.	2023-11-17 16:38:14 +01:00
Cargo.toml	Update 'SergioBenitez/Rocket' to 'rwf2/Rocket'.	2023-11-22 21:41:51 +01:00
README.md	Update 'SergioBenitez/Rocket' to 'rwf2/Rocket'.	2023-11-22 21:41:51 +01: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" }

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.