| <!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/git/checkouts/tokio-377c595163f99a10/dfe252d/tokio/src/task/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="../../../tokio/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="../../../tokio/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> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Asynchronous green-threads. |
| //! |
| //! ## What are Tasks? |
| //! |
| //! A _task_ is a light weight, non-blocking unit of execution. A task is similar |
| //! to an OS thread, but rather than being managed by the OS scheduler, they are |
| //! managed by the [Tokio runtime][rt]. Another name for this general pattern is |
| //! [green threads]. If you are familiar with [Go's goroutines], [Kotlin's |
| //! coroutines], or [Erlang's processes], you can think of Tokio's tasks as |
| //! something similar. |
| //! |
| //! Key points about tasks include: |
| //! |
| //! * Tasks are **light weight**. Because tasks are scheduled by the Tokio |
| //! runtime rather than the operating system, creating new tasks or switching |
| //! between tasks does not require a context switch and has fairly low |
| //! overhead. Creating, running, and destroying large numbers of tasks is |
| //! quite cheap, especially compared to OS threads. |
| //! |
| //! * Tasks are scheduled **cooperatively**. Most operating systems implement |
| //! _preemptive multitasking_. This is a scheduling technique where the |
| //! operating system allows each thread to run for a period of time, and then |
| //! _preempts_ it, temporarily pausing that thread and switching to another. |
| //! Tasks, on the other hand, implement _cooperative multitasking_. In |
| //! cooperative multitasking, a task is allowed to run until it _yields_, |
| //! indicating to the Tokio runtime's scheduler that it cannot currently |
| //! continue executing. When a task yields, the Tokio runtime switches to |
| //! executing the next task. |
| //! |
| //! * Tasks are **non-blocking**. Typically, when an OS thread performs I/O or |
| //! must synchronize with another thread, it _blocks_, allowing the OS to |
| //! schedule another thread. When a task cannot continue executing, it must |
| //! yield instead, allowing the Tokio runtime to schedule another task. Tasks |
| //! should generally not perform system calls or other operations that could |
| //! block a thread, as this would prevent other tasks running on the same |
| //! thread from executing as well. Instead, this module provides APIs for |
| //! running blocking operations in an asynchronous context. |
| //! |
| //! [rt]: crate::runtime |
| //! [green threads]: https://en.wikipedia.org/wiki/Green_threads |
| //! [Go's goroutines]: https://tour.golang.org/concurrency/1 |
| //! [Kotlin's coroutines]: https://kotlinlang.org/docs/reference/coroutines-overview.html |
| //! [Erlang's processes]: http://erlang.org/doc/getting_started/conc_prog.html#processes |
| //! |
| //! ## Working with Tasks |
| //! |
| //! This module provides the following APIs for working with tasks: |
| //! |
| //! ### Spawning |
| //! |
| //! Perhaps the most important function in this module is [`task::spawn`]. This |
| //! function can be thought of as an async equivalent to the standard library's |
| //! [`thread::spawn`][`std::thread::spawn`]. It takes an `async` block or other |
| //! [future], and creates a new task to run that work concurrently: |
| //! |
| //! ``` |
| //! use tokio::task; |
| //! |
| //! # async fn doc() { |
| //! task::spawn(async { |
| //! // perform some work here... |
| //! }); |
| //! # } |
| //! ``` |
| //! |
| //! Like [`std::thread::spawn`], `task::spawn` returns a [`JoinHandle`] struct. |
| //! A `JoinHandle` is itself a future which may be used to await the output of |
| //! the spawned task. For example: |
| //! |
| //! ``` |
| //! use tokio::task; |
| //! |
| //! # #[tokio::main] async fn main() -> Result<(), Box<dyn std::error::Error>> { |
| //! let join = task::spawn(async { |
| //! // ... |
| //! "hello world!" |
| //! }); |
| //! |
| //! // ... |
| //! |
| //! // Await the result of the spawned task. |
| //! let result = join.await?; |
| //! assert_eq!(result, "hello world!"); |
| //! # Ok(()) |
| //! # } |
| //! ``` |
| //! |
| //! Again, like `std::thread`'s [`JoinHandle` type][thread_join], if the spawned |
| //! task panics, awaiting its `JoinHandle` will return a [`JoinError`]. For |
| //! example: |
| //! |
| //! ``` |
| //! use tokio::task; |
| //! |
| //! # #[tokio::main] async fn main() { |
| //! let join = task::spawn(async { |
| //! panic!("something bad happened!") |
| //! }); |
| //! |
| //! // The returned result indicates that the task failed. |
| //! assert!(join.await.is_err()); |
| //! # } |
| //! ``` |
| //! |
| //! `spawn`, `JoinHandle`, and `JoinError` are present when the "rt" |
| //! feature flag is enabled. |
| //! |
| //! [`task::spawn`]: crate::task::spawn() |
| //! [future]: std::future::Future |
| //! [`std::thread::spawn`]: std::thread::spawn |
| //! [`JoinHandle`]: crate::task::JoinHandle |
| //! [thread_join]: std::thread::JoinHandle |
| //! [`JoinError`]: crate::task::JoinError |
| //! |
| //! ### Blocking and Yielding |
| //! |
| //! As we discussed above, code running in asynchronous tasks should not perform |
| //! operations that can block. A blocking operation performed in a task running |
| //! on a thread that is also running other tasks would block the entire thread, |
| //! preventing other tasks from running. |
| //! |
| //! Instead, Tokio provides two APIs for running blocking operations in an |
| //! asynchronous context: [`task::spawn_blocking`] and [`task::block_in_place`]. |
| //! |
| //! Be aware that if you call a non-async method from async code, that non-async |
| //! method is still inside the asynchronous context, so you should also avoid |
| //! blocking operations there. This includes destructors of objects destroyed in |
| //! async code. |
| //! |
| //! #### spawn_blocking |
| //! |
| //! The `task::spawn_blocking` function is similar to the `task::spawn` function |
| //! discussed in the previous section, but rather than spawning an |
| //! _non-blocking_ future on the Tokio runtime, it instead spawns a |
| //! _blocking_ function on a dedicated thread pool for blocking tasks. For |
| //! example: |
| //! |
| //! ``` |
| //! use tokio::task; |
| //! |
| //! # async fn docs() { |
| //! task::spawn_blocking(|| { |
| //! // do some compute-heavy work or call synchronous code |
| //! }); |
| //! # } |
| //! ``` |
| //! |
| //! Just like `task::spawn`, `task::spawn_blocking` returns a `JoinHandle` |
| //! which we can use to await the result of the blocking operation: |
| //! |
| //! ```rust |
| //! # use tokio::task; |
| //! # async fn docs() -> Result<(), Box<dyn std::error::Error>>{ |
| //! let join = task::spawn_blocking(|| { |
| //! // do some compute-heavy work or call synchronous code |
| //! "blocking completed" |
| //! }); |
| //! |
| //! let result = join.await?; |
| //! assert_eq!(result, "blocking completed"); |
| //! # Ok(()) |
| //! # } |
| //! ``` |
| //! |
| //! #### block_in_place |
| //! |
| //! When using the [multi-threaded runtime][rt-multi-thread], the [`task::block_in_place`] |
| //! function is also available. Like `task::spawn_blocking`, this function |
| //! allows running a blocking operation from an asynchronous context. Unlike |
| //! `spawn_blocking`, however, `block_in_place` works by transitioning the |
| //! _current_ worker thread to a blocking thread, moving other tasks running on |
| //! that thread to another worker thread. This can improve performance by avoiding |
| //! context switches. |
| //! |
| //! For example: |
| //! |
| //! ``` |
| //! use tokio::task; |
| //! |
| //! # async fn docs() { |
| //! let result = task::block_in_place(|| { |
| //! // do some compute-heavy work or call synchronous code |
| //! "blocking completed" |
| //! }); |
| //! |
| //! assert_eq!(result, "blocking completed"); |
| //! # } |
| //! ``` |
| //! |
| //! #### yield_now |
| //! |
| //! In addition, this module provides a [`task::yield_now`] async function |
| //! that is analogous to the standard library's [`thread::yield_now`]. Calling |
| //! and `await`ing this function will cause the current task to yield to the |
| //! Tokio runtime's scheduler, allowing other tasks to be |
| //! scheduled. Eventually, the yielding task will be polled again, allowing it |
| //! to execute. For example: |
| //! |
| //! ```rust |
| //! use tokio::task; |
| //! |
| //! # #[tokio::main] async fn main() { |
| //! async { |
| //! task::spawn(async { |
| //! // ... |
| //! println!("spawned task done!") |
| //! }); |
| //! |
| //! // Yield, allowing the newly-spawned task to execute first. |
| //! task::yield_now().await; |
| //! println!("main task done!"); |
| //! } |
| //! # .await; |
| //! # } |
| //! ``` |
| //! |
| //! ### Cooperative scheduling |
| //! |
| //! A single call to [`poll`] on a top-level task may potentially do a lot of |
| //! work before it returns `Poll::Pending`. If a task runs for a long period of |
| //! time without yielding back to the executor, it can starve other tasks |
| //! waiting on that executor to execute them, or drive underlying resources. |
| //! Since Rust does not have a runtime, it is difficult to forcibly preempt a |
| //! long-running task. Instead, this module provides an opt-in mechanism for |
| //! futures to collaborate with the executor to avoid starvation. |
| //! |
| //! Consider a future like this one: |
| //! |
| //! ``` |
| //! # use tokio_stream::{Stream, StreamExt}; |
| //! async fn drop_all<I: Stream + Unpin>(mut input: I) { |
| //! while let Some(_) = input.next().await {} |
| //! } |
| //! ``` |
| //! |
| //! It may look harmless, but consider what happens under heavy load if the |
| //! input stream is _always_ ready. If we spawn `drop_all`, the task will never |
| //! yield, and will starve other tasks and resources on the same executor. |
| //! |
| //! To account for this, Tokio has explicit yield points in a number of library |
| //! functions, which force tasks to return to the executor periodically. |
| //! |
| //! |
| //! #### unconstrained |
| //! |
| //! If necessary, [`task::unconstrained`] lets you opt a future out of of Tokio's cooperative |
| //! scheduling. When a future is wrapped with `unconstrained`, it will never be forced to yield to |
| //! Tokio. For example: |
| //! |
| //! ``` |
| //! # #[tokio::main] |
| //! # async fn main() { |
| //! use tokio::{task, sync::mpsc}; |
| //! |
| //! let fut = async { |
| //! let (tx, mut rx) = mpsc::unbounded_channel(); |
| //! |
| //! for i in 0..1000 { |
| //! let _ = tx.send(()); |
| //! // This will always be ready. If coop was in effect, this code would be forced to yield |
| //! // periodically. However, if left unconstrained, then this code will never yield. |
| //! rx.recv().await; |
| //! } |
| //! }; |
| //! |
| //! task::unconstrained(fut).await; |
| //! # } |
| //! ``` |
| //! |
| //! [`task::spawn_blocking`]: crate::task::spawn_blocking |
| //! [`task::block_in_place`]: crate::task::block_in_place |
| //! [rt-multi-thread]: ../runtime/index.html#threaded-scheduler |
| //! [`task::yield_now`]: crate::task::yield_now() |
| //! [`thread::yield_now`]: std::thread::yield_now |
| //! [`task::unconstrained`]: crate::task::unconstrained() |
| //! [`poll`]: method@std::future::Future::poll |
| |
| </span><span class="macro">cfg_rt! </span>{ |
| <span class="kw">pub use </span><span class="kw">crate</span>::runtime::task::{JoinError, JoinHandle}; |
| |
| <span class="macro">cfg_not_wasi! </span>{ |
| <span class="kw">mod </span>blocking; |
| <span class="kw">pub use </span>blocking::spawn_blocking; |
| } |
| |
| <span class="kw">mod </span>spawn; |
| <span class="kw">pub use </span>spawn::spawn; |
| |
| <span class="macro">cfg_rt_multi_thread! </span>{ |
| <span class="kw">pub use </span>blocking::block_in_place; |
| } |
| |
| <span class="kw">mod </span>yield_now; |
| <span class="kw">pub use </span>yield_now::yield_now; |
| |
| <span class="macro">cfg_unstable! </span>{ |
| <span class="kw">mod </span>consume_budget; |
| <span class="kw">pub use </span>consume_budget::consume_budget; |
| } |
| |
| <span class="kw">mod </span>local; |
| <span class="kw">pub use </span>local::{spawn_local, LocalSet, LocalEnterGuard}; |
| |
| <span class="kw">mod </span>task_local; |
| <span class="kw">pub use </span>task_local::LocalKey; |
| |
| <span class="kw">mod </span>unconstrained; |
| <span class="kw">pub use </span>unconstrained::{unconstrained, Unconstrained}; |
| |
| <span class="attribute">#[doc(inline)] |
| </span><span class="kw">pub use </span>join_set::JoinSet; |
| <span class="kw">pub use </span><span class="kw">crate</span>::runtime::task::AbortHandle; |
| |
| <span class="comment">// Uses #[cfg(...)] instead of macro since the macro adds docsrs annotations. |
| </span><span class="attribute">#[cfg(not(tokio_unstable))] |
| </span><span class="kw">mod </span>join_set; |
| <span class="attribute">#[cfg(tokio_unstable)] |
| </span><span class="kw">pub mod </span>join_set; |
| |
| <span class="macro">cfg_unstable! </span>{ |
| <span class="kw">pub use </span><span class="kw">crate</span>::runtime::task::{Id, id, try_id}; |
| } |
| |
| <span class="macro">cfg_trace! </span>{ |
| <span class="kw">mod </span>builder; |
| <span class="kw">pub use </span>builder::Builder; |
| } |
| |
| <span class="doccomment">/// Task-related futures. |
| </span><span class="kw">pub mod </span>futures { |
| <span class="kw">pub use </span><span class="kw">super</span>::task_local::TaskLocalFuture; |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |