Crate futures_util

Combinators and utilities for working with Futures, Streams, Sinks, and the AsyncRead and AsyncWrite traits.

Re-exports

pub use crate::future::Future;

pub use crate::future::FutureExt;

pub use crate::future::TryFuture;

pub use crate::future::TryFutureExt;

pub use crate::stream::Stream;

pub use crate::stream::StreamExt;

pub use crate::stream::TryStream;

pub use crate::stream::TryStreamExt;

pub use crate::sink::Sink;

pub use crate::sink::SinkExt;

Modules

future

Asynchronous values.

never

This module contains the Never type.

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 async context.

ready

Extracts the successful type of a Poll<T>.

select_biased

Polls multiple futures and streams simultaneously, executing the branch for the future that finishes first. Unlike select!, if multiple futures are ready, one will be selected in order of declaration. Futures directly passed to select_biased! must be Unpin and implement FusedFuture.

try_join

Polls multiple futures simultaneously, resolving to a Result containing either a tuple of the successful outputs or an error.