# async-tungstenite Asynchronous WebSockets for [async-std](https://async.rs), [tokio](https://tokio.rs), [gio](https://www.gtk-rs.org) and any `std` `Future`s runtime. [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) [![Crates.io](https://img.shields.io/crates/v/async-tungstenite.svg?maxAge=2592000)](https://crates.io/crates/async-tungstenite) [![Build Status](https://travis-ci.org/sdroege/async-tungstenite.svg?branch=master)](https://travis-ci.org/sdroege/async-tungstenite) [Documentation](https://docs.rs/async-tungstenite) ## Usage Add this in your `Cargo.toml`: ```toml [dependencies] async-tungstenite = "*" ``` Take a look at the `examples/` directory for client and server examples. You may also want to get familiar with [async-std](https://async.rs/) or [tokio](https://tokio.rs) if you don't have any experience with it. ## What is async-tungstenite? This crate is based on [tungstenite](https://crates.io/crates/tungstenite) Rust WebSocket library and provides async bindings and wrappers for it, so you can use it with non-blocking/asynchronous `TcpStream`s from and couple it together with other crates from the async stack. In addition, optional integration with various other crates can be enabled via feature flags * `async-tls`: Enables the `async_tls` module, which provides integration with the [async-tls](https://crates.io/crates/async-tls) TLS stack and can be used independent of any async runtime. * `async-std-runtime`: Enables the `async_std` module, which provides integration with the [async-std](https://async.rs) runtime. * `async-native-tls`: Enables the additional functions in the `async_std` module to implement TLS via [async-native-tls](https://crates.io/crates/async-native-tls). * `tokio-runtime`: Enables the `tokio` module, which provides integration with the [tokio](https://tokio.rs) runtime. * `tokio-tls`: Enables the additional functions in the `tokio` module to implement TLS via [tokio-tls](https://crates.io/crates/tokio-tls). * `gio-runtime`: Enables the `gio` module, which provides integration with the [gio](https://gtk-rs.org) runtime. ## tokio-tungstenite Originally this crate was created as a fork of [tokio-tungstenite](https://github.com/snapview/tokio-tungstenite) and ported to the traits of the [`futures`](https://crates.io/crates/futures) crate. Integration into async-std, tokio and gio was added on top of that.