axum-tws is an alternative WebSocket extractor for
axum using
tokio-websockets as the
underlying WebSocket library instead of tungstenite.
It is not a complete drop-in replacement and has no intention to be one. While
your upgrade handler will look the same, working with Message types in
tokio-websockets is slightly different from tungstenite. Please refer to the
tokio-websockets
documentation for
detailed information, or take a look at the example below.
Much of the code has been ported directly from the axum::extract::ws module - all credit goes to the original authors.
Run cargo add axum-tws to add the library to your project.
use axum::{response::Response, routing::get, Router};
use axum_tws::{Message, WebSocket, WebSocketUpgrade};
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let listener = tokio::net::TcpListener::bind("127.0.0.1:3000").await?;
axum::serve(listener, Router::new().route("/ws", get(handle_upgrade))).await?;
Ok(())
}
async fn handle_upgrade(ws: WebSocketUpgrade) -> Response {
ws.on_upgrade({
move |socket| async {
if let Err(e) = handle_ws(socket).await {
println!("websocket error: {:?}", e);
}
}
})
}
async fn handle_ws(mut socket: WebSocket) -> Result<(), Box<dyn std::error::Error>> {
while let Some(Ok(msg)) = socket.recv().await {
if msg.is_text() {
socket.send(msg).await?;
}
}
Ok(())
}Contributions are always welcome! If you have an idea for a feature or find a bug, let me know. PR's are appreciated, but if it's not a small change, please open an issue first so we're all on the same page!
axum-tws is dual-licensed under either
at your option.