| <!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/tokio-1.28.2/src/task/join_set.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>join_set.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> |
| </pre><pre class="rust"><code><span class="doccomment">//! A collection of tasks spawned on a Tokio runtime. |
| //! |
| //! This module provides the [`JoinSet`] type, a collection which stores a set |
| //! of spawned tasks and allows asynchronously awaiting the output of those |
| //! tasks as they complete. See the documentation for the [`JoinSet`] type for |
| //! details. |
| </span><span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::future::Future; |
| <span class="kw">use </span>std::pin::Pin; |
| <span class="kw">use </span>std::task::{Context, Poll}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::runtime::Handle; |
| <span class="attribute">#[cfg(tokio_unstable)] |
| </span><span class="kw">use </span><span class="kw">crate</span>::task::Id; |
| <span class="kw">use </span><span class="kw">crate</span>::task::{AbortHandle, JoinError, JoinHandle, LocalSet}; |
| <span class="kw">use </span><span class="kw">crate</span>::util::IdleNotifiedSet; |
| |
| <span class="doccomment">/// A collection of tasks spawned on a Tokio runtime. |
| /// |
| /// A `JoinSet` can be used to await the completion of some or all of the tasks |
| /// in the set. The set is not ordered, and the tasks will be returned in the |
| /// order they complete. |
| /// |
| /// All of the tasks must have the same return type `T`. |
| /// |
| /// When the `JoinSet` is dropped, all tasks in the `JoinSet` are immediately aborted. |
| /// |
| /// # Examples |
| /// |
| /// Spawn multiple tasks and wait for them. |
| /// |
| /// ``` |
| /// use tokio::task::JoinSet; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let mut set = JoinSet::new(); |
| /// |
| /// for i in 0..10 { |
| /// set.spawn(async move { i }); |
| /// } |
| /// |
| /// let mut seen = [false; 10]; |
| /// while let Some(res) = set.join_next().await { |
| /// let idx = res.unwrap(); |
| /// seen[idx] = true; |
| /// } |
| /// |
| /// for i in 0..10 { |
| /// assert!(seen[i]); |
| /// } |
| /// } |
| /// ``` |
| </span><span class="attribute">#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"rt"</span>)))] |
| </span><span class="kw">pub struct </span>JoinSet<T> { |
| inner: IdleNotifiedSet<JoinHandle<T>>, |
| } |
| |
| <span class="doccomment">/// A variant of [`task::Builder`] that spawns tasks on a [`JoinSet`] rather |
| /// than on the current default runtime. |
| /// |
| /// [`task::Builder`]: crate::task::Builder |
| </span><span class="attribute">#[cfg(all(tokio_unstable, feature = <span class="string">"tracing"</span>))] |
| #[cfg_attr(docsrs, doc(cfg(all(tokio_unstable, feature = <span class="string">"tracing"</span>))))] |
| #[must_use = <span class="string">"builders do nothing unless used to spawn a task"</span>] |
| </span><span class="kw">pub struct </span>Builder<<span class="lifetime">'a</span>, T> { |
| joinset: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>JoinSet<T>, |
| builder: <span class="kw">super</span>::Builder<<span class="lifetime">'a</span>>, |
| } |
| |
| <span class="kw">impl</span><T> JoinSet<T> { |
| <span class="doccomment">/// Create a new `JoinSet`. |
| </span><span class="kw">pub fn </span>new() -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| inner: IdleNotifiedSet::new(), |
| } |
| } |
| |
| <span class="doccomment">/// Returns the number of tasks currently in the `JoinSet`. |
| </span><span class="kw">pub fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.inner.len() |
| } |
| |
| <span class="doccomment">/// Returns whether the `JoinSet` is empty. |
| </span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.inner.is_empty() |
| } |
| } |
| |
| <span class="kw">impl</span><T: <span class="lifetime">'static</span>> JoinSet<T> { |
| <span class="doccomment">/// Returns a [`Builder`] that can be used to configure a task prior to |
| /// spawning it on this `JoinSet`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::task::JoinSet; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> std::io::Result<()> { |
| /// let mut set = JoinSet::new(); |
| /// |
| /// // Use the builder to configure a task's name before spawning it. |
| /// set.build_task() |
| /// .name("my_task") |
| /// .spawn(async { /* ... */ })?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="attribute">#[cfg(all(tokio_unstable, feature = <span class="string">"tracing"</span>))] |
| #[cfg_attr(docsrs, doc(cfg(all(tokio_unstable, feature = <span class="string">"tracing"</span>))))] |
| </span><span class="kw">pub fn </span>build_task(<span class="kw-2">&mut </span><span class="self">self</span>) -> Builder<<span class="lifetime">'_</span>, T> { |
| Builder { |
| builder: <span class="kw">super</span>::Builder::new(), |
| joinset: <span class="self">self</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Spawn the provided task on the `JoinSet`, returning an [`AbortHandle`] |
| /// that can be used to remotely cancel the task. |
| /// |
| /// The provided future will start running in the background immediately |
| /// when this method is called, even if you don't await anything on this |
| /// `JoinSet`. |
| /// |
| /// # Panics |
| /// |
| /// This method panics if called outside of a Tokio runtime. |
| /// |
| /// [`AbortHandle`]: crate::task::AbortHandle |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn<F>(<span class="kw-2">&mut </span><span class="self">self</span>, task: F) -> AbortHandle |
| <span class="kw">where |
| </span>F: Future<Output = T>, |
| F: Send + <span class="lifetime">'static</span>, |
| T: Send, |
| { |
| <span class="self">self</span>.insert(<span class="kw">crate</span>::spawn(task)) |
| } |
| |
| <span class="doccomment">/// Spawn the provided task on the provided runtime and store it in this |
| /// `JoinSet` returning an [`AbortHandle`] that can be used to remotely |
| /// cancel the task. |
| /// |
| /// The provided future will start running in the background immediately |
| /// when this method is called, even if you don't await anything on this |
| /// `JoinSet`. |
| /// |
| /// [`AbortHandle`]: crate::task::AbortHandle |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn_on<F>(<span class="kw-2">&mut </span><span class="self">self</span>, task: F, handle: <span class="kw-2">&</span>Handle) -> AbortHandle |
| <span class="kw">where |
| </span>F: Future<Output = T>, |
| F: Send + <span class="lifetime">'static</span>, |
| T: Send, |
| { |
| <span class="self">self</span>.insert(handle.spawn(task)) |
| } |
| |
| <span class="doccomment">/// Spawn the provided task on the current [`LocalSet`] and store it in this |
| /// `JoinSet`, returning an [`AbortHandle`] that can be used to remotely |
| /// cancel the task. |
| /// |
| /// The provided future will start running in the background immediately |
| /// when this method is called, even if you don't await anything on this |
| /// `JoinSet`. |
| /// |
| /// # Panics |
| /// |
| /// This method panics if it is called outside of a `LocalSet`. |
| /// |
| /// [`LocalSet`]: crate::task::LocalSet |
| /// [`AbortHandle`]: crate::task::AbortHandle |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn_local<F>(<span class="kw-2">&mut </span><span class="self">self</span>, task: F) -> AbortHandle |
| <span class="kw">where |
| </span>F: Future<Output = T>, |
| F: <span class="lifetime">'static</span>, |
| { |
| <span class="self">self</span>.insert(<span class="kw">crate</span>::task::spawn_local(task)) |
| } |
| |
| <span class="doccomment">/// Spawn the provided task on the provided [`LocalSet`] and store it in |
| /// this `JoinSet`, returning an [`AbortHandle`] that can be used to |
| /// remotely cancel the task. |
| /// |
| /// Unlike the [`spawn_local`] method, this method may be used to spawn local |
| /// tasks on a `LocalSet` that is _not_ currently running. The provided |
| /// future will start running whenever the `LocalSet` is next started. |
| /// |
| /// [`LocalSet`]: crate::task::LocalSet |
| /// [`AbortHandle`]: crate::task::AbortHandle |
| /// [`spawn_local`]: Self::spawn_local |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn_local_on<F>(<span class="kw-2">&mut </span><span class="self">self</span>, task: F, local_set: <span class="kw-2">&</span>LocalSet) -> AbortHandle |
| <span class="kw">where |
| </span>F: Future<Output = T>, |
| F: <span class="lifetime">'static</span>, |
| { |
| <span class="self">self</span>.insert(local_set.spawn_local(task)) |
| } |
| |
| <span class="doccomment">/// Spawn the blocking code on the blocking threadpool and store |
| /// it in this `JoinSet`, returning an [`AbortHandle`] that can be |
| /// used to remotely cancel the task. |
| /// |
| /// # Examples |
| /// |
| /// Spawn multiple blocking tasks and wait for them. |
| /// |
| /// ``` |
| /// use tokio::task::JoinSet; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let mut set = JoinSet::new(); |
| /// |
| /// for i in 0..10 { |
| /// set.spawn_blocking(move || { i }); |
| /// } |
| /// |
| /// let mut seen = [false; 10]; |
| /// while let Some(res) = set.join_next().await { |
| /// let idx = res.unwrap(); |
| /// seen[idx] = true; |
| /// } |
| /// |
| /// for i in 0..10 { |
| /// assert!(seen[i]); |
| /// } |
| /// } |
| /// ``` |
| /// |
| /// # Panics |
| /// |
| /// This method panics if called outside of a Tokio runtime. |
| /// |
| /// [`AbortHandle`]: crate::task::AbortHandle |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn_blocking<F>(<span class="kw-2">&mut </span><span class="self">self</span>, f: F) -> AbortHandle |
| <span class="kw">where |
| </span>F: FnOnce() -> T, |
| F: Send + <span class="lifetime">'static</span>, |
| T: Send, |
| { |
| <span class="self">self</span>.insert(<span class="kw">crate</span>::runtime::spawn_blocking(f)) |
| } |
| |
| <span class="doccomment">/// Spawn the blocking code on the blocking threadpool of the |
| /// provided runtime and store it in this `JoinSet`, returning an |
| /// [`AbortHandle`] that can be used to remotely cancel the task. |
| /// |
| /// [`AbortHandle`]: crate::task::AbortHandle |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn_blocking_on<F>(<span class="kw-2">&mut </span><span class="self">self</span>, f: F, handle: <span class="kw-2">&</span>Handle) -> AbortHandle |
| <span class="kw">where |
| </span>F: FnOnce() -> T, |
| F: Send + <span class="lifetime">'static</span>, |
| T: Send, |
| { |
| <span class="self">self</span>.insert(handle.spawn_blocking(f)) |
| } |
| |
| <span class="kw">fn </span>insert(<span class="kw-2">&mut </span><span class="self">self</span>, jh: JoinHandle<T>) -> AbortHandle { |
| <span class="kw">let </span>abort = jh.abort_handle(); |
| <span class="kw">let </span><span class="kw-2">mut </span>entry = <span class="self">self</span>.inner.insert_idle(jh); |
| |
| <span class="comment">// Set the waker that is notified when the task completes. |
| </span>entry.with_value_and_context(|jh, ctx| jh.set_join_waker(ctx.waker())); |
| abort |
| } |
| |
| <span class="doccomment">/// Waits until one of the tasks in the set completes and returns its output. |
| /// |
| /// Returns `None` if the set is empty. |
| /// |
| /// # Cancel Safety |
| /// |
| /// This method is cancel safe. If `join_next` is used as the event in a `tokio::select!` |
| /// statement and some other branch completes first, it is guaranteed that no tasks were |
| /// removed from this `JoinSet`. |
| </span><span class="kw">pub async fn </span>join_next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><T, JoinError>> { |
| <span class="kw">crate</span>::future::poll_fn(|cx| <span class="self">self</span>.poll_join_next(cx)).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Waits until one of the tasks in the set completes and returns its |
| /// output, along with the [task ID] of the completed task. |
| /// |
| /// Returns `None` if the set is empty. |
| /// |
| /// When this method returns an error, then the id of the task that failed can be accessed |
| /// using the [`JoinError::id`] method. |
| /// |
| /// # Cancel Safety |
| /// |
| /// This method is cancel safe. If `join_next_with_id` is used as the event in a `tokio::select!` |
| /// statement and some other branch completes first, it is guaranteed that no tasks were |
| /// removed from this `JoinSet`. |
| /// |
| /// [task ID]: crate::task::Id |
| /// [`JoinError::id`]: fn@crate::task::JoinError::id |
| </span><span class="attribute">#[cfg(tokio_unstable)] |
| #[cfg_attr(docsrs, doc(cfg(tokio_unstable)))] |
| </span><span class="kw">pub async fn </span>join_next_with_id(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><(Id, T), JoinError>> { |
| <span class="kw">crate</span>::future::poll_fn(|cx| <span class="self">self</span>.poll_join_next_with_id(cx)).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Aborts all tasks and waits for them to finish shutting down. |
| /// |
| /// Calling this method is equivalent to calling [`abort_all`] and then calling [`join_next`] in |
| /// a loop until it returns `None`. |
| /// |
| /// This method ignores any panics in the tasks shutting down. When this call returns, the |
| /// `JoinSet` will be empty. |
| /// |
| /// [`abort_all`]: fn@Self::abort_all |
| /// [`join_next`]: fn@Self::join_next |
| </span><span class="kw">pub async fn </span>shutdown(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.abort_all(); |
| <span class="kw">while </span><span class="self">self</span>.join_next().<span class="kw">await</span>.is_some() {} |
| } |
| |
| <span class="doccomment">/// Aborts all tasks on this `JoinSet`. |
| /// |
| /// This does not remove the tasks from the `JoinSet`. To wait for the tasks to complete |
| /// cancellation, you should call `join_next` in a loop until the `JoinSet` is empty. |
| </span><span class="kw">pub fn </span>abort_all(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.inner.for_each(|jh| jh.abort()); |
| } |
| |
| <span class="doccomment">/// Removes all tasks from this `JoinSet` without aborting them. |
| /// |
| /// The tasks removed by this call will continue to run in the background even if the `JoinSet` |
| /// is dropped. |
| </span><span class="kw">pub fn </span>detach_all(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.inner.drain(drop); |
| } |
| |
| <span class="doccomment">/// Polls for one of the tasks in the set to complete. |
| /// |
| /// If this returns `Poll::Ready(Some(_))`, then the task that completed is removed from the set. |
| /// |
| /// When the method returns `Poll::Pending`, the `Waker` in the provided `Context` is scheduled |
| /// to receive a wakeup when a task in the `JoinSet` completes. Note that on multiple calls to |
| /// `poll_join_next`, only the `Waker` from the `Context` passed to the most recent call is |
| /// scheduled to receive a wakeup. |
| /// |
| /// # Returns |
| /// |
| /// This function returns: |
| /// |
| /// * `Poll::Pending` if the `JoinSet` is not empty but there is no task whose output is |
| /// available right now. |
| /// * `Poll::Ready(Some(Ok(value)))` if one of the tasks in this `JoinSet` has completed. |
| /// The `value` is the return value of one of the tasks that completed. |
| /// * `Poll::Ready(Some(Err(err)))` if one of the tasks in this `JoinSet` has panicked or been |
| /// aborted. The `err` is the `JoinError` from the panicked/aborted task. |
| /// * `Poll::Ready(None)` if the `JoinSet` is empty. |
| /// |
| /// Note that this method may return `Poll::Pending` even if one of the tasks has completed. |
| /// This can happen if the [coop budget] is reached. |
| /// |
| /// [coop budget]: crate::task#cooperative-scheduling |
| </span><span class="kw">fn </span>poll_join_next(<span class="kw-2">&mut </span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><T, JoinError>>> { |
| <span class="comment">// The call to `pop_notified` moves the entry to the `idle` list. It is moved back to |
| // the `notified` list if the waker is notified in the `poll` call below. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>entry = <span class="kw">match </span><span class="self">self</span>.inner.pop_notified(cx.waker()) { |
| <span class="prelude-val">Some</span>(entry) => entry, |
| <span class="prelude-val">None </span>=> { |
| <span class="kw">if </span><span class="self">self</span>.is_empty() { |
| <span class="kw">return </span>Poll::Ready(<span class="prelude-val">None</span>); |
| } <span class="kw">else </span>{ |
| <span class="comment">// The waker was set by `pop_notified`. |
| </span><span class="kw">return </span>Poll::Pending; |
| } |
| } |
| }; |
| |
| <span class="kw">let </span>res = entry.with_value_and_context(|jh, ctx| Pin::new(jh).poll(ctx)); |
| |
| <span class="kw">if let </span>Poll::Ready(res) = res { |
| <span class="kw">let </span>_entry = entry.remove(); |
| Poll::Ready(<span class="prelude-val">Some</span>(res)) |
| } <span class="kw">else </span>{ |
| <span class="comment">// A JoinHandle generally won't emit a wakeup without being ready unless |
| // the coop limit has been reached. We yield to the executor in this |
| // case. |
| </span>cx.waker().wake_by_ref(); |
| Poll::Pending |
| } |
| } |
| |
| <span class="doccomment">/// Polls for one of the tasks in the set to complete. |
| /// |
| /// If this returns `Poll::Ready(Some(_))`, then the task that completed is removed from the set. |
| /// |
| /// When the method returns `Poll::Pending`, the `Waker` in the provided `Context` is scheduled |
| /// to receive a wakeup when a task in the `JoinSet` completes. Note that on multiple calls to |
| /// `poll_join_next`, only the `Waker` from the `Context` passed to the most recent call is |
| /// scheduled to receive a wakeup. |
| /// |
| /// # Returns |
| /// |
| /// This function returns: |
| /// |
| /// * `Poll::Pending` if the `JoinSet` is not empty but there is no task whose output is |
| /// available right now. |
| /// * `Poll::Ready(Some(Ok((id, value))))` if one of the tasks in this `JoinSet` has completed. |
| /// The `value` is the return value of one of the tasks that completed, and |
| /// `id` is the [task ID] of that task. |
| /// * `Poll::Ready(Some(Err(err)))` if one of the tasks in this `JoinSet` has panicked or been |
| /// aborted. The `err` is the `JoinError` from the panicked/aborted task. |
| /// * `Poll::Ready(None)` if the `JoinSet` is empty. |
| /// |
| /// Note that this method may return `Poll::Pending` even if one of the tasks has completed. |
| /// This can happen if the [coop budget] is reached. |
| /// |
| /// [coop budget]: crate::task#cooperative-scheduling |
| /// [task ID]: crate::task::Id |
| </span><span class="attribute">#[cfg(tokio_unstable)] |
| </span><span class="kw">fn </span>poll_join_next_with_id( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<<span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><(Id, T), JoinError>>> { |
| <span class="comment">// The call to `pop_notified` moves the entry to the `idle` list. It is moved back to |
| // the `notified` list if the waker is notified in the `poll` call below. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>entry = <span class="kw">match </span><span class="self">self</span>.inner.pop_notified(cx.waker()) { |
| <span class="prelude-val">Some</span>(entry) => entry, |
| <span class="prelude-val">None </span>=> { |
| <span class="kw">if </span><span class="self">self</span>.is_empty() { |
| <span class="kw">return </span>Poll::Ready(<span class="prelude-val">None</span>); |
| } <span class="kw">else </span>{ |
| <span class="comment">// The waker was set by `pop_notified`. |
| </span><span class="kw">return </span>Poll::Pending; |
| } |
| } |
| }; |
| |
| <span class="kw">let </span>res = entry.with_value_and_context(|jh, ctx| Pin::new(jh).poll(ctx)); |
| |
| <span class="kw">if let </span>Poll::Ready(res) = res { |
| <span class="kw">let </span>entry = entry.remove(); |
| <span class="comment">// If the task succeeded, add the task ID to the output. Otherwise, the |
| // `JoinError` will already have the task's ID. |
| </span>Poll::Ready(<span class="prelude-val">Some</span>(res.map(|output| (entry.id(), output)))) |
| } <span class="kw">else </span>{ |
| <span class="comment">// A JoinHandle generally won't emit a wakeup without being ready unless |
| // the coop limit has been reached. We yield to the executor in this |
| // case. |
| </span>cx.waker().wake_by_ref(); |
| Poll::Pending |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> Drop <span class="kw">for </span>JoinSet<T> { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.inner.drain(|join_handle| join_handle.abort()); |
| } |
| } |
| |
| <span class="kw">impl</span><T> fmt::Debug <span class="kw">for </span>JoinSet<T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| f.debug_struct(<span class="string">"JoinSet"</span>).field(<span class="string">"len"</span>, <span class="kw-2">&</span><span class="self">self</span>.len()).finish() |
| } |
| } |
| |
| <span class="kw">impl</span><T> Default <span class="kw">for </span>JoinSet<T> { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::new() |
| } |
| } |
| |
| <span class="comment">// === impl Builder === |
| |
| </span><span class="attribute">#[cfg(all(tokio_unstable, feature = <span class="string">"tracing"</span>))] |
| #[cfg_attr(docsrs, doc(cfg(all(tokio_unstable, feature = <span class="string">"tracing"</span>))))] |
| </span><span class="kw">impl</span><<span class="lifetime">'a</span>, T: <span class="lifetime">'static</span>> Builder<<span class="lifetime">'a</span>, T> { |
| <span class="doccomment">/// Assigns a name to the task which will be spawned. |
| </span><span class="kw">pub fn </span>name(<span class="self">self</span>, name: <span class="kw-2">&</span><span class="lifetime">'a </span>str) -> <span class="self">Self </span>{ |
| <span class="kw">let </span>builder = <span class="self">self</span>.builder.name(name); |
| <span class="self">Self </span>{ builder, ..<span class="self">self </span>} |
| } |
| |
| <span class="doccomment">/// Spawn the provided task with this builder's settings and store it in the |
| /// [`JoinSet`], returning an [`AbortHandle`] that can be used to remotely |
| /// cancel the task. |
| /// |
| /// # Returns |
| /// |
| /// An [`AbortHandle`] that can be used to remotely cancel the task. |
| /// |
| /// # Panics |
| /// |
| /// This method panics if called outside of a Tokio runtime. |
| /// |
| /// [`AbortHandle`]: crate::task::AbortHandle |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn<F>(<span class="self">self</span>, future: F) -> std::io::Result<AbortHandle> |
| <span class="kw">where |
| </span>F: Future<Output = T>, |
| F: Send + <span class="lifetime">'static</span>, |
| T: Send, |
| { |
| <span class="prelude-val">Ok</span>(<span class="self">self</span>.joinset.insert(<span class="self">self</span>.builder.spawn(future)<span class="question-mark">?</span>)) |
| } |
| |
| <span class="doccomment">/// Spawn the provided task on the provided [runtime handle] with this |
| /// builder's settings, and store it in the [`JoinSet`]. |
| /// |
| /// # Returns |
| /// |
| /// An [`AbortHandle`] that can be used to remotely cancel the task. |
| /// |
| /// |
| /// [`AbortHandle`]: crate::task::AbortHandle |
| /// [runtime handle]: crate::runtime::Handle |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn_on<F>(<span class="self">self</span>, future: F, handle: <span class="kw-2">&</span>Handle) -> std::io::Result<AbortHandle> |
| <span class="kw">where |
| </span>F: Future<Output = T>, |
| F: Send + <span class="lifetime">'static</span>, |
| T: Send, |
| { |
| <span class="prelude-val">Ok</span>(<span class="self">self</span>.joinset.insert(<span class="self">self</span>.builder.spawn_on(future, handle)<span class="question-mark">?</span>)) |
| } |
| |
| <span class="doccomment">/// Spawn the provided task on the current [`LocalSet`] with this builder's |
| /// settings, and store it in the [`JoinSet`]. |
| /// |
| /// # Returns |
| /// |
| /// An [`AbortHandle`] that can be used to remotely cancel the task. |
| /// |
| /// # Panics |
| /// |
| /// This method panics if it is called outside of a `LocalSet`. |
| /// |
| /// [`LocalSet`]: crate::task::LocalSet |
| /// [`AbortHandle`]: crate::task::AbortHandle |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn_local<F>(<span class="self">self</span>, future: F) -> std::io::Result<AbortHandle> |
| <span class="kw">where |
| </span>F: Future<Output = T>, |
| F: <span class="lifetime">'static</span>, |
| { |
| <span class="prelude-val">Ok</span>(<span class="self">self</span>.joinset.insert(<span class="self">self</span>.builder.spawn_local(future)<span class="question-mark">?</span>)) |
| } |
| |
| <span class="doccomment">/// Spawn the provided task on the provided [`LocalSet`] with this builder's |
| /// settings, and store it in the [`JoinSet`]. |
| /// |
| /// # Returns |
| /// |
| /// An [`AbortHandle`] that can be used to remotely cancel the task. |
| /// |
| /// [`LocalSet`]: crate::task::LocalSet |
| /// [`AbortHandle`]: crate::task::AbortHandle |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn_local_on<F>(<span class="self">self</span>, future: F, local_set: <span class="kw-2">&</span>LocalSet) -> std::io::Result<AbortHandle> |
| <span class="kw">where |
| </span>F: Future<Output = T>, |
| F: <span class="lifetime">'static</span>, |
| { |
| <span class="prelude-val">Ok</span>(<span class="self">self |
| </span>.joinset |
| .insert(<span class="self">self</span>.builder.spawn_local_on(future, local_set)<span class="question-mark">?</span>)) |
| } |
| } |
| |
| <span class="comment">// Manual `Debug` impl so that `Builder` is `Debug` regardless of whether `T` is |
| // `Debug`. |
| </span><span class="attribute">#[cfg(all(tokio_unstable, feature = <span class="string">"tracing"</span>))] |
| #[cfg_attr(docsrs, doc(cfg(all(tokio_unstable, feature = <span class="string">"tracing"</span>))))] |
| </span><span class="kw">impl</span><<span class="lifetime">'a</span>, T> fmt::Debug <span class="kw">for </span>Builder<<span class="lifetime">'a</span>, T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| f.debug_struct(<span class="string">"join_set::Builder"</span>) |
| .field(<span class="string">"joinset"</span>, <span class="kw-2">&</span><span class="self">self</span>.joinset) |
| .field(<span class="string">"builder"</span>, <span class="kw-2">&</span><span class="self">self</span>.builder) |
| .finish() |
| } |
| } |
| </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> |
