[][src]Module futures::future

Asynchronous values.

This module contains:

Structs

AbortHandle

A handle to a Abortable future.

AbortRegistration

A registration handle for a Abortable future. Values of this type can be acquired from AbortHandle::new and are used in calls to Abortable::new.

Abortable

A future which can be remotely short-circuited using an AbortHandle.

Aborted

Indicator that the Abortable future was aborted.

AndThen

Future for the and_then combinator.

CatchUnwind

Future for the catch_unwind combinator.

Empty

A future which is never resolved.

ErrInto

Future for the err_into combinator.

Flatten

Future for the flatten combinator.

FlattenSink

Future for the flatten_sink combinator.

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 has been resolved. This wrapper can be used to turn any Future into a FusedFuture.

FutureObj

A custom trait object for polling futures, roughly akin to Box<dyn Future<Output = T> + Send + 'a>.

Inspect

Do something with the item of a future, passing it on.

IntoFuture

Future for the into_future combinator.

IntoStream

A type which converts a Future into a Stream containing a single element.

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.

JoinAll

A future which takes a list of futures and resolves with a vector of the completed values.

Lazy

A future which, when polled, invokes a closure and yields its result.

LocalFutureObj

A custom trait object for polling futures, roughly akin to Box<dyn Future<Output = T> + 'a>.

Map

Future for the map combinator, changing the type of a future.

MapErr

Future for the map_err combinator.

MapOk

Future for the map_ok combinator.

OptionFuture

A future representing a value which may or may not be present.

OrElse

Future for the or_else combinator.

PollFn

A future which wraps a function returning [Poll].

Ready

A future that is immediately ready with a value

Remote

A future which sends its output to the corresponding RemoteHandle. Created by remote_handle.

RemoteHandle

The handle to a remote future returned by remote_handle.

Shared

A future that is cloneable and can be polled in multiple threads. Use the shared combinator method to convert any future into a Shared future.

Then

Future for the then combinator, chaining computations on the end of another future regardless of its outcome.

TryJoin

Future for the try_join combinator, waiting for two futures to complete or for one to error.

TryJoin3

Future for the try_join3 combinator, waiting for three futures to complete or for one to error.

TryJoin4

Future for the try_join4 combinator, waiting for four futures to complete or for one to error.

TryJoin5

Future for the try_join5 combinator, waiting for five futures to complete or for one to error.

TryJoinAll

A future which takes a list of futures and resolves with a vector of the completed values or an error.

UnwrapOrElse

Future for the unwrap_or_else combinator.

Enums

MaybeDone

A future that may have completed.

Traits

FusedFuture

A Future or TryFuture which tracks whether or not the underlying future should no longer be polled.

FutureExperimental

A future represents an asynchronous computation.

FutureExt

An extension trait for Futures that provides a variety of convenient adapters.

TryFuture

A convenience for futures that return Result values that includes a variety of adapters tailored to such futures.

TryFutureExt

Adapters specific to Result-returning futures

UnsafeFutureObj

A custom implementation of a future trait object for FutureObj, providing a hand-rolled vtable.

Functions

abortable

Creates a new Abortable future and a AbortHandle which can be used to stop it.

empty

Creates a future which never resolves, representing a computation that never finishes.

err

Create a future that is immediately ready with an error value.

join_all

Creates a future which represents a collection of the outputs of the futures given.

lazy

Creates a new future that allows delayed execution of a closure.

maybe_done

Wraps a future into a MaybeDone

ok

Create a future that is immediately ready with a success value.

poll_fn

Creates a new future wrapping around a function returning [Poll].

ready

Create a future that is immediately ready with a value.

try_join_all

Creates a future which represents either a collection of the results of the futures given or an error.