mirror of https://github.com/rwf2/Rocket.git synced 2025-01-27 03:42:01 +00:00

History

Sergio Benitez 186ec84f5b Improve forwarding status code precision. Previously, the `NotFound` status code was used to signal many kinds of recoverable, forwarding errors. This included validation errors, incorrect Content-Type errors, and more. This commit modifies the status code used to forward in these instances to more precisely indicate the forwarding condition. In particular: * Parameter `FromParam` errors now forward as 422 (`UnprocessableEntity`). * Query paramater errors now forward as 422 (`UnprocessableEntity`). * Use of incorrect form content-type forwards as 413 (`UnsupportedMediaType`). * `WebSocket` guard now forwards as 400 (`BadRequest`). * `&Host`, `&Accept`, `&ContentType`, `IpAddr`, and `SocketAddr` all forward with a 500 (`InternalServerError`). Additionally, the `IntoOutcome` trait was overhauled to support functionality previously offered by methods on `Outcome`. The `Outcome::forward()` method now requires a status code to use for the forwarding outcome. Finally, logging of `Outcome`s now includes the relevant status code. Resolves #2626.		2023-11-01 18:50:58 -05:00
..
src	Improve forwarding status code precision.	2023-11-01 18:50:58 -05:00
Cargo.toml	Upgrade 'tokio-tungstenite' to 0.20.	2023-10-26 20:01:06 -05:00
README.md	Fix typo in 'rocket_ws' README.	2023-10-26 20:01:06 -05: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.