Crate futures[−][src]

Abstractions for asynchronous programming.

This crate provides a number of core abstractions for writing asynchronous code:

Futures single eventual values produced by asychronous computations. Some programming languages (e.g. JavaScript) call this concept "promises".
Streams represent a series of values produced asynchronously.
Sinks provide support for asynchronous writing of data.
Executors are responsible for running asynchronous tasks.

The crate also contains abstractions for asynchronous I/O and cross-task communication.

Underlying all of this is the task system, which is a form of lightweight threading. Large asynchronous computations are built up using futures, streams and sinks, and then spawned as independent tasks that are run to completion, but do not block the thread running them.

Modules

channel	Cross-task communication.
executor	Task execution.
future	Asynchronous values.
io	Asynchronous I/O.
prelude	A "prelude" for crates using the `futures` crate.
sink	Asynchronous sinks.
stream	Asynchronous streams.
task	Tools for working with tasks.

Macros

pin_mut	Pins a value on the stack.
ready	Extracts the successful type of a `Poll<T>`.
try_poll	Extracts `Poll<T>` from `Poll<Result<T, E>>`.
try_ready	Extracts the successful type of a `Poll<Result<T, E>>`.
unsafe_pinned	A pinned projection of a struct field.
unsafe_unpinned	An unpinned projection of a struct field.