Rocket/contrib/ws/README.md

ws

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-rc.3" }
   

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.