| <!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/task/spawn.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>spawn.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> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>futures_task::{LocalSpawn, Spawn}; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"compat"</span>)] |
| </span><span class="kw">use </span><span class="kw">crate</span>::compat::Compat; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"channel"</span>)] |
| #[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">use </span><span class="kw">crate</span>::future::{FutureExt, RemoteHandle}; |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">use </span>alloc::boxed::Box; |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">use </span>futures_core::future::Future; |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">use </span>futures_task::{FutureObj, LocalFutureObj, SpawnError}; |
| |
| <span class="kw">impl</span><Sp: <span class="question-mark">?</span>Sized> SpawnExt <span class="kw">for </span>Sp <span class="kw">where </span>Sp: Spawn {} |
| <span class="kw">impl</span><Sp: <span class="question-mark">?</span>Sized> LocalSpawnExt <span class="kw">for </span>Sp <span class="kw">where </span>Sp: LocalSpawn {} |
| |
| <span class="doccomment">/// Extension trait for `Spawn`. |
| </span><span class="kw">pub trait </span>SpawnExt: Spawn { |
| <span class="doccomment">/// Spawns a task that polls the given future with output `()` to |
| /// completion. |
| /// |
| /// This method returns a [`Result`] that contains a [`SpawnError`] if |
| /// spawning fails. |
| /// |
| /// You can use [`spawn_with_handle`](SpawnExt::spawn_with_handle) if |
| /// you want to spawn a future with output other than `()` or if you want |
| /// to be able to await its completion. |
| /// |
| /// Note this method will eventually be replaced with the upcoming |
| /// `Spawn::spawn` method which will take a `dyn Future` as input. |
| /// Technical limitations prevent `Spawn::spawn` from being implemented |
| /// today. Feel free to use this method in the meantime. |
| /// |
| /// ``` |
| /// # { |
| /// use futures::executor::ThreadPool; |
| /// use futures::task::SpawnExt; |
| /// |
| /// let executor = ThreadPool::new().unwrap(); |
| /// |
| /// let future = async { /* ... */ }; |
| /// executor.spawn(future).unwrap(); |
| /// # } |
| /// # std::thread::sleep(std::time::Duration::from_millis(500)); // wait for background threads closed: https://github.com/rust-lang/miri/issues/1371 |
| /// ``` |
| </span><span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">fn </span>spawn<Fut>(<span class="kw-2">&</span><span class="self">self</span>, future: Fut) -> <span class="prelude-ty">Result</span><(), SpawnError> |
| <span class="kw">where |
| </span>Fut: Future<Output = ()> + Send + <span class="lifetime">'static</span>, |
| { |
| <span class="self">self</span>.spawn_obj(FutureObj::new(Box::new(future))) |
| } |
| |
| <span class="doccomment">/// Spawns a task that polls the given future to completion and returns a |
| /// future that resolves to the spawned future's output. |
| /// |
| /// This method returns a [`Result`] that contains a [`RemoteHandle`](crate::future::RemoteHandle), or, if |
| /// spawning fails, a [`SpawnError`]. [`RemoteHandle`](crate::future::RemoteHandle) is a future that |
| /// resolves to the output of the spawned future. |
| /// |
| /// ``` |
| /// # { |
| /// use futures::executor::{block_on, ThreadPool}; |
| /// use futures::future; |
| /// use futures::task::SpawnExt; |
| /// |
| /// let executor = ThreadPool::new().unwrap(); |
| /// |
| /// let future = future::ready(1); |
| /// let join_handle_fut = executor.spawn_with_handle(future).unwrap(); |
| /// assert_eq!(block_on(join_handle_fut), 1); |
| /// # } |
| /// # std::thread::sleep(std::time::Duration::from_millis(500)); // wait for background threads closed: https://github.com/rust-lang/miri/issues/1371 |
| /// ``` |
| </span><span class="attribute">#[cfg(feature = <span class="string">"channel"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"channel"</span>)))] |
| #[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">fn </span>spawn_with_handle<Fut>(<span class="kw-2">&</span><span class="self">self</span>, future: Fut) -> <span class="prelude-ty">Result</span><RemoteHandle<Fut::Output>, SpawnError> |
| <span class="kw">where |
| </span>Fut: Future + Send + <span class="lifetime">'static</span>, |
| Fut::Output: Send, |
| { |
| <span class="kw">let </span>(future, handle) = future.remote_handle(); |
| <span class="self">self</span>.spawn(future)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(handle) |
| } |
| |
| <span class="doccomment">/// Wraps a [`Spawn`] and makes it usable as a futures 0.1 `Executor`. |
| /// Requires the `compat` feature to enable. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"compat"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"compat"</span>)))] |
| </span><span class="kw">fn </span>compat(<span class="self">self</span>) -> Compat<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized, |
| { |
| Compat::new(<span class="self">self</span>) |
| } |
| } |
| |
| <span class="doccomment">/// Extension trait for `LocalSpawn`. |
| </span><span class="kw">pub trait </span>LocalSpawnExt: LocalSpawn { |
| <span class="doccomment">/// Spawns a task that polls the given future with output `()` to |
| /// completion. |
| /// |
| /// This method returns a [`Result`] that contains a [`SpawnError`] if |
| /// spawning fails. |
| /// |
| /// You can use [`spawn_with_handle`](SpawnExt::spawn_with_handle) if |
| /// you want to spawn a future with output other than `()` or if you want |
| /// to be able to await its completion. |
| /// |
| /// Note this method will eventually be replaced with the upcoming |
| /// `Spawn::spawn` method which will take a `dyn Future` as input. |
| /// Technical limitations prevent `Spawn::spawn` from being implemented |
| /// today. Feel free to use this method in the meantime. |
| /// |
| /// ``` |
| /// use futures::executor::LocalPool; |
| /// use futures::task::LocalSpawnExt; |
| /// |
| /// let executor = LocalPool::new(); |
| /// let spawner = executor.spawner(); |
| /// |
| /// let future = async { /* ... */ }; |
| /// spawner.spawn_local(future).unwrap(); |
| /// ``` |
| </span><span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">fn </span>spawn_local<Fut>(<span class="kw-2">&</span><span class="self">self</span>, future: Fut) -> <span class="prelude-ty">Result</span><(), SpawnError> |
| <span class="kw">where |
| </span>Fut: Future<Output = ()> + <span class="lifetime">'static</span>, |
| { |
| <span class="self">self</span>.spawn_local_obj(LocalFutureObj::new(Box::new(future))) |
| } |
| |
| <span class="doccomment">/// Spawns a task that polls the given future to completion and returns a |
| /// future that resolves to the spawned future's output. |
| /// |
| /// This method returns a [`Result`] that contains a [`RemoteHandle`](crate::future::RemoteHandle), or, if |
| /// spawning fails, a [`SpawnError`]. [`RemoteHandle`](crate::future::RemoteHandle) is a future that |
| /// resolves to the output of the spawned future. |
| /// |
| /// ``` |
| /// use futures::executor::LocalPool; |
| /// use futures::task::LocalSpawnExt; |
| /// |
| /// let mut executor = LocalPool::new(); |
| /// let spawner = executor.spawner(); |
| /// |
| /// let future = async { 1 }; |
| /// let join_handle_fut = spawner.spawn_local_with_handle(future).unwrap(); |
| /// assert_eq!(executor.run_until(join_handle_fut), 1); |
| /// ``` |
| </span><span class="attribute">#[cfg(feature = <span class="string">"channel"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"channel"</span>)))] |
| #[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">fn </span>spawn_local_with_handle<Fut>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| future: Fut, |
| ) -> <span class="prelude-ty">Result</span><RemoteHandle<Fut::Output>, SpawnError> |
| <span class="kw">where |
| </span>Fut: Future + <span class="lifetime">'static</span>, |
| { |
| <span class="kw">let </span>(future, handle) = future.remote_handle(); |
| <span class="self">self</span>.spawn_local(future)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(handle) |
| } |
| } |
| </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> |
