History

Sergio Benitez 02011a1307 Clean up codebase: fix reasonable clippy warnings. This commit is a codebase-wide cleanup driven by clippy warnings. In addition to fixing every reasonable warning, the following new functionality was introduced: * `Accept::new()` now takes any `T: Into<QMediaType>` iterator. * `TempFile::is_empty()` was added. * `HeaderMap` now implements `IntoIterator`. This commit makes the following breaking changes: * The `IntoCollection` trait is gone. Generics previously bound by the trait are now bound by `IntoIterator`. This affects: - `Accept::new()` - `ContentType::with_params()` - `Permission::{allow, allowed}()` * `MediaType`, `QMediaType`, and `Allow` implement `IntoIterator`, enabling most existing code to continue working without change. * The inherent `HeaderMap::into_iter()` method was removed. * The `Ok` variant in ErrorKind::Liftoff` is now `Box<Rocket<Orbit>>`.		2024-03-20 00:47:38 -07:00
..
src	Clean up codebase: fix reasonable clippy warnings.	2024-03-20 00:47:38 -07:00
Cargo.toml	Bump MSRV to 1.75 for `async fn` in traits.	2024-01-30 09:18:43 -08:00
README.md	Update 'SergioBenitez/Rocket' to 'rwf2/Rocket'.	2023-11-21 16:32:25 +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.