OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-28 12:51:55 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/futures_util/future/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

29 lines
32 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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures_util/index.html">futures_util</a><span class="version">0.3.28</span></h2></div><h2 class="location"><a href="#">Module future</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><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 Aliases</a></li></ul></section><h2><a href="../index.html">In crate futures_util</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../futures_util/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">futures_util</a>::<wbr><a class="mod" href="#">future</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/futures_util/future/mod.rs.html#1-131">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></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.76.0/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"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Future"><code>pub use core::future::<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>;</code></div></li></ul><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AbortHandle.html" title="struct futures_util::future::AbortHandle">AbortHandle</a></div><div class="desc docblock-short">A handle to an <code>Abortable</code> task.</div></li><li><div class="item-name"><a class="struct" href="struct.AbortRegistration.html" title="struct futures_util::future::AbortRegistration">AbortRegistration</a></div><div class="desc 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></li><li><div class="item-name"><a class="struct" href="struct.Abortable.html" title="struct futures_util::future::Abortable">Abortable</a></div><div class="desc docblock-short">A future/stream which can be remotely short-circuited using an <code>AbortHandle</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Aborted.html" title="struct futures_util::future::Aborted">Aborted</a></div><div class="desc docblock-short">Indicator that the <code>Abortable</code> task was aborted.</div></li><li><div class="item-name"><a class="struct" href="struct.AndThen.html" title="struct futures_util::future::AndThen">AndThen</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.CatchUnwind.html" title="struct futures_util::future::CatchUnwind">CatchUnwind</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.ErrInto.html" title="struct futures_util::future::ErrInto">ErrInto</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.Flatten.html" title="struct futures_util::future::Flatten">Flatten</a></div><div class="desc docblock-short">Future for the <a href="trait.FutureExt.html#method.flatten" title="method futures_util::future::FutureExt::flatten"><code>flatten</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.FlattenSink.html" title="struct futures_util::future::FlattenSink">FlattenSink</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.FlattenStream.html" title="struct futures_util::future::FlattenStream">FlattenStream</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.Fuse.html" title="struct futures_util::future::Fuse">Fuse</a></div><div class="desc docblock-short">Future for the <a href="trait.FutureExt.html#method.fuse" title="method futures_util::future::FutureExt::fuse"><code>fuse</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.FutureObj.html" title="struct futures_util::future::FutureObj">FutureObj</a></div><div class="desc 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></li><li><div class="item-name"><a class="struct" href="struct.Inspect.html" title="struct futures_util::future::Inspect">Inspect</a></div><div class="desc docblock-short">Future for the <a href="trait.FutureExt.html#method.inspect" title="method futures_util::future::FutureExt::inspect"><code>inspect</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.InspectErr.html" title="struct futures_util::future::InspectErr">InspectErr</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.InspectOk.html" title="struct futures_util::future::InspectOk">InspectOk</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoFuture.html" title="struct futures_util::future::IntoFuture">IntoFuture</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoStream.html" title="struct futures_util::future::IntoStream">IntoStream</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.Join.html" title="struct futures_util::future::Join">Join</a></div><div class="desc docblock-short">Future for the <a href="fn.join.html" title="fn futures_util::future::join"><code>join</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Join3.html" title="struct futures_util::future::Join3">Join3</a></div><div class="desc docblock-short">Future for the <a href="fn.join3.html" title="fn futures_util::future::join3"><code>join3</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Join4.html" title="struct futures_util::future::Join4">Join4</a></div><div class="desc docblock-short">Future for the <a href="fn.join4.html" title="fn futures_util::future::join4"><code>join4</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Join5.html" title="struct futures_util::future::Join5">Join5</a></div><div class="desc docblock-short">Future for the <a href="fn.join5.html" title="fn futures_util::future::join5"><code>join5</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.JoinAll.html" title="struct futures_util::future::JoinAll">JoinAll</a></div><div class="desc docblock-short">Future for the <a href="fn.join_all.html" title="fn futures_util::future::join_all"><code>join_all</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Lazy.html" title="struct futures_util::future::Lazy">Lazy</a></div><div class="desc docblock-short">Future for the <a href="fn.lazy.html" title="fn futures_util::future::lazy"><code>lazy</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.LocalFutureObj.html" title="struct futures_util::future::LocalFutureObj">LocalFutureObj</a></div><div class="desc 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></li><li><div class="item-name"><a class="struct" href="struct.Map.html" title="struct futures_util::future::Map">Map</a></div><div class="desc docblock-short">Future for the <a href="trait.FutureExt.html#method.map" title="method futures_util::future::FutureExt::map"><code>map</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.MapErr.html" title="struct futures_util::future::MapErr">MapErr</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.MapInto.html" title="struct futures_util::future::MapInto">MapInto</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.MapOk.html" title="struct futures_util::future::MapOk">MapOk</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.MapOkOrElse.html" title="struct futures_util::future::MapOkOrElse">MapOkOrElse</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.NeverError.html" title="struct futures_util::future::NeverError">NeverError</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.OkInto.html" title="struct futures_util::future::OkInto">OkInto</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.OptionFuture.html" title="struct futures_util::future::OptionFuture">OptionFuture</a></div><div class="desc docblock-short">A future representing a value which may or may not be present.</div></li><li><div class="item-name"><a class="struct" href="struct.OrElse.html" title="struct futures_util::future::OrElse">OrElse</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.Pending.html" title="struct futures_util::future::Pending">Pending</a></div><div class="desc docblock-short">Future for the <a href="fn.pending.html" title="fn futures_util::future::pending"><code>pending()</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.PollFn.html" title="struct futures_util::future::PollFn">PollFn</a></div><div class="desc docblock-short">Future for the <a href="fn.poll_fn.html" title="fn futures_util::future::poll_fn"><code>poll_fn</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.PollImmediate.html" title="struct futures_util::future::PollImmediate">PollImmediate</a></div><div class="desc docblock-short">Future for the <a href="fn.poll_immediate.html" title="fn futures_util::future::poll_immediate"><code>poll_immediate</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Ready.html" title="struct futures_util::future::Ready">Ready</a></div><div class="desc docblock-short">Future for the <a href="fn.ready.html" title="fn futures_util::future::ready"><code>ready</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Remote.html" title="struct futures_util::future::Remote">Remote</a></div><div class="desc docblock-short">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>.</div></li><li><div class="item-name"><a class="struct" href="struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.Select.html" title="struct futures_util::future::Select">Select</a></div><div class="desc docblock-short">Future for the <a href="fn.select.html" title="fn futures_util::future::select"><code>select()</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.SelectAll.html" title="struct futures_util::future::SelectAll">SelectAll</a></div><div class="desc docblock-short">Future for the <a href="fn.select_all.html" title="fn futures_util::future::select_all"><code>select_all</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.SelectOk.html" title="struct futures_util::future::SelectOk">SelectOk</a></div><div class="desc docblock-short">Future for the <a href="fn.select_ok.html" title="fn futures_util::future::select_ok"><code>select_ok</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Shared.html" title="struct futures_util::future::Shared">Shared</a></div><div class="desc docblock-short">Future for the <a href="trait.FutureExt.html#method.shared" title="method futures_util::future::FutureExt::shared"><code>shared</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Then.html" title="struct futures_util::future::Then">Then</a></div><div class="desc docblock-short">Future for the <a href="trait.FutureExt.html#method.then" title="method futures_util::future::FutureExt::then"><code>then</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryFlatten.html" title="struct futures_util::future::TryFlatten">TryFlatten</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.TryFlattenStream.html" title="struct futures_util::future::TryFlattenStream">TryFlattenStream</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.TryJoin.html" title="struct futures_util::future::TryJoin">TryJoin</a></div><div class="desc docblock-short">Future for the <a href="fn.try_join.html" title="fn futures_util::future::try_join"><code>try_join</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.TryJoin3.html" title="struct futures_util::future::TryJoin3">TryJoin3</a></div><div class="desc docblock-short">Future for the <a href="fn.try_join3.html" title="fn futures_util::future::try_join3"><code>try_join3</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.TryJoin4.html" title="struct futures_util::future::TryJoin4">TryJoin4</a></div><div class="desc docblock-short">Future for the <a href="fn.try_join4.html" title="fn futures_util::future::try_join4"><code>try_join4</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.TryJoin5.html" title="struct futures_util::future::TryJoin5">TryJoin5</a></div><div class="desc docblock-short">Future for the <a href="fn.try_join5.html" title="fn futures_util::future::try_join5"><code>try_join5</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.TryJoinAll.html" title="struct futures_util::future::TryJoinAll">TryJoinAll</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.TrySelect.html" title="struct futures_util::future::TrySelect">TrySelect</a></div><div class="desc docblock-short">Future for the <a href="fn.try_select.html" title="fn futures_util::future::try_select"><code>try_select()</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.UnitError.html" title="struct futures_util::future::UnitError">UnitError</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.UnwrapOrElse.html" title="struct futures_util::future::UnwrapOrElse">UnwrapOrElse</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="struct" href="struct.WeakShared.html" title="struct futures_util::future::WeakShared">WeakShared</a></div><div class="desc docblock-short">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>.</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a></div><div class="desc docblock-short">Combines two different futures, streams, or sinks having the same associated types into a single type.</div></li><li><div class="item-name"><a class="enum" href="enum.MaybeDone.html" title="enum futures_util::future::MaybeDone">MaybeDone</a></div><div class="desc docblock-short">A future that may have completed.</div></li><li><div class="item-name"><a class="enum" href="enum.TryMaybeDone.html" title="enum futures_util::future::TryMaybeDone">TryMaybeDone</a></div><div class="desc docblock-short">A future that may have completed with an error.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.FusedFuture.html" title="trait futures_util::future::FusedFuture">FusedFuture</a></div><div class="desc docblock-short">A future which tracks whether or not the underlying future
should no longer be polled.</div></li><li><div class="item-name"><a class="trait" href="trait.FutureExt.html" title="trait futures_util::future::FutureExt">FutureExt</a></div><div class="desc docblock-short">An extension trait for <code>Future</code>s that provides a variety of convenient
adapters.</div></li><li><div class="item-name"><a class="trait" href="trait.TryFuture.html" title="trait futures_util::future::TryFuture">TryFuture</a></div><div class="desc docblock-short">A convenience for futures that return <code>Result</code> values that includes
a variety of adapters tailored to such futures.</div></li><li><div class="item-name"><a class="trait" href="trait.TryFutureExt.html" title="trait futures_util::future::TryFutureExt">TryFutureExt</a></div><div class="desc docblock-short">Adapters specific to <a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result"><code>Result</code></a>-returning futures</div></li><li><div class="item-name"><a class="trait" href="trait.UnsafeFutureObj.html" title="trait futures_util::future::UnsafeFutureObj">UnsafeFutureObj</a></div><div class="desc docblock-short">A custom implementation of a future trait object for <code>FutureObj</code>, providing
a vtable with drop support.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.abortable.html" title="fn futures_util::future::abortable">abortable</a></div><div class="desc docblock-short">Creates a new <code>Abortable</code> future and an <code>AbortHandle</code> which can be used to stop it.</div></li><li><div class="item-name"><a class="fn" href="fn.err.html" title="fn futures_util::future::err">err</a></div><div class="desc docblock-short">Create a future that is immediately ready with an error value.</div></li><li><div class="item-name"><a class="fn" href="fn.join.html" title="fn futures_util::future::join">join</a></div><div class="desc docblock-short">Joins the result of two futures, waiting for them both to complete.</div></li><li><div class="item-name"><a class="fn" href="fn.join3.html" title="fn futures_util::future::join3">join3</a></div><div class="desc docblock-short">Same as <a href="fn.join.html" title="fn futures_util::future::join"><code>join</code></a>, but with more futures.</div></li><li><div class="item-name"><a class="fn" href="fn.join4.html" title="fn futures_util::future::join4">join4</a></div><div class="desc docblock-short">Same as <a href="fn.join.html" title="fn futures_util::future::join"><code>join</code></a>, but with more futures.</div></li><li><div class="item-name"><a class="fn" href="fn.join5.html" title="fn futures_util::future::join5">join5</a></div><div class="desc docblock-short">Same as <a href="fn.join.html" title="fn futures_util::future::join"><code>join</code></a>, but with more futures.</div></li><li><div class="item-name"><a class="fn" href="fn.join_all.html" title="fn futures_util::future::join_all">join_all</a></div><div class="desc docblock-short">Creates a future which represents a collection of the outputs of the futures
given.</div></li><li><div class="item-name"><a class="fn" href="fn.lazy.html" title="fn futures_util::future::lazy">lazy</a></div><div class="desc docblock-short">Creates a new future that allows delayed execution of a closure.</div></li><li><div class="item-name"><a class="fn" href="fn.maybe_done.html" title="fn futures_util::future::maybe_done">maybe_done</a></div><div class="desc docblock-short">Wraps a future into a <code>MaybeDone</code></div></li><li><div class="item-name"><a class="fn" href="fn.ok.html" title="fn futures_util::future::ok">ok</a></div><div class="desc docblock-short">Create a future that is immediately ready with a success value.</div></li><li><div class="item-name"><a class="fn" href="fn.pending.html" title="fn futures_util::future::pending">pending</a></div><div class="desc docblock-short">Creates a future which never resolves, representing a computation that never
finishes.</div></li><li><div class="item-name"><a class="fn" href="fn.poll_fn.html" title="fn futures_util::future::poll_fn">poll_fn</a></div><div class="desc docblock-short">Creates a new future wrapping around a function returning <a href="https://doc.rust-lang.org/1.76.0/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll"><code>Poll</code></a>.</div></li><li><div class="item-name"><a class="fn" href="fn.poll_immediate.html" title="fn futures_util::future::poll_immediate">poll_immediate</a></div><div class="desc docblock-short">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.76.0/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.76.0/core/task/poll/enum.Poll.html#variant.Ready" title="variant core::task::poll::Poll::Ready">Poll::Ready</a>.</div></li><li><div class="item-name"><a class="fn" href="fn.ready.html" title="fn futures_util::future::ready">ready</a></div><div class="desc docblock-short">Creates a future that is immediately ready with a value.</div></li><li><div class="item-name"><a class="fn" href="fn.select.html" title="fn futures_util::future::select">select</a></div><div class="desc docblock-short">Waits for either one of two differently-typed futures to complete.</div></li><li><div class="item-name"><a class="fn" href="fn.select_all.html" title="fn futures_util::future::select_all">select_all</a></div><div class="desc docblock-short">Creates a new future which will select over a list of futures.</div></li><li><div class="item-name"><a class="fn" href="fn.select_ok.html" title="fn futures_util::future::select_ok">select_ok</a></div><div class="desc docblock-short">Creates a new future which will select the first successful future over a list of futures.</div></li><li><div class="item-name"><a class="fn" href="fn.try_join.html" title="fn futures_util::future::try_join">try_join</a></div><div class="desc docblock-short">Joins the result of two futures, waiting for them both to complete or
for one to produce an error.</div></li><li><div class="item-name"><a class="fn" href="fn.try_join3.html" title="fn futures_util::future::try_join3">try_join3</a></div><div class="desc docblock-short">Same as <a href="fn.try_join.html" title="fn futures_util::future::try_join"><code>try_join</code></a>, but with more futures.</div></li><li><div class="item-name"><a class="fn" href="fn.try_join4.html" title="fn futures_util::future::try_join4">try_join4</a></div><div class="desc docblock-short">Same as <a href="fn.try_join.html" title="fn futures_util::future::try_join"><code>try_join</code></a>, but with more futures.</div></li><li><div class="item-name"><a class="fn" href="fn.try_join5.html" title="fn futures_util::future::try_join5">try_join5</a></div><div class="desc docblock-short">Same as <a href="fn.try_join.html" title="fn futures_util::future::try_join"><code>try_join</code></a>, but with more futures.</div></li><li><div class="item-name"><a class="fn" href="fn.try_join_all.html" title="fn futures_util::future::try_join_all">try_join_all</a></div><div class="desc docblock-short">Creates a future which represents either a collection of the results of the
futures given or an error.</div></li><li><div class="item-name"><a class="fn" href="fn.try_maybe_done.html" title="fn futures_util::future::try_maybe_done">try_maybe_done</a></div><div class="desc docblock-short">Wraps a future into a <code>TryMaybeDone</code></div></li><li><div class="item-name"><a class="fn" href="fn.try_select.html" title="fn futures_util::future::try_select">try_select</a></div><div class="desc docblock-short">Waits for either one of two differently-typed futures to complete.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.BoxFuture.html" title="type futures_util::future::BoxFuture">BoxFuture</a></div><div class="desc docblock-short">An owned dynamically typed <a href="https://doc.rust-lang.org/1.76.0/core/future/future/trait.Future.html" title="trait core::future::future::Future"><code>Future</code></a> for use in cases where you can’t
statically type your result or need to add some indirection.</div></li><li><div class="item-name"><a class="type" href="type.LocalBoxFuture.html" title="type futures_util::future::LocalBoxFuture">LocalBoxFuture</a></div><div class="desc docblock-short"><code>BoxFuture</code>, but without the <code>Send</code> requirement.</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink