Files
GopherGate/target/doc/futures_util/future/index.html
2026-02-26 12:00:21 -05:00

28 lines
27 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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."><title>futures_util::future - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="futures_util" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Module future</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures_util/index.html">futures_<wbr>util</a><span class="version">0.3.32</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module future</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate futures_<wbr>util</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">futures_util</a></div><h1>Module <span>future</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/futures_util/future/mod.rs.html#1-134">Source</a> </span></div><details class="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="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html" title="trait core::future::future::Future"><code>Future</code></a> trait.</li>
<li>The <a href="trait.FutureExt.html" title="trait futures_util::future::FutureExt"><code>FutureExt</code></a> and <a href="trait.TryFutureExt.html" title="trait futures_util::future::TryFutureExt"><code>TryFutureExt</code></a> trait, which provides adapters for
chaining and composing futures.</li>
<li>Top-level future combinators like <a href="fn.lazy.html" title="fn futures_util::future::lazy"><code>lazy</code></a> which creates a future
from a closure that defines its return value, and <a href="fn.ready.html" title="fn futures_util::future::ready"><code>ready</code></a>,
which constructs a future with an immediate defined value.</li>
</ul>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.Future"><code>pub use core::future::<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>;</code></dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.AbortHandle.html" title="struct futures_util::future::AbortHandle">Abort<wbr>Handle</a></dt><dd>A handle to an <code>Abortable</code> task.</dd><dt><a class="struct" href="struct.AbortRegistration.html" title="struct futures_util::future::AbortRegistration">Abort<wbr>Registration</a></dt><dd>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>.</dd><dt><a class="struct" href="struct.Abortable.html" title="struct futures_util::future::Abortable">Abortable</a></dt><dd>A future/stream which can be remotely short-circuited using an <code>AbortHandle</code>.</dd><dt><a class="struct" href="struct.Aborted.html" title="struct futures_util::future::Aborted">Aborted</a></dt><dd>Indicator that the <code>Abortable</code> task was aborted.</dd><dt><a class="struct" href="struct.AlwaysReady.html" title="struct futures_util::future::AlwaysReady">Always<wbr>Ready</a></dt><dd>Future for the <a href="fn.always_ready.html" title="fn futures_util::future::always_ready"><code>always_ready</code></a> function.</dd><dt><a class="struct" href="struct.AndThen.html" title="struct futures_util::future::AndThen">AndThen</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.and_then" title="method futures_util::future::TryFutureExt::and_then"><code>and_then</code></a> method.</dd><dt><a class="struct" href="struct.CatchUnwind.html" title="struct futures_util::future::CatchUnwind">Catch<wbr>Unwind</a></dt><dd>Future for the <a href="trait.FutureExt.html#method.catch_unwind" title="method futures_util::future::FutureExt::catch_unwind"><code>catch_unwind</code></a> method.</dd><dt><a class="struct" href="struct.ErrInto.html" title="struct futures_util::future::ErrInto">ErrInto</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.err_into" title="method futures_util::future::TryFutureExt::err_into"><code>err_into</code></a> method.</dd><dt><a class="struct" href="struct.Flatten.html" title="struct futures_util::future::Flatten">Flatten</a></dt><dd>Future for the <a href="trait.FutureExt.html#method.flatten" title="method futures_util::future::FutureExt::flatten"><code>flatten</code></a> method.</dd><dt><a class="struct" href="struct.FlattenSink.html" title="struct futures_util::future::FlattenSink">Flatten<wbr>Sink</a></dt><dd>Sink for the <a href="trait.TryFutureExt.html#method.flatten_sink" title="method futures_util::future::TryFutureExt::flatten_sink"><code>flatten_sink</code></a> method.</dd><dt><a class="struct" href="struct.FlattenStream.html" title="struct futures_util::future::FlattenStream">Flatten<wbr>Stream</a></dt><dd>Stream for the <a href="trait.FutureExt.html#method.flatten_stream" title="method futures_util::future::FutureExt::flatten_stream"><code>flatten_stream</code></a> method.</dd><dt><a class="struct" href="struct.Fuse.html" title="struct futures_util::future::Fuse">Fuse</a></dt><dd>Future for the <a href="trait.FutureExt.html#method.fuse" title="method futures_util::future::FutureExt::fuse"><code>fuse</code></a> method.</dd><dt><a class="struct" href="struct.FutureObj.html" title="struct futures_util::future::FutureObj">Future<wbr>Obj</a></dt><dd>A custom trait object for polling futures, roughly akin to
<code>Box&lt;dyn Future&lt;Output = T&gt; + Send + 'a&gt;</code>.</dd><dt><a class="struct" href="struct.Inspect.html" title="struct futures_util::future::Inspect">Inspect</a></dt><dd>Future for the <a href="trait.FutureExt.html#method.inspect" title="method futures_util::future::FutureExt::inspect"><code>inspect</code></a> method.</dd><dt><a class="struct" href="struct.InspectErr.html" title="struct futures_util::future::InspectErr">Inspect<wbr>Err</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.inspect_err" title="method futures_util::future::TryFutureExt::inspect_err"><code>inspect_err</code></a> method.</dd><dt><a class="struct" href="struct.InspectOk.html" title="struct futures_util::future::InspectOk">Inspect<wbr>Ok</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.inspect_ok" title="method futures_util::future::TryFutureExt::inspect_ok"><code>inspect_ok</code></a> method.</dd><dt><a class="struct" href="struct.IntoFuture.html" title="struct futures_util::future::IntoFuture">Into<wbr>Future</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.into_future" title="method futures_util::future::TryFutureExt::into_future"><code>into_future</code></a> method.</dd><dt><a class="struct" href="struct.IntoStream.html" title="struct futures_util::future::IntoStream">Into<wbr>Stream</a></dt><dd>Stream for the <a href="trait.FutureExt.html#method.into_stream" title="method futures_util::future::FutureExt::into_stream"><code>into_stream</code></a> method.</dd><dt><a class="struct" href="struct.Join.html" title="struct futures_util::future::Join">Join</a></dt><dd>Future for the <a href="fn.join.html" title="fn futures_util::future::join"><code>join</code></a> function.</dd><dt><a class="struct" href="struct.Join3.html" title="struct futures_util::future::Join3">Join3</a></dt><dd>Future for the <a href="fn.join3.html" title="fn futures_util::future::join3"><code>join3</code></a> function.</dd><dt><a class="struct" href="struct.Join4.html" title="struct futures_util::future::Join4">Join4</a></dt><dd>Future for the <a href="fn.join4.html" title="fn futures_util::future::join4"><code>join4</code></a> function.</dd><dt><a class="struct" href="struct.Join5.html" title="struct futures_util::future::Join5">Join5</a></dt><dd>Future for the <a href="fn.join5.html" title="fn futures_util::future::join5"><code>join5</code></a> function.</dd><dt><a class="struct" href="struct.JoinAll.html" title="struct futures_util::future::JoinAll">JoinAll</a></dt><dd>Future for the <a href="fn.join_all.html" title="fn futures_util::future::join_all"><code>join_all</code></a> function.</dd><dt><a class="struct" href="struct.Lazy.html" title="struct futures_util::future::Lazy">Lazy</a></dt><dd>Future for the <a href="fn.lazy.html" title="fn futures_util::future::lazy"><code>lazy</code></a> function.</dd><dt><a class="struct" href="struct.LocalFutureObj.html" title="struct futures_util::future::LocalFutureObj">Local<wbr>Future<wbr>Obj</a></dt><dd>A custom trait object for polling futures, roughly akin to
<code>Box&lt;dyn Future&lt;Output = T&gt; + 'a&gt;</code>.</dd><dt><a class="struct" href="struct.Map.html" title="struct futures_util::future::Map">Map</a></dt><dd>Future for the <a href="trait.FutureExt.html#method.map" title="method futures_util::future::FutureExt::map"><code>map</code></a> method.</dd><dt><a class="struct" href="struct.MapErr.html" title="struct futures_util::future::MapErr">MapErr</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.map_err" title="method futures_util::future::TryFutureExt::map_err"><code>map_err</code></a> method.</dd><dt><a class="struct" href="struct.MapInto.html" title="struct futures_util::future::MapInto">MapInto</a></dt><dd>Future for the <a href="trait.FutureExt.html#method.map_into" title="method futures_util::future::FutureExt::map_into"><code>map_into</code></a> combinator.</dd><dt><a class="struct" href="struct.MapOk.html" title="struct futures_util::future::MapOk">MapOk</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.map_ok" title="method futures_util::future::TryFutureExt::map_ok"><code>map_ok</code></a> method.</dd><dt><a class="struct" href="struct.MapOkOrElse.html" title="struct futures_util::future::MapOkOrElse">MapOk<wbr>OrElse</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.map_ok_or_else" title="method futures_util::future::TryFutureExt::map_ok_or_else"><code>map_ok_or_else</code></a> method.</dd><dt><a class="struct" href="struct.NeverError.html" title="struct futures_util::future::NeverError">Never<wbr>Error</a></dt><dd>Future for the <a href="trait.FutureExt.html#method.never_error" title="method futures_util::future::FutureExt::never_error"><code>never_error</code></a> combinator.</dd><dt><a class="struct" href="struct.OkInto.html" title="struct futures_util::future::OkInto">OkInto</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.ok_into" title="method futures_util::future::TryFutureExt::ok_into"><code>ok_into</code></a> method.</dd><dt><a class="struct" href="struct.OptionFuture.html" title="struct futures_util::future::OptionFuture">Option<wbr>Future</a></dt><dd>A future representing a value which may or may not be present.</dd><dt><a class="struct" href="struct.OrElse.html" title="struct futures_util::future::OrElse">OrElse</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.or_else" title="method futures_util::future::TryFutureExt::or_else"><code>or_else</code></a> method.</dd><dt><a class="struct" href="struct.Pending.html" title="struct futures_util::future::Pending">Pending</a></dt><dd>Future for the <a href="fn.pending.html" title="fn futures_util::future::pending"><code>pending()</code></a> function.</dd><dt><a class="struct" href="struct.PollFn.html" title="struct futures_util::future::PollFn">PollFn</a></dt><dd>Future for the <a href="fn.poll_fn.html" title="fn futures_util::future::poll_fn"><code>poll_fn</code></a> function.</dd><dt><a class="struct" href="struct.PollImmediate.html" title="struct futures_util::future::PollImmediate">Poll<wbr>Immediate</a></dt><dd>Future for the <a href="fn.poll_immediate.html" title="fn futures_util::future::poll_immediate"><code>poll_immediate</code></a> function.</dd><dt><a class="struct" href="struct.Ready.html" title="struct futures_util::future::Ready">Ready</a></dt><dd>Future for the <a href="fn.ready.html" title="fn futures_util::future::ready"><code>ready</code></a> function.</dd><dt><a class="struct" href="struct.Remote.html" title="struct futures_util::future::Remote">Remote</a></dt><dd>A future which sends its output to the corresponding <code>RemoteHandle</code>.
Created by <a href="trait.FutureExt.html#method.remote_handle" title="method futures_util::future::FutureExt::remote_handle"><code>remote_handle</code></a>.</dd><dt><a class="struct" href="struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">Remote<wbr>Handle</a></dt><dd>The handle to a remote future returned by
<a href="trait.FutureExt.html#method.remote_handle" title="method futures_util::future::FutureExt::remote_handle"><code>remote_handle</code></a>. When you drop this,
the remote future will be woken up to be dropped by the executor.</dd><dt><a class="struct" href="struct.Select.html" title="struct futures_util::future::Select">Select</a></dt><dd>Future for the <a href="fn.select.html" title="fn futures_util::future::select"><code>select()</code></a> function.</dd><dt><a class="struct" href="struct.SelectAll.html" title="struct futures_util::future::SelectAll">Select<wbr>All</a></dt><dd>Future for the <a href="fn.select_all.html" title="fn futures_util::future::select_all"><code>select_all</code></a> function.</dd><dt><a class="struct" href="struct.SelectOk.html" title="struct futures_util::future::SelectOk">Select<wbr>Ok</a></dt><dd>Future for the <a href="fn.select_ok.html" title="fn futures_util::future::select_ok"><code>select_ok</code></a> function.</dd><dt><a class="struct" href="struct.Shared.html" title="struct futures_util::future::Shared">Shared</a></dt><dd>Future for the <a href="trait.FutureExt.html#method.shared" title="method futures_util::future::FutureExt::shared"><code>shared</code></a> method.</dd><dt><a class="struct" href="struct.Then.html" title="struct futures_util::future::Then">Then</a></dt><dd>Future for the <a href="trait.FutureExt.html#method.then" title="method futures_util::future::FutureExt::then"><code>then</code></a> method.</dd><dt><a class="struct" href="struct.TryFlatten.html" title="struct futures_util::future::TryFlatten">TryFlatten</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.try_flatten" title="method futures_util::future::TryFutureExt::try_flatten"><code>try_flatten</code></a> method.</dd><dt><a class="struct" href="struct.TryFlattenStream.html" title="struct futures_util::future::TryFlattenStream">TryFlatten<wbr>Stream</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.try_flatten_stream" title="method futures_util::future::TryFutureExt::try_flatten_stream"><code>try_flatten_stream</code></a> method.</dd><dt><a class="struct" href="struct.TryJoin.html" title="struct futures_util::future::TryJoin">TryJoin</a></dt><dd>Future for the <a href="fn.try_join.html" title="fn futures_util::future::try_join"><code>try_join</code></a> function.</dd><dt><a class="struct" href="struct.TryJoin3.html" title="struct futures_util::future::TryJoin3">TryJoin3</a></dt><dd>Future for the <a href="fn.try_join3.html" title="fn futures_util::future::try_join3"><code>try_join3</code></a> function.</dd><dt><a class="struct" href="struct.TryJoin4.html" title="struct futures_util::future::TryJoin4">TryJoin4</a></dt><dd>Future for the <a href="fn.try_join4.html" title="fn futures_util::future::try_join4"><code>try_join4</code></a> function.</dd><dt><a class="struct" href="struct.TryJoin5.html" title="struct futures_util::future::TryJoin5">TryJoin5</a></dt><dd>Future for the <a href="fn.try_join5.html" title="fn futures_util::future::try_join5"><code>try_join5</code></a> function.</dd><dt><a class="struct" href="struct.TryJoinAll.html" title="struct futures_util::future::TryJoinAll">TryJoin<wbr>All</a></dt><dd>Future for the <a href="fn.try_join_all.html" title="fn futures_util::future::try_join_all"><code>try_join_all</code></a> function.</dd><dt><a class="struct" href="struct.TrySelect.html" title="struct futures_util::future::TrySelect">TrySelect</a></dt><dd>Future for the <a href="fn.try_select.html" title="fn futures_util::future::try_select"><code>try_select()</code></a> function.</dd><dt><a class="struct" href="struct.UnitError.html" title="struct futures_util::future::UnitError">Unit<wbr>Error</a></dt><dd>Future for the <a href="trait.FutureExt.html#method.unit_error" title="method futures_util::future::FutureExt::unit_error"><code>unit_error</code></a> combinator.</dd><dt><a class="struct" href="struct.UnwrapOrElse.html" title="struct futures_util::future::UnwrapOrElse">Unwrap<wbr>OrElse</a></dt><dd>Future for the <a href="trait.TryFutureExt.html#method.unwrap_or_else" title="method futures_util::future::TryFutureExt::unwrap_or_else"><code>unwrap_or_else</code></a> method.</dd><dt><a class="struct" href="struct.WeakShared.html" title="struct futures_util::future::WeakShared">Weak<wbr>Shared</a></dt><dd>A weak reference to a <a href="struct.Shared.html" title="struct futures_util::future::Shared"><code>Shared</code></a> that can be upgraded much like an <code>Arc</code>.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a></dt><dd>Combines two different futures, streams, or sinks having the same associated types into a single type.</dd><dt><a class="enum" href="enum.MaybeDone.html" title="enum futures_util::future::MaybeDone">Maybe<wbr>Done</a></dt><dd>A future that may have completed.</dd><dt><a class="enum" href="enum.TryMaybeDone.html" title="enum futures_util::future::TryMaybeDone">TryMaybe<wbr>Done</a></dt><dd>A future that may have completed with an error.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.FusedFuture.html" title="trait futures_util::future::FusedFuture">Fused<wbr>Future</a></dt><dd>A future which tracks whether or not the underlying future
should no longer be polled.</dd><dt><a class="trait" href="trait.FutureExt.html" title="trait futures_util::future::FutureExt">Future<wbr>Ext</a></dt><dd>An extension trait for <code>Future</code>s that provides a variety of convenient
adapters.</dd><dt><a class="trait" href="trait.TryFuture.html" title="trait futures_util::future::TryFuture">TryFuture</a></dt><dd>A convenience for futures that return <code>Result</code> values that includes
a variety of adapters tailored to such futures.</dd><dt><a class="trait" href="trait.TryFutureExt.html" title="trait futures_util::future::TryFutureExt">TryFuture<wbr>Ext</a></dt><dd>Adapters specific to <a href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result"><code>Result</code></a>-returning futures</dd><dt><a class="trait" href="trait.UnsafeFutureObj.html" title="trait futures_util::future::UnsafeFutureObj">Unsafe<wbr>Future<wbr>Obj</a></dt><dd>A custom implementation of a future trait object for <code>FutureObj</code>, providing
a vtable with drop support.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.abortable.html" title="fn futures_util::future::abortable">abortable</a></dt><dd>Creates a new <code>Abortable</code> future and an <code>AbortHandle</code> which can be used to stop it.</dd><dt><a class="fn" href="fn.always_ready.html" title="fn futures_util::future::always_ready">always_<wbr>ready</a></dt><dd>Creates a future that is always immediately ready with a value.</dd><dt><a class="fn" href="fn.err.html" title="fn futures_util::future::err">err</a></dt><dd>Create a future that is immediately ready with an error value.</dd><dt><a class="fn" href="fn.join.html" title="fn futures_util::future::join">join</a></dt><dd>Joins the result of two futures, waiting for them both to complete.</dd><dt><a class="fn" href="fn.join3.html" title="fn futures_util::future::join3">join3</a></dt><dd>Same as <a href="fn.join.html" title="fn futures_util::future::join"><code>join</code></a>, but with more futures.</dd><dt><a class="fn" href="fn.join4.html" title="fn futures_util::future::join4">join4</a></dt><dd>Same as <a href="fn.join.html" title="fn futures_util::future::join"><code>join</code></a>, but with more futures.</dd><dt><a class="fn" href="fn.join5.html" title="fn futures_util::future::join5">join5</a></dt><dd>Same as <a href="fn.join.html" title="fn futures_util::future::join"><code>join</code></a>, but with more futures.</dd><dt><a class="fn" href="fn.join_all.html" title="fn futures_util::future::join_all">join_<wbr>all</a></dt><dd>Creates a future which represents a collection of the outputs of the futures
given.</dd><dt><a class="fn" href="fn.lazy.html" title="fn futures_util::future::lazy">lazy</a></dt><dd>Creates a new future that allows delayed execution of a closure.</dd><dt><a class="fn" href="fn.maybe_done.html" title="fn futures_util::future::maybe_done">maybe_<wbr>done</a></dt><dd>Wraps a future into a <code>MaybeDone</code></dd><dt><a class="fn" href="fn.ok.html" title="fn futures_util::future::ok">ok</a></dt><dd>Create a future that is immediately ready with a success value.</dd><dt><a class="fn" href="fn.pending.html" title="fn futures_util::future::pending">pending</a></dt><dd>Creates a future which never resolves, representing a computation that never
finishes.</dd><dt><a class="fn" href="fn.poll_fn.html" title="fn futures_util::future::poll_fn">poll_fn</a></dt><dd>Creates a new future wrapping around a function returning <a href="https://doc.rust-lang.org/1.93.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll"><code>Poll</code></a>.</dd><dt><a class="fn" href="fn.poll_immediate.html" title="fn futures_util::future::poll_immediate">poll_<wbr>immediate</a></dt><dd>Creates a future that is immediately ready with an Option of a value.
Specifically this means that <a href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html#tymethod.poll" title="method core::future::future::Future::poll">poll</a> always returns <a href="https://doc.rust-lang.org/1.93.1/core/task/poll/enum.Poll.html#variant.Ready" title="variant core::task::poll::Poll::Ready">Poll::Ready</a>.</dd><dt><a class="fn" href="fn.ready.html" title="fn futures_util::future::ready">ready</a></dt><dd>Creates a future that is immediately ready with a value.</dd><dt><a class="fn" href="fn.select.html" title="fn futures_util::future::select">select</a></dt><dd>Waits for either one of two differently-typed futures to complete.</dd><dt><a class="fn" href="fn.select_all.html" title="fn futures_util::future::select_all">select_<wbr>all</a></dt><dd>Creates a new future which will select over a list of futures.</dd><dt><a class="fn" href="fn.select_ok.html" title="fn futures_util::future::select_ok">select_<wbr>ok</a></dt><dd>Creates a new future which will select the first successful future over a list of futures.</dd><dt><a class="fn" href="fn.try_join.html" title="fn futures_util::future::try_join">try_<wbr>join</a></dt><dd>Joins the result of two futures, waiting for them both to complete or
for one to produce an error.</dd><dt><a class="fn" href="fn.try_join3.html" title="fn futures_util::future::try_join3">try_<wbr>join3</a></dt><dd>Same as <a href="fn.try_join.html" title="fn futures_util::future::try_join"><code>try_join</code></a>, but with more futures.</dd><dt><a class="fn" href="fn.try_join4.html" title="fn futures_util::future::try_join4">try_<wbr>join4</a></dt><dd>Same as <a href="fn.try_join.html" title="fn futures_util::future::try_join"><code>try_join</code></a>, but with more futures.</dd><dt><a class="fn" href="fn.try_join5.html" title="fn futures_util::future::try_join5">try_<wbr>join5</a></dt><dd>Same as <a href="fn.try_join.html" title="fn futures_util::future::try_join"><code>try_join</code></a>, but with more futures.</dd><dt><a class="fn" href="fn.try_join_all.html" title="fn futures_util::future::try_join_all">try_<wbr>join_<wbr>all</a></dt><dd>Creates a future which represents either a collection of the results of the
futures given or an error.</dd><dt><a class="fn" href="fn.try_maybe_done.html" title="fn futures_util::future::try_maybe_done">try_<wbr>maybe_<wbr>done</a></dt><dd>Wraps a future into a <code>TryMaybeDone</code></dd><dt><a class="fn" href="fn.try_select.html" title="fn futures_util::future::try_select">try_<wbr>select</a></dt><dd>Waits for either one of two differently-typed futures to complete.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.BoxFuture.html" title="type futures_util::future::BoxFuture">BoxFuture</a></dt><dd>An owned dynamically typed <a href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html" title="trait core::future::future::Future"><code>Future</code></a> for use in cases where you cant
statically type your result or need to add some indirection.</dd><dt><a class="type" href="type.LocalBoxFuture.html" title="type futures_util::future::LocalBoxFuture">Local<wbr>BoxFuture</a></dt><dd><code>BoxFuture</code>, but without the <code>Send</code> requirement.</dd></dl></section></div></main></body></html>