blob: 355d6078e350712bf1cbab02dbc38ba0e081a6cf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
<p align="center">
<img alt="futures-rs" src="https://raw.githubusercontent.com/rust-lang/futures-rs/gh-pages/assets/images/futures-rs-logo.svg?sanitize=true" width="400">
</p>
<p align="center">
Zero-cost asynchronous programming in Rust
</p>
<p align="center">
<a href="https://github.com/rust-lang/futures-rs/actions?query=branch%3Amaster">
<img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/rust-lang/futures-rs/ci.yml?branch=master">
</a>
<a href="https://crates.io/crates/futures">
<img alt="crates.io" src="https://img.shields.io/crates/v/futures.svg">
</a>
</p>
<p align="center">
<a href="https://docs.rs/futures">
Documentation
</a> | <a href="https://rust-lang.github.io/futures-rs/">
Website
</a>
</p>
`futures-rs` is a library providing the foundations for asynchronous programming in Rust.
It includes key trait definitions like `Stream`, as well as utilities like `join!`,
`select!`, and various futures combinator methods which enable expressive asynchronous
control flow.
## Usage
Add this to your `Cargo.toml`:
```toml
[dependencies]
futures = "0.3"
```
The current `futures` requires Rust 1.56 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:
```toml
[dependencies]
futures = { version = "0.3", default-features = false }
```
## License
Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or
[MIT license](LICENSE-MIT) at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
|
