futures-rs Documentation

Zero-cost asynchronous programming in Rust

5,854 stars Rust Rust 1 file ยท ~1,370 tokens #async-foundations
RAW Doc

File: README.md

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.71 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 or
MIT license 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.


File: futures-channel/README.md

futures-channel

Channels for asynchronous communication using futures-rs.

Usage

Add this to your Cargo.toml:

toml
[dependencies]
futures-channel = "0.3"

The current futures-channel requires Rust 1.71 or later.

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 the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.


File: futures-core/README.md

futures-core

The core traits and types in for the futures library.

Usage

Add this to your Cargo.toml:

toml
[dependencies]
futures-core = "0.3"

The current futures-core requires Rust 1.36 or later.

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 the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.


File: futures-executor/README.md

futures-executor

Executors for asynchronous tasks based on the futures-rs library.

Usage

Add this to your Cargo.toml:

toml
[dependencies]
futures-executor = "0.3"

The current futures-executor requires Rust 1.71 or later.

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 the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.


File: futures-io/README.md

futures-io

The AsyncRead, AsyncWrite, AsyncSeek, and AsyncBufRead traits for the futures-rs library.

Usage

Add this to your Cargo.toml:

toml
[dependencies]
futures-io = "0.3"

The current futures-io requires Rust 1.36 or later.

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 the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.


File: futures-sink/README.md

futures-sink

The asynchronous Sink trait for the futures-rs library.

Usage

Add this to your Cargo.toml:

toml
[dependencies]
futures-sink = "0.3"

The current futures-sink requires Rust 1.36 or later.

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 the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.


File: futures-task/README.md

futures-task

Tools for working with tasks.

Usage

Add this to your Cargo.toml:

toml
[dependencies]
futures-task = "0.3"

The current futures-task requires Rust 1.71 or later.

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 the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.


File: futures-util/README.md

futures-util

Common utilities and extension traits for the futures-rs library.

Usage

Add this to your Cargo.toml:

toml
[dependencies]
futures-util = "0.3"

The current futures-util requires Rust 1.71 or later.

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 the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.