Module futures_util::future

source ·
Expand description

Asynchronous values.

This module contains:

  • The Future trait.
  • The FutureExt and TryFutureExt trait, which provides adapters for chaining and composing futures.
  • Top-level future combinators like lazy which creates a future from a closure that defines its return value, and ready, which constructs a future with an immediate defined value.

Re-exports

Structs

Enums

  • Combines two different futures, streams, or sinks having the same associated types into a single type.
  • A future that may have completed.
  • A future that may have completed with an error.

Traits

  • A future which tracks whether or not the underlying future should no longer be polled.
  • An extension trait for Futures that provides a variety of convenient adapters.
  • A convenience for futures that return Result values that includes a variety of adapters tailored to such futures.
  • Adapters specific to Result-returning futures
  • A custom implementation of a future trait object for FutureObj, providing a vtable with drop support.

Functions

  • Creates a new Abortable future and an AbortHandle which can be used to stop it.
  • Create a future that is immediately ready with an error value.
  • Joins the result of two futures, waiting for them both to complete.
  • Same as join, but with more futures.
  • Same as join, but with more futures.
  • Same as join, but with more futures.
  • Creates a future which represents a collection of the outputs of the futures given.
  • Creates a new future that allows delayed execution of a closure.
  • Wraps a future into a MaybeDone
  • Create a future that is immediately ready with a success value.
  • Creates a future which never resolves, representing a computation that never finishes.
  • Creates a new future wrapping around a function returning Poll.
  • Creates a future that is immediately ready with an Option of a value. Specifically this means that poll always returns Poll::Ready.
  • Creates a future that is immediately ready with a value.
  • Waits for either one of two differently-typed futures to complete.
  • Creates a new future which will select over a list of futures.
  • Creates a new future which will select the first successful future over a list of futures.
  • Joins the result of two futures, waiting for them both to complete or for one to produce an error.
  • Same as try_join, but with more futures.
  • Same as try_join, but with more futures.
  • Same as try_join, but with more futures.
  • Creates a future which represents either a collection of the results of the futures given or an error.
  • Wraps a future into a TryMaybeDone
  • Waits for either one of two differently-typed futures to complete.

Type Definitions

  • An owned dynamically typed Future for use in cases where you can’t statically type your result or need to add some indirection.
  • BoxFuture, but without the Send requirement.