Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / futures_util / future / mod.rs.html
blob: e13c45b5d279d132625d893b2be8aae75bd92b47 [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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/futures-util-0.3.28/src/future/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../futures_util/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
</pre><pre class="rust"><code><span class="doccomment">//! Asynchronous values.
//!
//! This module contains:
//!
//! - The [`Future`] trait.
//! - The [`FutureExt`] and [`TryFutureExt`] trait, which provides adapters for
//! chaining and composing futures.
//! - Top-level future combinators like [`lazy`](lazy()) which creates a future
//! from a closure that defines its return value, and [`ready`](ready()),
//! which constructs a future with an immediate defined value.
</span><span class="attribute">#[doc(no_inline)]
</span><span class="kw">pub use </span>core::future::Future;
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub use </span>futures_core::future::{BoxFuture, LocalBoxFuture};
<span class="kw">pub use </span>futures_core::future::{FusedFuture, TryFuture};
<span class="kw">pub use </span>futures_task::{FutureObj, LocalFutureObj, UnsafeFutureObj};
<span class="comment">// Extension traits and combinators
</span><span class="attribute">#[allow(clippy::module_inception)]
</span><span class="kw">mod </span>future;
<span class="kw">pub use </span><span class="self">self</span>::future::{
Flatten, Fuse, FutureExt, Inspect, IntoStream, Map, MapInto, NeverError, Then, UnitError,
};
<span class="attribute">#[deprecated(note = <span class="string">&quot;This is now an alias for [Flatten](Flatten)&quot;</span>)]
</span><span class="kw">pub use </span><span class="self">self</span>::future::FlattenStream;
<span class="attribute">#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">pub use </span><span class="self">self</span>::future::CatchUnwind;
<span class="attribute">#[cfg(feature = <span class="string">&quot;channel&quot;</span>)]
#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">&quot;channel&quot;</span>)))]
#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">pub use </span><span class="self">self</span>::future::{Remote, RemoteHandle};
<span class="attribute">#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">pub use </span><span class="self">self</span>::future::{Shared, WeakShared};
<span class="kw">mod </span>try_future;
<span class="kw">pub use </span><span class="self">self</span>::try_future::{
AndThen, ErrInto, InspectErr, InspectOk, IntoFuture, MapErr, MapOk, MapOkOrElse, OkInto,
OrElse, TryFlatten, TryFlattenStream, TryFutureExt, UnwrapOrElse,
};
<span class="attribute">#[cfg(feature = <span class="string">&quot;sink&quot;</span>)]
#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">&quot;sink&quot;</span>)))]
</span><span class="kw">pub use </span><span class="self">self</span>::try_future::FlattenSink;
<span class="comment">// Primitive futures
</span><span class="kw">mod </span>lazy;
<span class="kw">pub use </span><span class="self">self</span>::lazy::{lazy, Lazy};
<span class="kw">mod </span>pending;
<span class="kw">pub use </span><span class="self">self</span>::pending::{pending, Pending};
<span class="kw">mod </span>maybe_done;
<span class="kw">pub use </span><span class="self">self</span>::maybe_done::{maybe_done, MaybeDone};
<span class="kw">mod </span>try_maybe_done;
<span class="kw">pub use </span><span class="self">self</span>::try_maybe_done::{try_maybe_done, TryMaybeDone};
<span class="kw">mod </span>option;
<span class="kw">pub use </span><span class="self">self</span>::option::OptionFuture;
<span class="kw">mod </span>poll_fn;
<span class="kw">pub use </span><span class="self">self</span>::poll_fn::{poll_fn, PollFn};
<span class="kw">mod </span>poll_immediate;
<span class="kw">pub use </span><span class="self">self</span>::poll_immediate::{poll_immediate, PollImmediate};
<span class="kw">mod </span>ready;
<span class="kw">pub use </span><span class="self">self</span>::ready::{err, ok, ready, Ready};
<span class="kw">mod </span>join;
<span class="kw">pub use </span><span class="self">self</span>::join::{join, join3, join4, join5, Join, Join3, Join4, Join5};
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">mod </span>join_all;
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub use </span><span class="self">self</span>::join_all::{join_all, JoinAll};
<span class="kw">mod </span>select;
<span class="kw">pub use </span><span class="self">self</span>::select::{select, Select};
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">mod </span>select_all;
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub use </span><span class="self">self</span>::select_all::{select_all, SelectAll};
<span class="kw">mod </span>try_join;
<span class="kw">pub use </span><span class="self">self</span>::try_join::{
try_join, try_join3, try_join4, try_join5, TryJoin, TryJoin3, TryJoin4, TryJoin5,
};
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">mod </span>try_join_all;
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub use </span><span class="self">self</span>::try_join_all::{try_join_all, TryJoinAll};
<span class="kw">mod </span>try_select;
<span class="kw">pub use </span><span class="self">self</span>::try_select::{try_select, TrySelect};
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">mod </span>select_ok;
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub use </span><span class="self">self</span>::select_ok::{select_ok, SelectOk};
<span class="kw">mod </span>either;
<span class="kw">pub use </span><span class="self">self</span>::either::Either;
<span class="attribute">#[cfg(not(futures_no_atomic_cas))]
#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">mod </span>abortable;
<span class="attribute">#[cfg(not(futures_no_atomic_cas))]
#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub use </span><span class="kw">crate</span>::abortable::{AbortHandle, AbortRegistration, Abortable, Aborted};
<span class="attribute">#[cfg(not(futures_no_atomic_cas))]
#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub use </span>abortable::abortable;
<span class="comment">// Just a helper function to ensure the futures we&#39;re returning all have the
// right implementations.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>assert_future&lt;T, F&gt;(future: F) -&gt; F
<span class="kw">where
</span>F: Future&lt;Output = T&gt;,
{
future
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>