README.md

Zero-cost asynchronous programming in Rust

Documentation | Website

Usage

Add this to your Cargo.toml:

[dependencies]
futures-preview = "=0.3.0-alpha.17"

Now, you can use futures-rs:

use futures::future::Future; // Note: It's not `futures_preview`

The current futures-rs requires Rust 1.36 or later.

Feature std

Futures-rs works without the standard library, such as in bare metal environments. However, it has a significantly reduced API surface. To use futures-rs in a #[no_std] environment, use:

[dependencies]
futures-preview = { version = "=0.3.0-alpha.17", default-features = false }

Feature async-await

The async-await feature provides several convenient features using unstable async/await. Note that this is an unstable feature, and upstream changes might prevent it from compiling. To use futures-rs with async/await, use:

[dependencies]
futures-preview = { version = "=0.3.0-alpha.17", features = ["async-await", "nightly"] }

The current async-await feature requires Rust nightly 2019-05-09 or later.

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in futures-rs by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.