| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Combinators and utilities for working with `Future`s, `Stream`s, `Sink`s, and the `AsyncRead` and `AsyncWrite` traits."><meta name="keywords" content="rust, rustlang, rust-lang, futures_util"><title>futures_util - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate futures_util</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.3.28</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">futures_util</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/futures_util/lib.rs.html#1-337">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Combinators and utilities for working with <code>Future</code>s, <code>Stream</code>s, <code>Sink</code>s, |
| and the <code>AsyncRead</code> and <code>AsyncWrite</code> traits.</p> |
| </div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.Future"><code>pub use crate::future::Future;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.FutureExt"><code>pub use crate::future::<a class="trait" href="future/trait.FutureExt.html" title="trait futures_util::future::FutureExt">FutureExt</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.TryFuture"><code>pub use crate::future::<a class="trait" href="future/trait.TryFuture.html" title="trait futures_util::future::TryFuture">TryFuture</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.TryFutureExt"><code>pub use crate::future::<a class="trait" href="future/trait.TryFutureExt.html" title="trait futures_util::future::TryFutureExt">TryFutureExt</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Stream"><code>pub use crate::stream::<a class="trait" href="stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.StreamExt"><code>pub use crate::stream::<a class="trait" href="stream/trait.StreamExt.html" title="trait futures_util::stream::StreamExt">StreamExt</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.TryStream"><code>pub use crate::stream::<a class="trait" href="stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.TryStreamExt"><code>pub use crate::stream::<a class="trait" href="stream/trait.TryStreamExt.html" title="trait futures_util::stream::TryStreamExt">TryStreamExt</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Sink"><code>pub use crate::sink::<a class="trait" href="sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.SinkExt"><code>pub use crate::sink::<a class="trait" href="sink/trait.SinkExt.html" title="trait futures_util::sink::SinkExt">SinkExt</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.AsyncBufRead"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.AsyncBufReadExt"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncBufReadExt.html" title="trait futures_util::io::AsyncBufReadExt">AsyncBufReadExt</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.AsyncRead"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.AsyncReadExt"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncReadExt.html" title="trait futures_util::io::AsyncReadExt">AsyncReadExt</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.AsyncSeek"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.AsyncSeekExt"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncSeekExt.html" title="trait futures_util::io::AsyncSeekExt">AsyncSeekExt</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.AsyncWrite"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.AsyncWriteExt"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncWriteExt.html" title="trait futures_util::io::AsyncWriteExt">AsyncWriteExt</a>;</code></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="future/index.html" title="futures_util::future mod">future</a></div><div class="item-right docblock-short">Asynchronous values.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="io/index.html" title="futures_util::io mod">io</a></div><div class="item-right docblock-short">Asynchronous I/O.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="lock/index.html" title="futures_util::lock mod">lock</a></div><div class="item-right docblock-short">Futures-powered synchronization primitives.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="never/index.html" title="futures_util::never mod">never</a></div><div class="item-right docblock-short">This module contains the <code>Never</code> type.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="sink/index.html" title="futures_util::sink mod">sink</a></div><div class="item-right docblock-short">Asynchronous sinks.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="stream/index.html" title="futures_util::stream mod">stream</a></div><div class="item-right docblock-short">Asynchronous streams.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="task/index.html" title="futures_util::task mod">task</a></div><div class="item-right docblock-short">Tools for working with tasks.</div></div></div><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.join.html" title="futures_util::join macro">join</a></div><div class="item-right docblock-short">Polls multiple futures simultaneously, returning a tuple |
| of all results once complete.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.pending.html" title="futures_util::pending macro">pending</a></div><div class="item-right docblock-short">A macro which yields to the event loop once.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.pin_mut.html" title="futures_util::pin_mut macro">pin_mut</a></div><div class="item-right docblock-short">Pins a value on the stack.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.poll.html" title="futures_util::poll macro">poll</a></div><div class="item-right docblock-short">A macro which returns the result of polling a future once within the |
| current <code>async</code> context.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.ready.html" title="futures_util::ready macro">ready</a></div><div class="item-right docblock-short">Extracts the successful type of a <code>Poll<T></code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.select.html" title="futures_util::select macro">select</a></div><div class="item-right docblock-short">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 <code>select!</code> must be <code>Unpin</code> and implement <code>FusedFuture</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.select_biased.html" title="futures_util::select_biased macro">select_biased</a></div><div class="item-right docblock-short">Polls multiple futures and streams simultaneously, executing the branch |
| for the future that finishes first. Unlike <a href="macro.select.html"><code>select!</code></a>, if multiple futures are ready, |
| one will be selected in order of declaration. Futures directly |
| passed to <code>select_biased!</code> must be <code>Unpin</code> and implement <code>FusedFuture</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.stream_select.html" title="futures_util::stream_select macro">stream_select</a></div><div class="item-right docblock-short">Combines several streams, all producing the same <code>Item</code> type, into one stream. |
| This is similar to <code>select_all</code> but does not require the streams to all be the same type. |
| It also keeps the streams inline, and does not require <code>Box<dyn Stream></code>s to be allocated. |
| Streams passed to this macro must be <code>Unpin</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.try_join.html" title="futures_util::try_join macro">try_join</a></div><div class="item-right docblock-short">Polls multiple futures simultaneously, resolving to a [<code>Result</code>] containing |
| either a tuple of the successful outputs or an error.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
