https://github.com/http-rs/tide-websockets

"just open a socket"
https://github.com/http-rs/tide-websockets

Last synced: about 20 hours ago
JSON representation

"just open a socket"

• Host: GitHub
• URL: https://github.com/http-rs/tide-websockets
• Owner: http-rs
• Created: 2020-11-25T22:00:09.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-05-21T00:11:58.000Z (almost 2 years ago)
• Last Synced: 2025-02-13T19:15:33.067Z (8 days ago)
• Language: Rust
• Homepage: https://docs.rs/tide-websockets/
• Size: 44.9 KB
• Stars: 74
• Watchers: 9
• Forks: 20
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# tide-websockets

## experimental websockets handler for [tide](https://github.com/http-rs/tide) based on [async-tungstenite](https://github.com/sdroege/async-tungstenite)

* [CI ![CI][ci-badge]][ci]

* [API Docs][docs] [![docs.rs docs][docs-badge]][docs]

* [Releases][releases] [![crates.io version][version-badge]][lib-rs]

[ci]: https://github.com/http-rs/tide-websockets/actions?query=workflow%3ACI

[ci-badge]: https://github.com/http-rs/tide-websockets/workflows/CI/badge.svg

[releases]: https://github.com/http-rs/tide-websockets/releases

[docs]: https://docs.rs/tide-websockets

[lib-rs]: https://lib.rs/tide-websockets

[docs-badge]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square

[version-badge]: https://img.shields.io/crates/v/tide-websockets.svg?style=flat-square

## Installation

```sh

$ 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](https://github.com/http-rs/tide-websockets/blob/main/examples/example.rs) 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](https://github.com/cryptoquick/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.