| <!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| </pre><pre class="rust"><code><span class="attribute">#![allow( |
| clippy::cognitive_complexity, |
| clippy::large_enum_variant, |
| clippy::module_inception, |
| clippy::needless_doctest_main, |
| clippy::declare_interior_mutable_const |
| )] |
| #![warn( |
| missing_debug_implementations, |
| missing_docs, |
| rust_2018_idioms, |
| unreachable_pub |
| )] |
| #![deny(unused_must_use)] |
| #![doc(test( |
| no_crate_inject, |
| attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables)) |
| ))] |
| #![cfg_attr(docsrs, feature(doc_cfg))] |
| #![cfg_attr(docsrs, allow(unused_attributes))] |
| #![cfg_attr(loom, allow(dead_code, unreachable_pub))] |
| |
| </span><span class="doccomment">//! A runtime for writing reliable network applications without compromising speed. |
| //! |
| //! Tokio is an event-driven, non-blocking I/O platform for writing asynchronous |
| //! applications with the Rust programming language. At a high level, it |
| //! provides a few major components: |
| //! |
| //! * Tools for [working with asynchronous tasks][tasks], including |
| //! [synchronization primitives and channels][sync] and [timeouts, sleeps, and |
| //! intervals][time]. |
| //! * APIs for [performing asynchronous I/O][io], including [TCP and UDP][net] sockets, |
| //! [filesystem][fs] operations, and [process] and [signal] management. |
| //! * A [runtime] for executing asynchronous code, including a task scheduler, |
| //! an I/O driver backed by the operating system's event queue (epoll, kqueue, |
| //! IOCP, etc...), and a high performance timer. |
| //! |
| //! Guide level documentation is found on the [website]. |
| //! |
| //! [tasks]: #working-with-tasks |
| //! [sync]: crate::sync |
| //! [time]: crate::time |
| //! [io]: #asynchronous-io |
| //! [net]: crate::net |
| //! [fs]: crate::fs |
| //! [process]: crate::process |
| //! [signal]: crate::signal |
| //! [fs]: crate::fs |
| //! [runtime]: crate::runtime |
| //! [website]: https://tokio.rs/tokio/tutorial |
| //! |
| //! # A Tour of Tokio |
| //! |
| //! Tokio consists of a number of modules that provide a range of functionality |
| //! essential for implementing asynchronous applications in Rust. In this |
| //! section, we will take a brief tour of Tokio, summarizing the major APIs and |
| //! their uses. |
| //! |
| //! The easiest way to get started is to enable all features. Do this by |
| //! enabling the `full` feature flag: |
| //! |
| //! ```toml |
| //! tokio = { version = "1", features = ["full"] } |
| //! ``` |
| //! |
| //! ### Authoring applications |
| //! |
| //! Tokio is great for writing applications and most users in this case shouldn't |
| //! worry too much about what features they should pick. If you're unsure, we suggest |
| //! going with `full` to ensure that you don't run into any road blocks while you're |
| //! building your application. |
| //! |
| //! #### Example |
| //! |
| //! This example shows the quickest way to get started with Tokio. |
| //! |
| //! ```toml |
| //! tokio = { version = "1", features = ["full"] } |
| //! ``` |
| //! |
| //! ### Authoring libraries |
| //! |
| //! As a library author your goal should be to provide the lightest weight crate |
| //! that is based on Tokio. To achieve this you should ensure that you only enable |
| //! the features you need. This allows users to pick up your crate without having |
| //! to enable unnecessary features. |
| //! |
| //! #### Example |
| //! |
| //! This example shows how you may want to import features for a library that just |
| //! needs to `tokio::spawn` and use a `TcpStream`. |
| //! |
| //! ```toml |
| //! tokio = { version = "1", features = ["rt", "net"] } |
| //! ``` |
| //! |
| //! ## Working With Tasks |
| //! |
| //! Asynchronous programs in Rust are based around lightweight, non-blocking |
| //! units of execution called [_tasks_][tasks]. The [`tokio::task`] module provides |
| //! important tools for working with tasks: |
| //! |
| //! * The [`spawn`] function and [`JoinHandle`] type, for scheduling a new task |
| //! on the Tokio runtime and awaiting the output of a spawned task, respectively, |
| //! * Functions for [running blocking operations][blocking] in an asynchronous |
| //! task context. |
| //! |
| //! The [`tokio::task`] module is present only when the "rt" feature flag |
| //! is enabled. |
| //! |
| //! [tasks]: task/index.html#what-are-tasks |
| //! [`tokio::task`]: crate::task |
| //! [`spawn`]: crate::task::spawn() |
| //! [`JoinHandle`]: crate::task::JoinHandle |
| //! [blocking]: task/index.html#blocking-and-yielding |
| //! |
| //! The [`tokio::sync`] module contains synchronization primitives to use when |
| //! needing to communicate or share data. These include: |
| //! |
| //! * channels ([`oneshot`], [`mpsc`], [`watch`], and [`broadcast`]), for sending values |
| //! between tasks, |
| //! * a non-blocking [`Mutex`], for controlling access to a shared, mutable |
| //! value, |
| //! * an asynchronous [`Barrier`] type, for multiple tasks to synchronize before |
| //! beginning a computation. |
| //! |
| //! The `tokio::sync` module is present only when the "sync" feature flag is |
| //! enabled. |
| //! |
| //! [`tokio::sync`]: crate::sync |
| //! [`Mutex`]: crate::sync::Mutex |
| //! [`Barrier`]: crate::sync::Barrier |
| //! [`oneshot`]: crate::sync::oneshot |
| //! [`mpsc`]: crate::sync::mpsc |
| //! [`watch`]: crate::sync::watch |
| //! [`broadcast`]: crate::sync::broadcast |
| //! |
| //! The [`tokio::time`] module provides utilities for tracking time and |
| //! scheduling work. This includes functions for setting [timeouts][timeout] for |
| //! tasks, [sleeping][sleep] work to run in the future, or [repeating an operation at an |
| //! interval][interval]. |
| //! |
| //! In order to use `tokio::time`, the "time" feature flag must be enabled. |
| //! |
| //! [`tokio::time`]: crate::time |
| //! [sleep]: crate::time::sleep() |
| //! [interval]: crate::time::interval() |
| //! [timeout]: crate::time::timeout() |
| //! |
| //! Finally, Tokio provides a _runtime_ for executing asynchronous tasks. Most |
| //! applications can use the [`#[tokio::main]`][main] macro to run their code on the |
| //! Tokio runtime. However, this macro provides only basic configuration options. As |
| //! an alternative, the [`tokio::runtime`] module provides more powerful APIs for configuring |
| //! and managing runtimes. You should use that module if the `#[tokio::main]` macro doesn't |
| //! provide the functionality you need. |
| //! |
| //! Using the runtime requires the "rt" or "rt-multi-thread" feature flags, to |
| //! enable the current-thread [single-threaded scheduler][rt] and the [multi-thread |
| //! scheduler][rt-multi-thread], respectively. See the [`runtime` module |
| //! documentation][rt-features] for details. In addition, the "macros" feature |
| //! flag enables the `#[tokio::main]` and `#[tokio::test]` attributes. |
| //! |
| //! [main]: attr.main.html |
| //! [`tokio::runtime`]: crate::runtime |
| //! [`Builder`]: crate::runtime::Builder |
| //! [`Runtime`]: crate::runtime::Runtime |
| //! [rt]: runtime/index.html#current-thread-scheduler |
| //! [rt-multi-thread]: runtime/index.html#multi-thread-scheduler |
| //! [rt-features]: runtime/index.html#runtime-scheduler |
| //! |
| //! ## CPU-bound tasks and blocking code |
| //! |
| //! Tokio is able to concurrently run many tasks on a few threads by repeatedly |
| //! swapping the currently running task on each thread. However, this kind of |
| //! swapping can only happen at `.await` points, so code that spends a long time |
| //! without reaching an `.await` will prevent other tasks from running. To |
| //! combat this, Tokio provides two kinds of threads: Core threads and blocking threads. |
| //! |
| //! The core threads are where all asynchronous code runs, and Tokio will by default |
| //! spawn one for each CPU core. You can use the environment variable `TOKIO_WORKER_THREADS` |
| //! to override the default value. |
| //! |
| //! The blocking threads are spawned on demand, can be used to run blocking code |
| //! that would otherwise block other tasks from running and are kept alive when |
| //! not used for a certain amount of time which can be configured with [`thread_keep_alive`]. |
| //! Since it is not possible for Tokio to swap out blocking tasks, like it |
| //! can do with asynchronous code, the upper limit on the number of blocking |
| //! threads is very large. These limits can be configured on the [`Builder`]. |
| //! |
| //! To spawn a blocking task, you should use the [`spawn_blocking`] function. |
| //! |
| //! [`Builder`]: crate::runtime::Builder |
| //! [`spawn_blocking`]: crate::task::spawn_blocking() |
| //! [`thread_keep_alive`]: crate::runtime::Builder::thread_keep_alive() |
| //! |
| //! ``` |
| //! #[tokio::main] |
| //! async fn main() { |
| //! // This is running on a core thread. |
| //! |
| //! let blocking_task = tokio::task::spawn_blocking(|| { |
| //! // This is running on a blocking thread. |
| //! // Blocking here is ok. |
| //! }); |
| //! |
| //! // We can wait for the blocking task like this: |
| //! // If the blocking task panics, the unwrap below will propagate the |
| //! // panic. |
| //! blocking_task.await.unwrap(); |
| //! } |
| //! ``` |
| //! |
| //! If your code is CPU-bound and you wish to limit the number of threads used |
| //! to run it, you should use a separate thread pool dedicated to CPU bound tasks. |
| //! For example, you could consider using the [rayon] library for CPU-bound |
| //! tasks. It is also possible to create an extra Tokio runtime dedicated to |
| //! CPU-bound tasks, but if you do this, you should be careful that the extra |
| //! runtime runs _only_ CPU-bound tasks, as IO-bound tasks on that runtime |
| //! will behave poorly. |
| //! |
| //! Hint: If using rayon, you can use a [`oneshot`] channel to send the result back |
| //! to Tokio when the rayon task finishes. |
| //! |
| //! [rayon]: https://docs.rs/rayon |
| //! [`oneshot`]: crate::sync::oneshot |
| //! |
| //! ## Asynchronous IO |
| //! |
| //! As well as scheduling and running tasks, Tokio provides everything you need |
| //! to perform input and output asynchronously. |
| //! |
| //! The [`tokio::io`] module provides Tokio's asynchronous core I/O primitives, |
| //! the [`AsyncRead`], [`AsyncWrite`], and [`AsyncBufRead`] traits. In addition, |
| //! when the "io-util" feature flag is enabled, it also provides combinators and |
| //! functions for working with these traits, forming as an asynchronous |
| //! counterpart to [`std::io`]. |
| //! |
| //! Tokio also includes APIs for performing various kinds of I/O and interacting |
| //! with the operating system asynchronously. These include: |
| //! |
| //! * [`tokio::net`], which contains non-blocking versions of [TCP], [UDP], and |
| //! [Unix Domain Sockets][UDS] (enabled by the "net" feature flag), |
| //! * [`tokio::fs`], similar to [`std::fs`] but for performing filesystem I/O |
| //! asynchronously (enabled by the "fs" feature flag), |
| //! * [`tokio::signal`], for asynchronously handling Unix and Windows OS signals |
| //! (enabled by the "signal" feature flag), |
| //! * [`tokio::process`], for spawning and managing child processes (enabled by |
| //! the "process" feature flag). |
| //! |
| //! [`tokio::io`]: crate::io |
| //! [`AsyncRead`]: crate::io::AsyncRead |
| //! [`AsyncWrite`]: crate::io::AsyncWrite |
| //! [`AsyncBufRead`]: crate::io::AsyncBufRead |
| //! [`std::io`]: std::io |
| //! [`tokio::net`]: crate::net |
| //! [TCP]: crate::net::tcp |
| //! [UDP]: crate::net::UdpSocket |
| //! [UDS]: crate::net::unix |
| //! [`tokio::fs`]: crate::fs |
| //! [`std::fs`]: std::fs |
| //! [`tokio::signal`]: crate::signal |
| //! [`tokio::process`]: crate::process |
| //! |
| //! # Examples |
| //! |
| //! A simple TCP echo server: |
| //! |
| //! ```no_run |
| //! use tokio::net::TcpListener; |
| //! use tokio::io::{AsyncReadExt, AsyncWriteExt}; |
| //! |
| //! #[tokio::main] |
| //! async fn main() -> Result<(), Box<dyn std::error::Error>> { |
| //! let listener = TcpListener::bind("127.0.0.1:8080").await?; |
| //! |
| //! loop { |
| //! let (mut socket, _) = listener.accept().await?; |
| //! |
| //! tokio::spawn(async move { |
| //! let mut buf = [0; 1024]; |
| //! |
| //! // In a loop, read data from the socket and write the data back. |
| //! loop { |
| //! let n = match socket.read(&mut buf).await { |
| //! // socket closed |
| //! Ok(n) if n == 0 => return, |
| //! Ok(n) => n, |
| //! Err(e) => { |
| //! eprintln!("failed to read from socket; err = {:?}", e); |
| //! return; |
| //! } |
| //! }; |
| //! |
| //! // Write the data back |
| //! if let Err(e) = socket.write_all(&buf[0..n]).await { |
| //! eprintln!("failed to write to socket; err = {:?}", e); |
| //! return; |
| //! } |
| //! } |
| //! }); |
| //! } |
| //! } |
| //! ``` |
| //! |
| //! ## Feature flags |
| //! |
| //! Tokio uses a set of [feature flags] to reduce the amount of compiled code. It |
| //! is possible to just enable certain features over others. By default, Tokio |
| //! does not enable any features but allows one to enable a subset for their use |
| //! case. Below is a list of the available feature flags. You may also notice |
| //! above each function, struct and trait there is listed one or more feature flags |
| //! that are required for that item to be used. If you are new to Tokio it is |
| //! recommended that you use the `full` feature flag which will enable all public APIs. |
| //! Beware though that this will pull in many extra dependencies that you may not |
| //! need. |
| //! |
| //! - `full`: Enables all features listed below except `test-util` and `tracing`. |
| //! - `rt`: Enables `tokio::spawn`, the current-thread scheduler, |
| //! and non-scheduler utilities. |
| //! - `rt-multi-thread`: Enables the heavier, multi-threaded, work-stealing scheduler. |
| //! - `io-util`: Enables the IO based `Ext` traits. |
| //! - `io-std`: Enable `Stdout`, `Stdin` and `Stderr` types. |
| //! - `net`: Enables `tokio::net` types such as `TcpStream`, `UnixStream` and |
| //! `UdpSocket`, as well as (on Unix-like systems) `AsyncFd` and (on |
| //! FreeBSD) `PollAio`. |
| //! - `time`: Enables `tokio::time` types and allows the schedulers to enable |
| //! the built in timer. |
| //! - `process`: Enables `tokio::process` types. |
| //! - `macros`: Enables `#[tokio::main]` and `#[tokio::test]` macros. |
| //! - `sync`: Enables all `tokio::sync` types. |
| //! - `signal`: Enables all `tokio::signal` types. |
| //! - `fs`: Enables `tokio::fs` types. |
| //! - `test-util`: Enables testing based infrastructure for the Tokio runtime. |
| //! - `parking_lot`: As a potential optimization, use the _parking_lot_ crate's |
| //! synchronization primitives internally. Also, this |
| //! dependency is necessary to construct some of our primitives |
| //! in a const context. MSRV may increase according to the |
| //! _parking_lot_ release in use. |
| //! |
| //! _Note: `AsyncRead` and `AsyncWrite` traits do not require any features and are |
| //! always available._ |
| //! |
| //! ### Unstable features |
| //! |
| //! Some feature flags are only available when specifying the `tokio_unstable` flag: |
| //! |
| //! - `tracing`: Enables tracing events. |
| //! |
| //! Likewise, some parts of the API are only available with the same flag: |
| //! |
| //! - [`task::Builder`] |
| //! - Some methods on [`task::JoinSet`] |
| //! - [`runtime::RuntimeMetrics`] |
| //! - [`runtime::Builder::unhandled_panic`] |
| //! - [`task::Id`] |
| //! |
| //! This flag enables **unstable** features. The public API of these features |
| //! may break in 1.x releases. To enable these features, the `--cfg |
| //! tokio_unstable` argument must be passed to `rustc` when compiling. This |
| //! serves to explicitly opt-in to features which may break semver conventions, |
| //! since Cargo [does not yet directly support such opt-ins][unstable features]. |
| //! |
| //! You can specify it in your project's `.cargo/config.toml` file: |
| //! |
| //! ```toml |
| //! [build] |
| //! rustflags = ["--cfg", "tokio_unstable"] |
| //! ``` |
| //! |
| //! Alternatively, you can specify it with an environment variable: |
| //! |
| //! ```sh |
| //! ## Many *nix shells: |
| //! export RUSTFLAGS="--cfg tokio_unstable" |
| //! cargo build |
| //! ``` |
| //! |
| //! ```powershell |
| //! ## Windows PowerShell: |
| //! $Env:RUSTFLAGS="--cfg tokio_unstable" |
| //! cargo build |
| //! ``` |
| //! |
| //! [unstable features]: https://internals.rust-lang.org/t/feature-request-unstable-opt-in-non-transitive-crate-features/16193#why-not-a-crate-feature-2 |
| //! [feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section |
| //! |
| //! ## WASM support |
| //! |
| //! Tokio has some limited support for the WASM platform. Without the |
| //! `tokio_unstable` flag, the following features are supported: |
| //! |
| //! * `sync` |
| //! * `macros` |
| //! * `io-util` |
| //! * `rt` |
| //! * `time` |
| //! |
| //! Enabling any other feature (including `full`) will cause a compilation |
| //! failure. |
| //! |
| //! The `time` module will only work on WASM platforms that have support for |
| //! timers (e.g. wasm32-wasi). The timing functions will panic if used on a WASM |
| //! platform that does not support timers. |
| //! |
| //! Note also that if the runtime becomes indefinitely idle, it will panic |
| //! immediately instead of blocking forever. On platforms that don't support |
| //! time, this means that the runtime can never be idle in any way. |
| //! |
| //! ### Unstable WASM support |
| //! |
| //! Tokio also has unstable support for some additional WASM features. This |
| //! requires the use of the `tokio_unstable` flag. |
| //! |
| //! Using this flag enables the use of `tokio::net` on the wasm32-wasi target. |
| //! However, not all methods are available on the networking types as WASI |
| //! currently does not support the creation of new sockets from within WASM. |
| //! Because of this, sockets must currently be created via the `FromRawFd` |
| //! trait. |
| |
| </span><span class="comment">// Test that pointer width is compatible. This asserts that e.g. usize is at |
| // least 32 bits, which a lot of components in Tokio currently assumes. |
| // |
| // TODO: improve once we have MSRV access to const eval to make more flexible. |
| </span><span class="attribute">#[cfg(not(any( |
| target_pointer_width = <span class="string">"32"</span>, |
| target_pointer_width = <span class="string">"64"</span>, |
| target_pointer_width = <span class="string">"128" |
| </span>)))] |
| </span><span class="macro">compile_error! </span>{ |
| <span class="string">"Tokio requires the platform pointer width to be 32, 64, or 128 bits" |
| </span>} |
| |
| <span class="comment">// Ensure that our build script has correctly set cfg flags for wasm. |
| // |
| // Each condition is written all(a, not(b)). This should be read as |
| // "if a, then we must also have b". |
| </span><span class="attribute">#[cfg(any( |
| all(target_arch = <span class="string">"wasm32"</span>, not(tokio_wasm)), |
| all(target_arch = <span class="string">"wasm64"</span>, not(tokio_wasm)), |
| all(target_family = <span class="string">"wasm"</span>, not(tokio_wasm)), |
| all(target_os = <span class="string">"wasi"</span>, not(tokio_wasm)), |
| all(target_os = <span class="string">"wasi"</span>, not(tokio_wasi)), |
| all(target_os = <span class="string">"wasi"</span>, tokio_wasm_not_wasi), |
| all(tokio_wasm, not(any(target_arch = <span class="string">"wasm32"</span>, target_arch = <span class="string">"wasm64"</span>))), |
| all(tokio_wasm_not_wasi, not(tokio_wasm)), |
| all(tokio_wasi, not(tokio_wasm)) |
| ))] |
| </span><span class="macro">compile_error!</span>(<span class="string">"Tokio's build script has incorrectly detected wasm."</span>); |
| |
| <span class="attribute">#[cfg(all( |
| not(tokio_unstable), |
| tokio_wasm, |
| any( |
| feature = <span class="string">"fs"</span>, |
| feature = <span class="string">"io-std"</span>, |
| feature = <span class="string">"net"</span>, |
| feature = <span class="string">"process"</span>, |
| feature = <span class="string">"rt-multi-thread"</span>, |
| feature = <span class="string">"signal" |
| </span>) |
| ))] |
| </span><span class="macro">compile_error!</span>(<span class="string">"Only features sync,macros,io-util,rt,time are supported on wasm."</span>); |
| |
| <span class="comment">// Includes re-exports used by macros. |
| // |
| // This module is not intended to be part of the public API. In general, any |
| // `doc(hidden)` code is not part of Tokio's public and stable API. |
| </span><span class="attribute">#[macro_use] |
| #[doc(hidden)] |
| </span><span class="kw">pub mod </span>macros; |
| |
| <span class="macro">cfg_fs! </span>{ |
| <span class="kw">pub mod </span>fs; |
| } |
| |
| <span class="kw">mod </span>future; |
| |
| <span class="kw">pub mod </span>io; |
| <span class="kw">pub mod </span>net; |
| |
| <span class="kw">mod </span>loom; |
| |
| <span class="macro">cfg_process! </span>{ |
| <span class="kw">pub mod </span>process; |
| } |
| |
| <span class="attribute">#[cfg(any( |
| feature = <span class="string">"fs"</span>, |
| feature = <span class="string">"io-std"</span>, |
| feature = <span class="string">"net"</span>, |
| all(windows, feature = <span class="string">"process"</span>), |
| ))] |
| </span><span class="kw">mod </span>blocking; |
| |
| <span class="macro">cfg_rt! </span>{ |
| <span class="kw">pub mod </span>runtime; |
| } |
| <span class="macro">cfg_not_rt! </span>{ |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>runtime; |
| } |
| |
| <span class="macro">cfg_signal! </span>{ |
| <span class="kw">pub mod </span>signal; |
| } |
| |
| <span class="macro">cfg_signal_internal! </span>{ |
| <span class="attribute">#[cfg(not(feature = <span class="string">"signal"</span>))] |
| #[allow(dead_code)] |
| #[allow(unreachable_pub)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>signal; |
| } |
| |
| <span class="macro">cfg_sync! </span>{ |
| <span class="kw">pub mod </span>sync; |
| } |
| <span class="macro">cfg_not_sync! </span>{ |
| <span class="kw">mod </span>sync; |
| } |
| |
| <span class="kw">pub mod </span>task; |
| <span class="macro">cfg_rt! </span>{ |
| <span class="kw">pub use </span>task::spawn; |
| } |
| |
| <span class="macro">cfg_time! </span>{ |
| <span class="kw">pub mod </span>time; |
| } |
| |
| <span class="kw">mod </span>util; |
| |
| <span class="doccomment">/// Due to the `Stream` trait's inclusion in `std` landing later than Tokio's 1.0 |
| /// release, most of the Tokio stream utilities have been moved into the [`tokio-stream`] |
| /// crate. |
| /// |
| /// # Why was `Stream` not included in Tokio 1.0? |
| /// |
| /// Originally, we had planned to ship Tokio 1.0 with a stable `Stream` type |
| /// but unfortunately the [RFC] had not been merged in time for `Stream` to |
| /// reach `std` on a stable compiler in time for the 1.0 release of Tokio. For |
| /// this reason, the team has decided to move all `Stream` based utilities to |
| /// the [`tokio-stream`] crate. While this is not ideal, once `Stream` has made |
| /// it into the standard library and the MSRV period has passed, we will implement |
| /// stream for our different types. |
| /// |
| /// While this may seem unfortunate, not all is lost as you can get much of the |
| /// `Stream` support with `async/await` and `while let` loops. It is also possible |
| /// to create a `impl Stream` from `async fn` using the [`async-stream`] crate. |
| /// |
| /// [`tokio-stream`]: https://docs.rs/tokio-stream |
| /// [`async-stream`]: https://docs.rs/async-stream |
| /// [RFC]: https://github.com/rust-lang/rfcs/pull/2996 |
| /// |
| /// # Example |
| /// |
| /// Convert a [`sync::mpsc::Receiver`] to an `impl Stream`. |
| /// |
| /// ```rust,no_run |
| /// use tokio::sync::mpsc; |
| /// |
| /// let (tx, mut rx) = mpsc::channel::<usize>(16); |
| /// |
| /// let stream = async_stream::stream! { |
| /// while let Some(item) = rx.recv().await { |
| /// yield item; |
| /// } |
| /// }; |
| /// ``` |
| </span><span class="kw">pub mod </span>stream {} |
| |
| <span class="comment">// local re-exports of platform specific things, allowing for decent |
| // documentation to be shimmed in on docs.rs |
| |
| </span><span class="attribute">#[cfg(docsrs)] |
| </span><span class="kw">pub mod </span>doc; |
| |
| <span class="attribute">#[cfg(docsrs)] |
| #[allow(unused)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::doc::os; |
| |
| <span class="attribute">#[cfg(not(docsrs))] |
| #[allow(unused)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>std::os; |
| |
| <span class="macro">cfg_macros! </span>{ |
| <span class="doccomment">/// Implementation detail of the `select!` macro. This macro is **not** |
| /// intended to be used as part of the public API and is permitted to |
| /// change. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub use </span>tokio_macros::select_priv_declare_output_enum; |
| |
| <span class="doccomment">/// Implementation detail of the `select!` macro. This macro is **not** |
| /// intended to be used as part of the public API and is permitted to |
| /// change. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub use </span>tokio_macros::select_priv_clean_pattern; |
| |
| <span class="macro">cfg_rt! </span>{ |
| <span class="attribute">#[cfg(feature = <span class="string">"rt-multi-thread"</span>)] |
| #[cfg(not(test))] </span><span class="comment">// Work around for rust-lang/rust#62127 |
| </span><span class="attribute">#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"macros"</span>)))] |
| #[doc(inline)] |
| </span><span class="kw">pub use </span>tokio_macros::main; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"rt-multi-thread"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"macros"</span>)))] |
| #[doc(inline)] |
| </span><span class="kw">pub use </span>tokio_macros::test; |
| |
| <span class="macro">cfg_not_rt_multi_thread! </span>{ |
| <span class="attribute">#[cfg(not(test))] </span><span class="comment">// Work around for rust-lang/rust#62127 |
| </span><span class="attribute">#[doc(inline)] |
| </span><span class="kw">pub use </span>tokio_macros::main_rt <span class="kw">as </span>main; |
| |
| <span class="attribute">#[doc(inline)] |
| </span><span class="kw">pub use </span>tokio_macros::test_rt <span class="kw">as </span>test; |
| } |
| } |
| |
| <span class="comment">// Always fail if rt is not enabled. |
| </span><span class="macro">cfg_not_rt! </span>{ |
| <span class="attribute">#[cfg(not(test))] |
| #[doc(inline)] |
| </span><span class="kw">pub use </span>tokio_macros::main_fail <span class="kw">as </span>main; |
| |
| <span class="attribute">#[doc(inline)] |
| </span><span class="kw">pub use </span>tokio_macros::test_fail <span class="kw">as </span>test; |
| } |
| } |
| |
| <span class="comment">// TODO: rm |
| </span><span class="attribute">#[cfg(feature = <span class="string">"io-util"</span>)] |
| #[cfg(test)] |
| </span><span class="kw">fn </span>is_unpin<T: Unpin>() {} |
| </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> |
