README.md

tide-websockets

experimental websockets handler for tide based on async-tungstenite

• CI
• API Docs
• Releases

Installation

$ cargo add tide-websockets

Using with tide

This can either be used as a middleware or as an endpoint. If used as a middleware, the endpoint will be executed if the request is not a websocket upgrade. If used as an endpoint but the request is not a websocket request, tide will reply with a 426 Upgrade Required status code.

see the example for the most up-to-date example of usage

Safety

This crate uses #![deny(unsafe_code)] to ensure everything is implemented in 100% Safe Rust.

Alternatives

• tide-websockets-sink - A fork of this project that implements the Sink trait.

License

^{Licensed under either of Apache License, Version 2.0 or MIT license at your option.}
_{Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.}