blob: 8e4c4d2ade6d1b712b8cde937b9a1fe5006ce61e [file] [log] [blame]
<!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="Asynchronous values."><meta name="keywords" content="rust, rustlang, rust-lang, future"><title>futures::prelude::future - 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="../../../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"><!--[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">&#9776;</button><a class="sidebar-logo" href="../../../futures/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/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module future</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</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">Module <a href="../../index.html">futures</a>::<wbr><a href="../index.html">prelude</a>::<wbr><a class="mod" href="#">future</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#294">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Asynchronous values.</p>
<p>This module contains:</p>
<ul>
<li>The <a href="../../future/trait.Future.html" title="Future"><code>Future</code></a> trait.</li>
<li>The <a href="../../future/trait.FutureExt.html" title="FutureExt"><code>FutureExt</code></a> and <a href="../../future/trait.TryFutureExt.html" title="TryFutureExt"><code>TryFutureExt</code></a> trait, which provides adapters for
chaining and composing futures.</li>
<li>Top-level future combinators like <a href="../../future/fn.lazy.html"><code>lazy</code></a> which creates a future
from a closure that defines its return value, and <a href="../../future/fn.ready.html"><code>ready</code></a>,
which constructs a future with an immediate defined value.</li>
</ul>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AbortHandle.html" title="futures::prelude::future::AbortHandle struct">AbortHandle</a></div><div class="item-right docblock-short">A handle to an <code>Abortable</code> task.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AbortRegistration.html" title="futures::prelude::future::AbortRegistration struct">AbortRegistration</a></div><div class="item-right docblock-short">A registration handle for an <code>Abortable</code> task.
Values of this type can be acquired from <code>AbortHandle::new</code> and are used
in calls to <code>Abortable::new</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Abortable.html" title="futures::prelude::future::Abortable struct">Abortable</a></div><div class="item-right docblock-short">A future/stream which can be remotely short-circuited using an <code>AbortHandle</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Aborted.html" title="futures::prelude::future::Aborted struct">Aborted</a></div><div class="item-right docblock-short">Indicator that the <code>Abortable</code> task was aborted.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AndThen.html" title="futures::prelude::future::AndThen struct">AndThen</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.and_then"><code>and_then</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CatchUnwind.html" title="futures::prelude::future::CatchUnwind struct">CatchUnwind</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.FutureExt.html#method.catch_unwind"><code>catch_unwind</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ErrInto.html" title="futures::prelude::future::ErrInto struct">ErrInto</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.err_into"><code>err_into</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Flatten.html" title="futures::prelude::future::Flatten struct">Flatten</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.FutureExt.html#method.flatten"><code>flatten</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FlattenSink.html" title="futures::prelude::future::FlattenSink struct">FlattenSink</a></div><div class="item-right docblock-short">Sink for the <a href="../../future/trait.TryFutureExt.html#method.flatten_sink"><code>flatten_sink</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FlattenStream.html" title="futures::prelude::future::FlattenStream struct">FlattenStream</a></div><div class="item-right docblock-short">Stream for the <a href="../../future/trait.FutureExt.html#method.flatten_stream"><code>flatten_stream</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Fuse.html" title="futures::prelude::future::Fuse struct">Fuse</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.FutureExt.html#method.fuse"><code>fuse</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FutureObj.html" title="futures::prelude::future::FutureObj struct">FutureObj</a></div><div class="item-right docblock-short">A custom trait object for polling futures, roughly akin to
<code>Box&lt;dyn Future&lt;Output = T&gt; + Send + 'a&gt;</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Inspect.html" title="futures::prelude::future::Inspect struct">Inspect</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.FutureExt.html#method.inspect"><code>inspect</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InspectErr.html" title="futures::prelude::future::InspectErr struct">InspectErr</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.inspect_err"><code>inspect_err</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InspectOk.html" title="futures::prelude::future::InspectOk struct">InspectOk</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.inspect_ok"><code>inspect_ok</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntoFuture.html" title="futures::prelude::future::IntoFuture struct">IntoFuture</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.into_future"><code>into_future</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntoStream.html" title="futures::prelude::future::IntoStream struct">IntoStream</a></div><div class="item-right docblock-short">Stream for the <a href="../../future/trait.FutureExt.html#method.into_stream"><code>into_stream</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Join.html" title="futures::prelude::future::Join struct">Join</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.join.html"><code>join</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Join3.html" title="futures::prelude::future::Join3 struct">Join3</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.join3.html" title="join3"><code>join3</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Join4.html" title="futures::prelude::future::Join4 struct">Join4</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.join4.html" title="join4"><code>join4</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Join5.html" title="futures::prelude::future::Join5 struct">Join5</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.join5.html" title="join5"><code>join5</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.JoinAll.html" title="futures::prelude::future::JoinAll struct">JoinAll</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.join_all.html" title="join_all"><code>join_all</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Lazy.html" title="futures::prelude::future::Lazy struct">Lazy</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.lazy.html" title="lazy"><code>lazy</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LocalFutureObj.html" title="futures::prelude::future::LocalFutureObj struct">LocalFutureObj</a></div><div class="item-right docblock-short">A custom trait object for polling futures, roughly akin to
<code>Box&lt;dyn Future&lt;Output = T&gt; + 'a&gt;</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Map.html" title="futures::prelude::future::Map struct">Map</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.FutureExt.html#method.map"><code>map</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MapErr.html" title="futures::prelude::future::MapErr struct">MapErr</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.map_err"><code>map_err</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MapInto.html" title="futures::prelude::future::MapInto struct">MapInto</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.FutureExt.html#method.map_into"><code>map_into</code></a> combinator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MapOk.html" title="futures::prelude::future::MapOk struct">MapOk</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.map_ok"><code>map_ok</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MapOkOrElse.html" title="futures::prelude::future::MapOkOrElse struct">MapOkOrElse</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.map_ok_or_else"><code>map_ok_or_else</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.NeverError.html" title="futures::prelude::future::NeverError struct">NeverError</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.FutureExt.html#method.never_error"><code>never_error</code></a> combinator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OkInto.html" title="futures::prelude::future::OkInto struct">OkInto</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.ok_into"><code>ok_into</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OptionFuture.html" title="futures::prelude::future::OptionFuture struct">OptionFuture</a></div><div class="item-right docblock-short">A future representing a value which may or may not be present.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OrElse.html" title="futures::prelude::future::OrElse struct">OrElse</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.or_else"><code>or_else</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Pending.html" title="futures::prelude::future::Pending struct">Pending</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.pending.html" title="pending()"><code>pending()</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PollFn.html" title="futures::prelude::future::PollFn struct">PollFn</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.poll_fn.html" title="poll_fn"><code>poll_fn</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PollImmediate.html" title="futures::prelude::future::PollImmediate struct">PollImmediate</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.poll_immediate.html"><code>poll_immediate</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Ready.html" title="futures::prelude::future::Ready struct">Ready</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.ready.html"><code>ready</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Remote.html" title="futures::prelude::future::Remote struct">Remote</a></div><div class="item-right docblock-short">A future which sends its output to the corresponding <code>RemoteHandle</code>.
Created by <a href="../../future/trait.FutureExt.html#method.remote_handle"><code>remote_handle</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RemoteHandle.html" title="futures::prelude::future::RemoteHandle struct">RemoteHandle</a></div><div class="item-right docblock-short">The handle to a remote future returned by
<a href="../../future/trait.FutureExt.html#method.remote_handle"><code>remote_handle</code></a>. When you drop this,
the remote future will be woken up to be dropped by the executor.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Select.html" title="futures::prelude::future::Select struct">Select</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.select.html" title="select()"><code>select()</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SelectAll.html" title="futures::prelude::future::SelectAll struct">SelectAll</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.select_all.html" title="select_all"><code>select_all</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SelectOk.html" title="futures::prelude::future::SelectOk struct">SelectOk</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.select_ok.html" title="select_ok"><code>select_ok</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Shared.html" title="futures::prelude::future::Shared struct">Shared</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.FutureExt.html#method.shared"><code>shared</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Then.html" title="futures::prelude::future::Then struct">Then</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.FutureExt.html#method.then"><code>then</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TryFlatten.html" title="futures::prelude::future::TryFlatten struct">TryFlatten</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.try_flatten"><code>try_flatten</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TryFlattenStream.html" title="futures::prelude::future::TryFlattenStream struct">TryFlattenStream</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.try_flatten_stream"><code>try_flatten_stream</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TryJoin.html" title="futures::prelude::future::TryJoin struct">TryJoin</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.try_join.html"><code>try_join</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TryJoin3.html" title="futures::prelude::future::TryJoin3 struct">TryJoin3</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.try_join3.html" title="try_join3"><code>try_join3</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TryJoin4.html" title="futures::prelude::future::TryJoin4 struct">TryJoin4</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.try_join4.html" title="try_join4"><code>try_join4</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TryJoin5.html" title="futures::prelude::future::TryJoin5 struct">TryJoin5</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.try_join5.html" title="try_join5"><code>try_join5</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TryJoinAll.html" title="futures::prelude::future::TryJoinAll struct">TryJoinAll</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.try_join_all.html" title="try_join_all"><code>try_join_all</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TrySelect.html" title="futures::prelude::future::TrySelect struct">TrySelect</a></div><div class="item-right docblock-short">Future for the <a href="../../future/fn.try_select.html" title="try_select()"><code>try_select()</code></a> function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnitError.html" title="futures::prelude::future::UnitError struct">UnitError</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.FutureExt.html#method.unit_error"><code>unit_error</code></a> combinator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnwrapOrElse.html" title="futures::prelude::future::UnwrapOrElse struct">UnwrapOrElse</a></div><div class="item-right docblock-short">Future for the <a href="../../future/trait.TryFutureExt.html#method.unwrap_or_else"><code>unwrap_or_else</code></a> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WeakShared.html" title="futures::prelude::future::WeakShared struct">WeakShared</a></div><div class="item-right docblock-short">A weak reference to a <a href="../../future/struct.Shared.html" title="Shared"><code>Shared</code></a> that can be upgraded much like an <code>Arc</code>.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Either.html" title="futures::prelude::future::Either enum">Either</a></div><div class="item-right docblock-short">Combines two different futures, streams, or sinks having the same associated types into a single type.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.MaybeDone.html" title="futures::prelude::future::MaybeDone enum">MaybeDone</a></div><div class="item-right docblock-short">A future that may have completed.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TryMaybeDone.html" title="futures::prelude::future::TryMaybeDone enum">TryMaybeDone</a></div><div class="item-right docblock-short">A future that may have completed with an error.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FusedFuture.html" title="futures::prelude::future::FusedFuture trait">FusedFuture</a></div><div class="item-right docblock-short">A future which tracks whether or not the underlying future
should no longer be polled.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Future.html" title="futures::prelude::future::Future trait">Future</a></div><div class="item-right docblock-short">A future represents an asynchronous computation obtained by use of <a href="../../std/keyword.async.html"><code>async</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FutureExt.html" title="futures::prelude::future::FutureExt trait">FutureExt</a></div><div class="item-right docblock-short">An extension trait for <code>Future</code>s that provides a variety of convenient
adapters.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TryFuture.html" title="futures::prelude::future::TryFuture trait">TryFuture</a></div><div class="item-right docblock-short">A convenience for futures that return <code>Result</code> values that includes
a variety of adapters tailored to such futures.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TryFutureExt.html" title="futures::prelude::future::TryFutureExt trait">TryFutureExt</a></div><div class="item-right docblock-short">Adapters specific to <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="Result"><code>Result</code></a>-returning futures</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.UnsafeFutureObj.html" title="futures::prelude::future::UnsafeFutureObj trait">UnsafeFutureObj</a></div><div class="item-right docblock-short">A custom implementation of a future trait object for <code>FutureObj</code>, providing
a vtable with drop support.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.abortable.html" title="futures::prelude::future::abortable fn">abortable</a></div><div class="item-right docblock-short">Creates a new <code>Abortable</code> future and an <code>AbortHandle</code> which can be used to stop it.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.err.html" title="futures::prelude::future::err fn">err</a></div><div class="item-right docblock-short">Create a future that is immediately ready with an error value.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.join.html" title="futures::prelude::future::join fn">join</a></div><div class="item-right docblock-short">Joins the result of two futures, waiting for them both to complete.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.join3.html" title="futures::prelude::future::join3 fn">join3</a></div><div class="item-right docblock-short">Same as <a href="../../future/fn.join.html"><code>join</code></a>, but with more futures.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.join4.html" title="futures::prelude::future::join4 fn">join4</a></div><div class="item-right docblock-short">Same as <a href="../../future/fn.join.html"><code>join</code></a>, but with more futures.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.join5.html" title="futures::prelude::future::join5 fn">join5</a></div><div class="item-right docblock-short">Same as <a href="../../future/fn.join.html"><code>join</code></a>, but with more futures.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.join_all.html" title="futures::prelude::future::join_all fn">join_all</a></div><div class="item-right docblock-short">Creates a future which represents a collection of the outputs of the futures
given.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.lazy.html" title="futures::prelude::future::lazy fn">lazy</a></div><div class="item-right docblock-short">Creates a new future that allows delayed execution of a closure.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.maybe_done.html" title="futures::prelude::future::maybe_done fn">maybe_done</a></div><div class="item-right docblock-short">Wraps a future into a <code>MaybeDone</code></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.ok.html" title="futures::prelude::future::ok fn">ok</a></div><div class="item-right docblock-short">Create a future that is immediately ready with a success value.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.pending.html" title="futures::prelude::future::pending fn">pending</a></div><div class="item-right docblock-short">Creates a future which never resolves, representing a computation that never
finishes.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.poll_fn.html" title="futures::prelude::future::poll_fn fn">poll_fn</a></div><div class="item-right docblock-short">Creates a new future wrapping around a function returning <a href="../../task/enum.Poll.html" title="Poll"><code>Poll</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.poll_immediate.html" title="futures::prelude::future::poll_immediate fn">poll_immediate</a></div><div class="item-right docblock-short">Creates a future that is immediately ready with an Option of a value.
Specifically this means that <a href="../../future/trait.Future.html#tymethod.poll">poll</a> always returns <a href="../../task/enum.Poll.html#variant.Ready">Poll::Ready</a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.ready.html" title="futures::prelude::future::ready fn">ready</a></div><div class="item-right docblock-short">Creates a future that is immediately ready with a value.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.select.html" title="futures::prelude::future::select fn">select</a></div><div class="item-right docblock-short">Waits for either one of two differently-typed futures to complete.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.select_all.html" title="futures::prelude::future::select_all fn">select_all</a></div><div class="item-right docblock-short">Creates a new future which will select over a list of futures.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.select_ok.html" title="futures::prelude::future::select_ok fn">select_ok</a></div><div class="item-right docblock-short">Creates a new future which will select the first successful future over a list of futures.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.try_join.html" title="futures::prelude::future::try_join fn">try_join</a></div><div class="item-right docblock-short">Joins the result of two futures, waiting for them both to complete or
for one to produce an error.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.try_join3.html" title="futures::prelude::future::try_join3 fn">try_join3</a></div><div class="item-right docblock-short">Same as <a href="../../future/fn.try_join.html"><code>try_join</code></a>, but with more futures.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.try_join4.html" title="futures::prelude::future::try_join4 fn">try_join4</a></div><div class="item-right docblock-short">Same as <a href="../../future/fn.try_join.html"><code>try_join</code></a>, but with more futures.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.try_join5.html" title="futures::prelude::future::try_join5 fn">try_join5</a></div><div class="item-right docblock-short">Same as <a href="../../future/fn.try_join.html"><code>try_join</code></a>, but with more futures.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.try_join_all.html" title="futures::prelude::future::try_join_all fn">try_join_all</a></div><div class="item-right docblock-short">Creates a future which represents either a collection of the results of the
futures given or an error.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.try_maybe_done.html" title="futures::prelude::future::try_maybe_done fn">try_maybe_done</a></div><div class="item-right docblock-short">Wraps a future into a <code>TryMaybeDone</code></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.try_select.html" title="futures::prelude::future::try_select fn">try_select</a></div><div class="item-right docblock-short">Waits for either one of two differently-typed futures to complete.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.BoxFuture.html" title="futures::prelude::future::BoxFuture type">BoxFuture</a></div><div class="item-right docblock-short">An owned dynamically typed <a href="../../future/trait.Future.html" title="Future"><code>Future</code></a> for use in cases where you can’t
statically type your result or need to add some indirection.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.LocalBoxFuture.html" title="futures::prelude::future::LocalBoxFuture type">LocalBoxFuture</a></div><div class="item-right docblock-short"><code>BoxFuture</code>, but without the <code>Send</code> requirement.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="futures" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>