Crate async_await

Source

Modules§

executor
Executors
future
Futures
prelude
A “prelude” for crates using the futures crate.
sink
Asynchronous sinks
stream
Asynchronous streams
sync
Future-aware synchronization
task
Tasks used to drive a future computation
thread
Native threads.
unsync
Future-aware single-threaded synchronization

Macros§

async
await
task_local
A macro to create a static of type LocalKey
try_ready
A macro for extracting the successful type of a Poll<T, E>.

Structs§

AndThen
Future for the and_then combinator, chaining a computation onto the end of another future which completes successfully.
Canceled
Error returned from a Receiver<T> whenever the corresponding Sender<T> is dropped.
Collect
A future which takes a list of futures and resolves with a vector of the completed values.
Complete
Represents the completion half of a oneshot through which the result of a computation is signaled.
Done
A future representing a value that is immediately ready.
Empty
A future which is never resolved.
Failed
A future representing a value that is immediately ready.
Finished
A future representing a value that is immediately ready.
Flatten
Future for the flatten combinator, flattening a future-of-a-future to get just the result of the final future.
FlattenStream
Future for the flatten_stream combinator, flattening a future-of-a-stream to get just the result of the final stream as a stream.
Fuse
A future which “fuses” a future once it’s been resolved.
IntoStream
Future that forwards one element from the underlying future (whether it is success of error) and emits EOF after that.
Join
Future for the join combinator, waiting for two futures to complete.
Join3
Future for the join3 combinator, waiting for three futures to complete.
Join4
Future for the join4 combinator, waiting for four futures to complete.
Join5
Future for the join5 combinator, waiting for five futures to complete.
Lazy
A future which defers creation of the actual future until a callback is scheduled.
Map
Future for the map combinator, changing the type of a future.
MapErr
Future for the map_err combinator, changing the error type of a future.
Oneshot
A future representing the completion of a computation happening elsewhere in memory.
OrElse
Future for the or_else combinator, chaining a computation onto the end of a future which fails with an error.
Select
Future for the select combinator, waiting for one of two futures to complete.
SelectAll
Future for the select_all combinator, waiting for one of any of a list of futures to complete.
SelectNext
Future yielded as the second result in a Select future.
SelectOk
Future for the select_ok combinator, waiting for one of any of a list of futures to successfully complete. Unlike select_all, this future ignores all but the last error, if there are any.
Then
Future for the then combinator, chaining computations on the end of another future regardless of its outcome.

Enums§

Async
Return type of future, indicating whether a value is ready or not.
AsyncSink
The result of an asynchronous attempt to send a value to a sink.

Traits§

Future
Trait for types which are a placeholder of a value that may become available at some later point in time.
IntoFuture
Class of types which can be converted into a future.
Sink
A Sink is a value into which other values can be sent, asynchronously.
Stream
A stream of values, not all of which may have been produced yet.

Functions§

collect
Creates a future which represents a collection of the results of the futures given.
done
Creates a new “leaf future” which will resolve with the given result.
empty
Creates a future which never resolves, representing a computation that never finishes.
failed
Creates a “leaf future” from an immediate value of a failed computation.
finished
Creates a “leaf future” from an immediate value of a finished and successful computation.
lazy
Creates a new future which will eventually be the same as the one created by the closure provided.
oneshot
Creates a new futures-aware, one-shot channel.
select_all
Creates a new future which will select over a list of futures.
select_ok
Creates a new future which will select the first successful future over a list of futures.

Type Aliases§

Poll
Return type of the Future::poll method, indicates whether a future’s value is ready or not.
StartSend
Return type of the Sink::start_send method, indicating the outcome of a send attempt. See AsyncSink for more details.