[−][src]Crate futures
Abstractions for asynchronous programming.
This crate provides a number of core abstractions for writing asynchronous code:
- Futures are single eventual values produced by asynchronous computations. Some programming languages (e.g. JavaScript) call this concept "promise".
- 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. |
compat | Interop between |
executor | Task execution. |
future | Asynchronous values. |
io | Asynchronous I/O. |
lock | Futures-powered synchronization primitives. |
never | This module contains the |
prelude | A "prelude" for crates using the |
sink | Asynchronous sinks. |
stream | Asynchronous streams. |
task | Tools for working with tasks. |
Macros
join | Polls multiple futures simultaneously, returning a tuple of all results once complete. |
pending | A macro which yields to the event loop once. |
pin_mut | Pins a value on the stack. |
poll | A macro which returns the result of polling a future once within the
current |
ready | Extracts the successful type of a |
select | Polls multiple futures and streams simultaneously, executing the branch
for the future that finishes first. If multiple futures are ready,
one will be pseudo-randomly selected at runtime. Futures directly
passed to |
try_join | Polls multiple futures simultaneously, resolving to a |