<!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 `/home/sangenya/.cargo/registry/src/github.com-1ecc6299db9ec823/rayon-core-1.9.1/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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"><div class="sidebar-menu" role="button">☰</div><a href='../../rayon_core/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><pre class="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>
<span id="634">634</span>
<span id="635">635</span>
<span id="636">636</span>
<span id="637">637</span>
<span id="638">638</span>
<span id="639">639</span>
<span id="640">640</span>
<span id="641">641</span>
<span id="642">642</span>
<span id="643">643</span>
<span id="644">644</span>
<span id="645">645</span>
<span id="646">646</span>
<span id="647">647</span>
<span id="648">648</span>
<span id="649">649</span>
<span id="650">650</span>
<span id="651">651</span>
<span id="652">652</span>
<span id="653">653</span>
<span id="654">654</span>
<span id="655">655</span>
<span id="656">656</span>
<span id="657">657</span>
<span id="658">658</span>
<span id="659">659</span>
<span id="660">660</span>
<span id="661">661</span>
<span id="662">662</span>
<span id="663">663</span>
<span id="664">664</span>
<span id="665">665</span>
<span id="666">666</span>
<span id="667">667</span>
<span id="668">668</span>
<span id="669">669</span>
<span id="670">670</span>
<span id="671">671</span>
<span id="672">672</span>
<span id="673">673</span>
<span id="674">674</span>
<span id="675">675</span>
<span id="676">676</span>
<span id="677">677</span>
<span id="678">678</span>
<span id="679">679</span>
<span id="680">680</span>
<span id="681">681</span>
<span id="682">682</span>
<span id="683">683</span>
<span id="684">684</span>
<span id="685">685</span>
<span id="686">686</span>
<span id="687">687</span>
<span id="688">688</span>
<span id="689">689</span>
<span id="690">690</span>
<span id="691">691</span>
<span id="692">692</span>
<span id="693">693</span>
<span id="694">694</span>
<span id="695">695</span>
<span id="696">696</span>
<span id="697">697</span>
<span id="698">698</span>
<span id="699">699</span>
<span id="700">700</span>
<span id="701">701</span>
<span id="702">702</span>
<span id="703">703</span>
<span id="704">704</span>
<span id="705">705</span>
<span id="706">706</span>
<span id="707">707</span>
<span id="708">708</span>
<span id="709">709</span>
<span id="710">710</span>
<span id="711">711</span>
<span id="712">712</span>
<span id="713">713</span>
<span id="714">714</span>
<span id="715">715</span>
<span id="716">716</span>
<span id="717">717</span>
<span id="718">718</span>
<span id="719">719</span>
<span id="720">720</span>
<span id="721">721</span>
<span id="722">722</span>
<span id="723">723</span>
<span id="724">724</span>
<span id="725">725</span>
<span id="726">726</span>
<span id="727">727</span>
<span id="728">728</span>
<span id="729">729</span>
<span id="730">730</span>
<span id="731">731</span>
<span id="732">732</span>
<span id="733">733</span>
<span id="734">734</span>
<span id="735">735</span>
<span id="736">736</span>
<span id="737">737</span>
<span id="738">738</span>
<span id="739">739</span>
<span id="740">740</span>
<span id="741">741</span>
<span id="742">742</span>
<span id="743">743</span>
<span id="744">744</span>
<span id="745">745</span>
<span id="746">746</span>
<span id="747">747</span>
<span id="748">748</span>
<span id="749">749</span>
<span id="750">750</span>
<span id="751">751</span>
<span id="752">752</span>
<span id="753">753</span>
<span id="754">754</span>
<span id="755">755</span>
<span id="756">756</span>
<span id="757">757</span>
<span id="758">758</span>
<span id="759">759</span>
<span id="760">760</span>
<span id="761">761</span>
<span id="762">762</span>
<span id="763">763</span>
<span id="764">764</span>
<span id="765">765</span>
<span id="766">766</span>
<span id="767">767</span>
<span id="768">768</span>
<span id="769">769</span>
<span id="770">770</span>
<span id="771">771</span>
<span id="772">772</span>
<span id="773">773</span>
<span id="774">774</span>
<span id="775">775</span>
<span id="776">776</span>
<span id="777">777</span>
<span id="778">778</span>
<span id="779">779</span>
<span id="780">780</span>
<span id="781">781</span>
<span id="782">782</span>
</pre><pre class="rust">
<span class="doccomment">//! Rayon-core houses the core stable APIs of Rayon.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! These APIs have been mirrored in the Rayon crate and it is recommended to use these from there.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [`join`] is used to take two closures and potentially run them in parallel.</span>
<span class="doccomment">//! - It will run in parallel if task B gets stolen before task A can finish.</span>
<span class="doccomment">//! - It will run sequentially if task A finishes before task B is stolen and can continue on task B.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [`scope`] creates a scope in which you can run any number of parallel tasks.</span>
<span class="doccomment">//! These tasks can spawn nested tasks and scopes, but given the nature of work stealing, the order of execution can not be guaranteed.</span>
<span class="doccomment">//! The scope will exist until all tasks spawned within the scope have been completed.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [`spawn`] add a task into the 'static' or 'global' scope, or a local scope created by the [`scope()`] function.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [`ThreadPool`] can be used to create your own thread pools (using [`ThreadPoolBuilder`]) or to customize the global one.</span>
<span class="doccomment">//! Tasks spawned within the pool (using [`install()`], [`join()`], etc.) will be added to a deque,</span>
<span class="doccomment">//! where it becomes available for work stealing from other threads in the local threadpool.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [`join`]: fn.join.html</span>
<span class="doccomment">//! [`scope`]: fn.scope.html</span>
<span class="doccomment">//! [`scope()`]: fn.scope.html</span>
<span class="doccomment">//! [`spawn`]: fn.spawn.html</span>
<span class="doccomment">//! [`ThreadPool`]: struct.threadpool.html</span>
<span class="doccomment">//! [`install()`]: struct.ThreadPool.html#method.install</span>
<span class="doccomment">//! [`spawn()`]: struct.ThreadPool.html#method.spawn</span>
<span class="doccomment">//! [`join()`]: struct.ThreadPool.html#method.join</span>
<span class="doccomment">//! [`ThreadPoolBuilder`]: struct.ThreadPoolBuilder.html</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Restricting multiple versions</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! In order to ensure proper coordination between threadpools, and especially</span>
<span class="doccomment">//! to make sure there's only one global threadpool, `rayon-core` is actively</span>
<span class="doccomment">//! restricted from building multiple versions of itself into a single target.</span>
<span class="doccomment">//! You may see a build error like this in violation:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```text</span>
<span class="doccomment">//! error: native library `rayon-core` is being linked to by more</span>
<span class="doccomment">//! than one package, and can only be linked to by one package</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! While we strive to keep `rayon-core` semver-compatible, it's still</span>
<span class="doccomment">//! possible to arrive at this situation if different crates have overly</span>
<span class="doccomment">//! restrictive tilde or inequality requirements for `rayon-core`. The</span>
<span class="doccomment">//! conflicting requirements will need to be resolved before the build will</span>
<span class="doccomment">//! succeed.</span>
<span class="attribute">#![<span class="ident">doc</span>(<span class="ident">html_root_url</span> <span class="op">=</span> <span class="string">"https://docs.rs/rayon-core/1.9"</span>)]</span>
<span class="attribute">#![<span class="ident">deny</span>(<span class="ident">missing_debug_implementations</span>)]</span>
<span class="attribute">#![<span class="ident">deny</span>(<span class="ident">missing_docs</span>)]</span>
<span class="attribute">#![<span class="ident">deny</span>(<span class="ident">unreachable_pub</span>)]</span>
<span class="attribute">#![<span class="ident">warn</span>(<span class="ident">rust_2018_idioms</span>)]</span>
<span class="kw">use</span> <span class="ident">std::any::Any</span>;
<span class="kw">use</span> <span class="ident">std::env</span>;
<span class="kw">use</span> <span class="ident">std::error::Error</span>;
<span class="kw">use</span> <span class="ident">std::fmt</span>;
<span class="kw">use</span> <span class="ident">std::io</span>;
<span class="kw">use</span> <span class="ident">std::marker::PhantomData</span>;
<span class="kw">use</span> <span class="ident">std::str::FromStr</span>;
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">mod</span> <span class="ident">log</span>;
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">mod</span> <span class="ident">private</span>;
<span class="kw">mod</span> <span class="ident">job</span>;
<span class="kw">mod</span> <span class="ident">join</span>;
<span class="kw">mod</span> <span class="ident">latch</span>;
<span class="kw">mod</span> <span class="ident">registry</span>;
<span class="kw">mod</span> <span class="ident">scope</span>;
<span class="kw">mod</span> <span class="ident">sleep</span>;
<span class="kw">mod</span> <span class="ident">spawn</span>;
<span class="kw">mod</span> <span class="ident">thread_pool</span>;
<span class="kw">mod</span> <span class="ident">unwind</span>;
<span class="kw">mod</span> <span class="ident">compile_fail</span>;
<span class="kw">mod</span> <span class="ident">test</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span><span class="ident">::join</span>::{<span class="ident">join</span>, <span class="ident">join_context</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span><span class="ident">::registry::ThreadBuilder</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span><span class="ident">::scope</span>::{<span class="ident">in_place_scope</span>, <span class="ident">scope</span>, <span class="ident">Scope</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span><span class="ident">::scope</span>::{<span class="ident">in_place_scope_fifo</span>, <span class="ident">scope_fifo</span>, <span class="ident">ScopeFifo</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span><span class="ident">::spawn</span>::{<span class="ident">spawn</span>, <span class="ident">spawn_fifo</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span><span class="ident">::thread_pool::current_thread_has_pending_tasks</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span><span class="ident">::thread_pool::current_thread_index</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span><span class="ident">::thread_pool::ThreadPool</span>;
<span class="kw">use</span> <span class="self">self</span><span class="ident">::registry</span>::{<span class="ident">CustomSpawn</span>, <span class="ident">DefaultSpawn</span>, <span class="ident">ThreadSpawn</span>};
<span class="doccomment">/// Returns the number of threads in the current registry. If this</span>
<span class="doccomment">/// code is executing within a Rayon thread-pool, then this will be</span>
<span class="doccomment">/// the number of threads for the thread-pool of the current</span>
<span class="doccomment">/// thread. Otherwise, it will be the number of threads for the global</span>
<span class="doccomment">/// thread-pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This can be useful when trying to judge how many times to split</span>
<span class="doccomment">/// parallel work (the parallel iterator traits use this value</span>
<span class="doccomment">/// internally for this purpose).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Future compatibility note</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that unless this thread-pool was created with a</span>
<span class="doccomment">/// builder that specifies the number of threads, then this</span>
<span class="doccomment">/// number may vary over time in future versions (see [the</span>
<span class="doccomment">/// `num_threads()` method for details][snt]).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [snt]: struct.ThreadPoolBuilder.html#method.num_threads</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">current_num_threads</span>() <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="kw">crate</span><span class="ident">::registry::Registry::current_num_threads</span>()
}
<span class="doccomment">/// Error when initializing a thread pool.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ThreadPoolBuildError</span> {
<span class="ident">kind</span>: <span class="ident">ErrorKind</span>,
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">enum</span> <span class="ident">ErrorKind</span> {
<span class="ident">GlobalPoolAlreadyInitialized</span>,
<span class="ident">IOError</span>(<span class="ident">io::Error</span>),
}
<span class="doccomment">/// Used to create a new [`ThreadPool`] or to configure the global rayon thread pool.</span>
<span class="doccomment">/// ## Creating a ThreadPool</span>
<span class="doccomment">/// The following creates a thread pool with 22 threads.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # use rayon_core as rayon;</span>
<span class="doccomment">/// let pool = rayon::ThreadPoolBuilder::new().num_threads(22).build().unwrap();</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// To instead configure the global thread pool, use [`build_global()`]:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # use rayon_core as rayon;</span>
<span class="doccomment">/// rayon::ThreadPoolBuilder::new().num_threads(22).build_global().unwrap();</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`ThreadPool`]: struct.ThreadPool.html</span>
<span class="doccomment">/// [`build_global()`]: struct.ThreadPoolBuilder.html#method.build_global</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ThreadPoolBuilder</span><span class="op"><</span><span class="ident">S</span> <span class="op">=</span> <span class="ident">DefaultSpawn</span><span class="op">></span> {
<span class="doccomment">/// The number of threads in the rayon thread pool.</span>
<span class="doccomment">/// If zero will use the RAYON_NUM_THREADS environment variable.</span>
<span class="doccomment">/// If RAYON_NUM_THREADS is invalid or zero will use the default.</span>
<span class="ident">num_threads</span>: <span class="ident">usize</span>,
<span class="doccomment">/// Custom closure, if any, to handle a panic that we cannot propagate</span>
<span class="doccomment">/// anywhere else.</span>
<span class="ident">panic_handler</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Box</span><span class="op"><</span><span class="ident">PanicHandler</span><span class="op">></span><span class="op">></span>,
<span class="doccomment">/// Closure to compute the name of a thread.</span>
<span class="ident">get_thread_name</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">FnMut</span>(<span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span><span class="op">></span><span class="op">></span>,
<span class="doccomment">/// The stack size for the created worker threads</span>
<span class="ident">stack_size</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>,
<span class="doccomment">/// Closure invoked on worker thread start.</span>
<span class="ident">start_handler</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Box</span><span class="op"><</span><span class="ident">StartHandler</span><span class="op">></span><span class="op">></span>,
<span class="doccomment">/// Closure invoked on worker thread exit.</span>
<span class="ident">exit_handler</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Box</span><span class="op"><</span><span class="ident">ExitHandler</span><span class="op">></span><span class="op">></span>,
<span class="doccomment">/// Closure invoked to spawn threads.</span>
<span class="ident">spawn_handler</span>: <span class="ident">S</span>,
<span class="doccomment">/// If false, worker threads will execute spawned jobs in a</span>
<span class="doccomment">/// "depth-first" fashion. If true, they will do a "breadth-first"</span>
<span class="doccomment">/// fashion. Depth-first is the default.</span>
<span class="ident">breadth_first</span>: <span class="ident">bool</span>,
}
<span class="doccomment">/// Contains the rayon thread pool configuration. Use [`ThreadPoolBuilder`] instead.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`ThreadPoolBuilder`]: struct.ThreadPoolBuilder.html</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">note</span> <span class="op">=</span> <span class="string">"Use `ThreadPoolBuilder`"</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Configuration</span> {
<span class="ident">builder</span>: <span class="ident">ThreadPoolBuilder</span>,
}
<span class="doccomment">/// The type for a panic handling closure. Note that this same closure</span>
<span class="doccomment">/// may be invoked multiple times in parallel.</span>
<span class="kw">type</span> <span class="ident">PanicHandler</span> <span class="op">=</span> <span class="kw">dyn</span> <span class="ident">Fn</span>(<span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Any</span> <span class="op">+</span> <span class="ident">Send</span><span class="op">></span>) <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span>;
<span class="doccomment">/// The type for a closure that gets invoked when a thread starts. The</span>
<span class="doccomment">/// closure is passed the index of the thread on which it is invoked.</span>
<span class="doccomment">/// Note that this same closure may be invoked multiple times in parallel.</span>
<span class="kw">type</span> <span class="ident">StartHandler</span> <span class="op">=</span> <span class="kw">dyn</span> <span class="ident">Fn</span>(<span class="ident">usize</span>) <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span>;
<span class="doccomment">/// The type for a closure that gets invoked when a thread exits. The</span>
<span class="doccomment">/// closure is passed the index of the thread on which is is invoked.</span>
<span class="doccomment">/// Note that this same closure may be invoked multiple times in parallel.</span>
<span class="kw">type</span> <span class="ident">ExitHandler</span> <span class="op">=</span> <span class="kw">dyn</span> <span class="ident">Fn</span>(<span class="ident">usize</span>) <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span>;
<span class="comment">// NB: We can't `#[derive(Default)]` because `S` is left ambiguous.</span>
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">ThreadPoolBuilder</span> {
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="ident">ThreadPoolBuilder</span> {
<span class="ident">num_threads</span>: <span class="number">0</span>,
<span class="ident">panic_handler</span>: <span class="prelude-val">None</span>,
<span class="ident">get_thread_name</span>: <span class="prelude-val">None</span>,
<span class="ident">stack_size</span>: <span class="prelude-val">None</span>,
<span class="ident">start_handler</span>: <span class="prelude-val">None</span>,
<span class="ident">exit_handler</span>: <span class="prelude-val">None</span>,
<span class="ident">spawn_handler</span>: <span class="ident">DefaultSpawn</span>,
<span class="ident">breadth_first</span>: <span class="bool-val">false</span>,
}
}
}
<span class="kw">impl</span> <span class="ident">ThreadPoolBuilder</span> {
<span class="doccomment">/// Creates and returns a valid rayon thread pool builder, but does not initialize it.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="self">Self</span><span class="ident">::default</span>()
}
}
<span class="doccomment">/// Note: the `S: ThreadSpawn` constraint is an internal implementation detail for the</span>
<span class="doccomment">/// default spawn and those set by [`spawn_handler`](#method.spawn_handler).</span>
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="ident">ThreadPoolBuilder</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">S</span>: <span class="ident">ThreadSpawn</span>,
{
<span class="doccomment">/// Creates a new `ThreadPool` initialized using this configuration.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ThreadPool</span>, <span class="ident">ThreadPoolBuildError</span><span class="op">></span> {
<span class="ident">ThreadPool::build</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Initializes the global thread pool. This initialization is</span>
<span class="doccomment">/// **optional**. If you do not call this function, the thread pool</span>
<span class="doccomment">/// will be automatically initialized with the default</span>
<span class="doccomment">/// configuration. Calling `build_global` is not recommended, except</span>
<span class="doccomment">/// in two scenarios:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// - You wish to change the default configuration.</span>
<span class="doccomment">/// - You are running a benchmark, in which case initializing may</span>
<span class="doccomment">/// yield slightly more consistent results, since the worker threads</span>
<span class="doccomment">/// will already be ready to go even in the first iteration. But</span>
<span class="doccomment">/// this cost is minimal.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Initialization of the global thread pool happens exactly</span>
<span class="doccomment">/// once. Once started, the configuration cannot be</span>
<span class="doccomment">/// changed. Therefore, if you call `build_global` a second time, it</span>
<span class="doccomment">/// will return an error. An `Ok` result indicates that this</span>
<span class="doccomment">/// is the first initialization of the thread pool.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build_global</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">ThreadPoolBuildError</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">registry</span> <span class="op">=</span> <span class="ident">registry::init_global_registry</span>(<span class="self">self</span>)<span class="question-mark">?</span>;
<span class="ident">registry</span>.<span class="ident">wait_until_primed</span>();
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl</span> <span class="ident">ThreadPoolBuilder</span> {
<span class="doccomment">/// Creates a scoped `ThreadPool` initialized using this configuration.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is a convenience function for building a pool using [`crossbeam::scope`]</span>
<span class="doccomment">/// to spawn threads in a [`spawn_handler`](#method.spawn_handler).</span>
<span class="doccomment">/// The threads in this pool will start by calling `wrapper`, which should</span>
<span class="doccomment">/// do initialization and continue by calling `ThreadBuilder::run()`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`crossbeam::scope`]: https://docs.rs/crossbeam/0.7/crossbeam/fn.scope.html</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A scoped pool may be useful in combination with scoped thread-local variables.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use rayon_core as rayon;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// scoped_tls::scoped_thread_local!(static POOL_DATA: Vec<i32>);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn main() -> Result<(), rayon::ThreadPoolBuildError> {</span>
<span class="doccomment">/// let pool_data = vec![1, 2, 3];</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // We haven't assigned any TLS data yet.</span>
<span class="doccomment">/// assert!(!POOL_DATA.is_set());</span>
<span class="doccomment">///</span>
<span class="doccomment">/// rayon::ThreadPoolBuilder::new()</span>
<span class="doccomment">/// .build_scoped(</span>
<span class="doccomment">/// // Borrow `pool_data` in TLS for each thread.</span>
<span class="doccomment">/// |thread| POOL_DATA.set(&pool_data, || thread.run()),</span>
<span class="doccomment">/// // Do some work that needs the TLS data.</span>
<span class="doccomment">/// |pool| pool.install(|| assert!(POOL_DATA.is_set())),</span>
<span class="doccomment">/// )?;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // Once we've returned, `pool_data` is no longer borrowed.</span>
<span class="doccomment">/// drop(pool_data);</span>
<span class="doccomment">/// Ok(())</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build_scoped</span><span class="op"><</span><span class="ident">W</span>, <span class="ident">F</span>, <span class="ident">R</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">wrapper</span>: <span class="ident">W</span>, <span class="ident">with_pool</span>: <span class="ident">F</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">R</span>, <span class="ident">ThreadPoolBuildError</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">W</span>: <span class="ident">Fn</span>(<span class="ident">ThreadBuilder</span>) <span class="op">+</span> <span class="ident">Sync</span>, <span class="comment">// expected to call `run()`</span>
<span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">&</span><span class="ident">ThreadPool</span>) <span class="op">-</span><span class="op">></span> <span class="ident">R</span>,
{
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">crossbeam_utils::thread::scope</span>(<span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
<span class="kw">let</span> <span class="ident">wrapper</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">wrapper</span>;
<span class="kw">let</span> <span class="ident">pool</span> <span class="op">=</span> <span class="self">self</span>
.<span class="ident">spawn_handler</span>(<span class="op">|</span><span class="ident">thread</span><span class="op">|</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">scope</span>.<span class="ident">builder</span>();
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">name</span>) <span class="op">=</span> <span class="ident">thread</span>.<span class="ident">name</span>() {
<span class="ident">builder</span> <span class="op">=</span> <span class="ident">builder</span>.<span class="ident">name</span>(<span class="ident">name</span>.<span class="ident">to_string</span>());
}
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">size</span>) <span class="op">=</span> <span class="ident">thread</span>.<span class="ident">stack_size</span>() {
<span class="ident">builder</span> <span class="op">=</span> <span class="ident">builder</span>.<span class="ident">stack_size</span>(<span class="ident">size</span>);
}
<span class="ident">builder</span>.<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">wrapper</span>(<span class="ident">thread</span>))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
})
.<span class="ident">build</span>()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">with_pool</span>(<span class="kw-2">&</span><span class="ident">pool</span>))
});
<span class="kw">match</span> <span class="ident">result</span> {
<span class="prelude-val">Ok</span>(<span class="ident">result</span>) <span class="op">=</span><span class="op">></span> <span class="ident">result</span>,
<span class="prelude-val">Err</span>(<span class="ident">err</span>) <span class="op">=</span><span class="op">></span> <span class="ident">unwind::resume_unwinding</span>(<span class="ident">err</span>),
}
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="ident">ThreadPoolBuilder</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
<span class="doccomment">/// Sets a custom function for spawning threads.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that the threads will not exit until after the pool is dropped. It</span>
<span class="doccomment">/// is up to the caller to wait for thread termination if that is important</span>
<span class="doccomment">/// for any invariants. For instance, threads created in [`crossbeam::scope`]</span>
<span class="doccomment">/// will be joined before that scope returns, and this will block indefinitely</span>
<span class="doccomment">/// if the pool is leaked. Furthermore, the global thread pool doesn't terminate</span>
<span class="doccomment">/// until the entire process exits!</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`crossbeam::scope`]: https://docs.rs/crossbeam/0.7/crossbeam/fn.scope.html</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A minimal spawn handler just needs to call `run()` from an independent thread.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use rayon_core as rayon;</span>
<span class="doccomment">/// fn main() -> Result<(), rayon::ThreadPoolBuildError> {</span>
<span class="doccomment">/// let pool = rayon::ThreadPoolBuilder::new()</span>
<span class="doccomment">/// .spawn_handler(|thread| {</span>
<span class="doccomment">/// std::thread::spawn(|| thread.run());</span>
<span class="doccomment">/// Ok(())</span>
<span class="doccomment">/// })</span>
<span class="doccomment">/// .build()?;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// pool.install(|| println!("Hello from my custom thread!"));</span>
<span class="doccomment">/// Ok(())</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The default spawn handler sets the name and stack size if given, and propagates</span>
<span class="doccomment">/// any errors from the thread builder.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use rayon_core as rayon;</span>
<span class="doccomment">/// fn main() -> Result<(), rayon::ThreadPoolBuildError> {</span>
<span class="doccomment">/// let pool = rayon::ThreadPoolBuilder::new()</span>
<span class="doccomment">/// .spawn_handler(|thread| {</span>
<span class="doccomment">/// let mut b = std::thread::Builder::new();</span>
<span class="doccomment">/// if let Some(name) = thread.name() {</span>
<span class="doccomment">/// b = b.name(name.to_owned());</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// if let Some(stack_size) = thread.stack_size() {</span>
<span class="doccomment">/// b = b.stack_size(stack_size);</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// b.spawn(|| thread.run())?;</span>
<span class="doccomment">/// Ok(())</span>
<span class="doccomment">/// })</span>
<span class="doccomment">/// .build()?;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// pool.install(|| println!("Hello from my fully custom thread!"));</span>
<span class="doccomment">/// Ok(())</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">spawn_handler</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">spawn</span>: <span class="ident">F</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ThreadPoolBuilder</span><span class="op"><</span><span class="ident">CustomSpawn</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="ident">ThreadBuilder</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io::Result</span><span class="op"><</span>()<span class="op">></span>,
{
<span class="ident">ThreadPoolBuilder</span> {
<span class="ident">spawn_handler</span>: <span class="ident">CustomSpawn::new</span>(<span class="ident">spawn</span>),
<span class="comment">// ..self</span>
<span class="ident">num_threads</span>: <span class="self">self</span>.<span class="ident">num_threads</span>,
<span class="ident">panic_handler</span>: <span class="self">self</span>.<span class="ident">panic_handler</span>,
<span class="ident">get_thread_name</span>: <span class="self">self</span>.<span class="ident">get_thread_name</span>,
<span class="ident">stack_size</span>: <span class="self">self</span>.<span class="ident">stack_size</span>,
<span class="ident">start_handler</span>: <span class="self">self</span>.<span class="ident">start_handler</span>,
<span class="ident">exit_handler</span>: <span class="self">self</span>.<span class="ident">exit_handler</span>,
<span class="ident">breadth_first</span>: <span class="self">self</span>.<span class="ident">breadth_first</span>,
}
}
<span class="doccomment">/// Returns a reference to the current spawn handler.</span>
<span class="kw">fn</span> <span class="ident">get_spawn_handler</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">S</span> {
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">spawn_handler</span>
}
<span class="doccomment">/// Get the number of threads that will be used for the thread</span>
<span class="doccomment">/// pool. See `num_threads()` for more information.</span>
<span class="kw">fn</span> <span class="ident">get_num_threads</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">num_threads</span> <span class="op">></span> <span class="number">0</span> {
<span class="self">self</span>.<span class="ident">num_threads</span>
} <span class="kw">else</span> {
<span class="kw">match</span> <span class="ident">env::var</span>(<span class="string">"RAYON_NUM_THREADS"</span>)
.<span class="ident">ok</span>()
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="ident">usize::from_str</span>(<span class="kw-2">&</span><span class="ident">s</span>).<span class="ident">ok</span>())
{
<span class="prelude-val">Some</span>(<span class="ident">x</span>) <span class="kw">if</span> <span class="ident">x</span> <span class="op">></span> <span class="number">0</span> <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="ident">x</span>,
<span class="prelude-val">Some</span>(<span class="ident">x</span>) <span class="kw">if</span> <span class="ident">x</span> <span class="op">=</span><span class="op">=</span> <span class="number">0</span> <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="ident">num_cpus::get</span>(),
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> {}
}
<span class="comment">// Support for deprecated `RAYON_RS_NUM_CPUS`.</span>
<span class="kw">match</span> <span class="ident">env::var</span>(<span class="string">"RAYON_RS_NUM_CPUS"</span>)
.<span class="ident">ok</span>()
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="ident">usize::from_str</span>(<span class="kw-2">&</span><span class="ident">s</span>).<span class="ident">ok</span>())
{
<span class="prelude-val">Some</span>(<span class="ident">x</span>) <span class="kw">if</span> <span class="ident">x</span> <span class="op">></span> <span class="number">0</span> <span class="op">=</span><span class="op">></span> <span class="ident">x</span>,
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="ident">num_cpus::get</span>(),
}
}
}
<span class="doccomment">/// Get the thread name for the thread with the given index.</span>
<span class="kw">fn</span> <span class="ident">get_thread_name</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">index</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">get_thread_name</span>.<span class="ident">as_mut</span>()<span class="question-mark">?</span>;
<span class="prelude-val">Some</span>(<span class="ident">f</span>(<span class="ident">index</span>))
}
<span class="doccomment">/// Sets a closure which takes a thread index and returns</span>
<span class="doccomment">/// the thread's name.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">thread_name</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">closure</span>: <span class="ident">F</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>
<span class="kw">where</span>
<span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> <span class="op">+</span> <span class="lifetime">'static</span>,
{
<span class="self">self</span>.<span class="ident">get_thread_name</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">Box::new</span>(<span class="ident">closure</span>));
<span class="self">self</span>
}
<span class="doccomment">/// Sets the number of threads to be used in the rayon threadpool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If you specify a non-zero number of threads using this</span>
<span class="doccomment">/// function, then the resulting thread-pools are guaranteed to</span>
<span class="doccomment">/// start at most this number of threads.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If `num_threads` is 0, or you do not call this function, then</span>
<span class="doccomment">/// the Rayon runtime will select the number of threads</span>
<span class="doccomment">/// automatically. At present, this is based on the</span>
<span class="doccomment">/// `RAYON_NUM_THREADS` environment variable (if set),</span>
<span class="doccomment">/// or the number of logical CPUs (otherwise).</span>
<span class="doccomment">/// In the future, however, the default behavior may</span>
<span class="doccomment">/// change to dynamically add or remove threads as needed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Future compatibility warning:** Given the default behavior</span>
<span class="doccomment">/// may change in the future, if you wish to rely on a fixed</span>
<span class="doccomment">/// number of threads, you should use this function to specify</span>
<span class="doccomment">/// that number. To reproduce the current default behavior, you</span>
<span class="doccomment">/// may wish to use the [`num_cpus`</span>
<span class="doccomment">/// crate](https://crates.io/crates/num_cpus) to query the number</span>
<span class="doccomment">/// of CPUs dynamically.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Old environment variable:** `RAYON_NUM_THREADS` is a one-to-one</span>
<span class="doccomment">/// replacement of the now deprecated `RAYON_RS_NUM_CPUS` environment</span>
<span class="doccomment">/// variable. If both variables are specified, `RAYON_NUM_THREADS` will</span>
<span class="doccomment">/// be prefered.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">num_threads</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">num_threads</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">num_threads</span> <span class="op">=</span> <span class="ident">num_threads</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Returns a copy of the current panic handler.</span>
<span class="kw">fn</span> <span class="ident">take_panic_handler</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Box</span><span class="op"><</span><span class="ident">PanicHandler</span><span class="op">></span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">panic_handler</span>.<span class="ident">take</span>()
}
<span class="doccomment">/// Normally, whenever Rayon catches a panic, it tries to</span>
<span class="doccomment">/// propagate it to someplace sensible, to try and reflect the</span>
<span class="doccomment">/// semantics of sequential execution. But in some cases,</span>
<span class="doccomment">/// particularly with the `spawn()` APIs, there is no</span>
<span class="doccomment">/// obvious place where we should propagate the panic to.</span>
<span class="doccomment">/// In that case, this panic handler is invoked.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If no panic handler is set, the default is to abort the</span>
<span class="doccomment">/// process, under the principle that panics should not go</span>
<span class="doccomment">/// unobserved.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If the panic handler itself panics, this will abort the</span>
<span class="doccomment">/// process. To prevent this, wrap the body of your panic handler</span>
<span class="doccomment">/// in a call to `std::panic::catch_unwind()`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">panic_handler</span><span class="op"><</span><span class="ident">H</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">panic_handler</span>: <span class="ident">H</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>
<span class="kw">where</span>
<span class="ident">H</span>: <span class="ident">Fn</span>(<span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Any</span> <span class="op">+</span> <span class="ident">Send</span><span class="op">></span>) <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span> <span class="op">+</span> <span class="lifetime">'static</span>,
{
<span class="self">self</span>.<span class="ident">panic_handler</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">Box::new</span>(<span class="ident">panic_handler</span>));
<span class="self">self</span>
}
<span class="doccomment">/// Get the stack size of the worker threads</span>
<span class="kw">fn</span> <span class="ident">get_stack_size</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">stack_size</span>
}
<span class="doccomment">/// Sets the stack size of the worker threads</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">stack_size</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">stack_size</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">stack_size</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">stack_size</span>);
<span class="self">self</span>
}
<span class="doccomment">/// **(DEPRECATED)** Suggest to worker threads that they execute</span>
<span class="doccomment">/// spawned jobs in a "breadth-first" fashion.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Typically, when a worker thread is idle or blocked, it will</span>
<span class="doccomment">/// attempt to execute the job from the *top* of its local deque of</span>
<span class="doccomment">/// work (i.e., the job most recently spawned). If this flag is set</span>
<span class="doccomment">/// to true, however, workers will prefer to execute in a</span>
<span class="doccomment">/// *breadth-first* fashion -- that is, they will search for jobs at</span>
<span class="doccomment">/// the *bottom* of their local deque. (At present, workers *always*</span>
<span class="doccomment">/// steal from the bottom of other worker's deques, regardless of</span>
<span class="doccomment">/// the setting of this flag.)</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If you think of the tasks as a tree, where a parent task</span>
<span class="doccomment">/// spawns its children in the tree, then this flag loosely</span>
<span class="doccomment">/// corresponds to doing a breadth-first traversal of the tree,</span>
<span class="doccomment">/// whereas the default would be to do a depth-first traversal.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Note that this is an "execution hint".** Rayon's task</span>
<span class="doccomment">/// execution is highly dynamic and the precise order in which</span>
<span class="doccomment">/// independent tasks are executed is not intended to be</span>
<span class="doccomment">/// guaranteed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This `breadth_first()` method is now deprecated per [RFC #1],</span>
<span class="doccomment">/// and in the future its effect may be removed. Consider using</span>
<span class="doccomment">/// [`scope_fifo()`] for a similar effect.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [RFC #1]: https://github.com/rayon-rs/rfcs/blob/master/accepted/rfc0001-scope-scheduling.md</span>
<span class="doccomment">/// [`scope_fifo()`]: fn.scope_fifo.html</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">note</span> <span class="op">=</span> <span class="string">"use `scope_fifo` and `spawn_fifo` for similar effect"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">breadth_first</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">breadth_first</span> <span class="op">=</span> <span class="bool-val">true</span>;
<span class="self">self</span>
}
<span class="kw">fn</span> <span class="ident">get_breadth_first</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">breadth_first</span>
}
<span class="doccomment">/// Takes the current thread start callback, leaving `None`.</span>
<span class="kw">fn</span> <span class="ident">take_start_handler</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Box</span><span class="op"><</span><span class="ident">StartHandler</span><span class="op">></span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">start_handler</span>.<span class="ident">take</span>()
}
<span class="doccomment">/// Sets a callback to be invoked on thread start.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The closure is passed the index of the thread on which it is invoked.</span>
<span class="doccomment">/// Note that this same closure may be invoked multiple times in parallel.</span>
<span class="doccomment">/// If this closure panics, the panic will be passed to the panic handler.</span>
<span class="doccomment">/// If that handler returns, then startup will continue normally.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">start_handler</span><span class="op"><</span><span class="ident">H</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">start_handler</span>: <span class="ident">H</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>
<span class="kw">where</span>
<span class="ident">H</span>: <span class="ident">Fn</span>(<span class="ident">usize</span>) <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span> <span class="op">+</span> <span class="lifetime">'static</span>,
{
<span class="self">self</span>.<span class="ident">start_handler</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">Box::new</span>(<span class="ident">start_handler</span>));
<span class="self">self</span>
}
<span class="doccomment">/// Returns a current thread exit callback, leaving `None`.</span>
<span class="kw">fn</span> <span class="ident">take_exit_handler</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Box</span><span class="op"><</span><span class="ident">ExitHandler</span><span class="op">></span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">exit_handler</span>.<span class="ident">take</span>()
}
<span class="doccomment">/// Sets a callback to be invoked on thread exit.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The closure is passed the index of the thread on which it is invoked.</span>
<span class="doccomment">/// Note that this same closure may be invoked multiple times in parallel.</span>
<span class="doccomment">/// If this closure panics, the panic will be passed to the panic handler.</span>
<span class="doccomment">/// If that handler returns, then the thread will exit normally.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">exit_handler</span><span class="op"><</span><span class="ident">H</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">exit_handler</span>: <span class="ident">H</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>
<span class="kw">where</span>
<span class="ident">H</span>: <span class="ident">Fn</span>(<span class="ident">usize</span>) <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span> <span class="op">+</span> <span class="lifetime">'static</span>,
{
<span class="self">self</span>.<span class="ident">exit_handler</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">Box::new</span>(<span class="ident">exit_handler</span>));
<span class="self">self</span>
}
}
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">deprecated</span>)]</span>
<span class="kw">impl</span> <span class="ident">Configuration</span> {
<span class="doccomment">/// Creates and return a valid rayon thread pool configuration, but does not initialize it.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="ident">Configuration</span> {
<span class="ident">Configuration</span> {
<span class="ident">builder</span>: <span class="ident">ThreadPoolBuilder::new</span>(),
}
}
<span class="doccomment">/// Deprecated in favor of `ThreadPoolBuilder::build`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ThreadPool</span>, <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Error</span> <span class="op">+</span> <span class="lifetime">'static</span><span class="op">></span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">build</span>().<span class="ident">map_err</span>(<span class="ident">Box::from</span>)
}
<span class="doccomment">/// Deprecated in favor of `ThreadPoolBuilder::thread_name`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">thread_name</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">closure</span>: <span class="ident">F</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>
<span class="kw">where</span>
<span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> <span class="op">+</span> <span class="lifetime">'static</span>,
{
<span class="self">self</span>.<span class="ident">builder</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">thread_name</span>(<span class="ident">closure</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Deprecated in favor of `ThreadPoolBuilder::num_threads`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">num_threads</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">num_threads</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Configuration</span> {
<span class="self">self</span>.<span class="ident">builder</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">num_threads</span>(<span class="ident">num_threads</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Deprecated in favor of `ThreadPoolBuilder::panic_handler`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">panic_handler</span><span class="op"><</span><span class="ident">H</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">panic_handler</span>: <span class="ident">H</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Configuration</span>
<span class="kw">where</span>
<span class="ident">H</span>: <span class="ident">Fn</span>(<span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Any</span> <span class="op">+</span> <span class="ident">Send</span><span class="op">></span>) <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span> <span class="op">+</span> <span class="lifetime">'static</span>,
{
<span class="self">self</span>.<span class="ident">builder</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">panic_handler</span>(<span class="ident">panic_handler</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Deprecated in favor of `ThreadPoolBuilder::stack_size`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">stack_size</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">stack_size</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">builder</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">stack_size</span>(<span class="ident">stack_size</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Deprecated in favor of `ThreadPoolBuilder::breadth_first`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">breadth_first</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">builder</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">breadth_first</span>();
<span class="self">self</span>
}
<span class="doccomment">/// Deprecated in favor of `ThreadPoolBuilder::start_handler`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">start_handler</span><span class="op"><</span><span class="ident">H</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">start_handler</span>: <span class="ident">H</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Configuration</span>
<span class="kw">where</span>
<span class="ident">H</span>: <span class="ident">Fn</span>(<span class="ident">usize</span>) <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span> <span class="op">+</span> <span class="lifetime">'static</span>,
{
<span class="self">self</span>.<span class="ident">builder</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">start_handler</span>(<span class="ident">start_handler</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Deprecated in favor of `ThreadPoolBuilder::exit_handler`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">exit_handler</span><span class="op"><</span><span class="ident">H</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">exit_handler</span>: <span class="ident">H</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Configuration</span>
<span class="kw">where</span>
<span class="ident">H</span>: <span class="ident">Fn</span>(<span class="ident">usize</span>) <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span> <span class="op">+</span> <span class="lifetime">'static</span>,
{
<span class="self">self</span>.<span class="ident">builder</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">exit_handler</span>(<span class="ident">exit_handler</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Returns a ThreadPoolBuilder with identical parameters.</span>
<span class="kw">fn</span> <span class="ident">into_builder</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ThreadPoolBuilder</span> {
<span class="self">self</span>.<span class="ident">builder</span>
}
}
<span class="kw">impl</span> <span class="ident">ThreadPoolBuildError</span> {
<span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">kind</span>: <span class="ident">ErrorKind</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ThreadPoolBuildError</span> {
<span class="ident">ThreadPoolBuildError</span> { <span class="ident">kind</span> }
}
}
<span class="kw">const</span> <span class="ident">GLOBAL_POOL_ALREADY_INITIALIZED</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span>
<span class="string">"The global thread pool has already been initialized."</span>;
<span class="kw">impl</span> <span class="ident">Error</span> <span class="kw">for</span> <span class="ident">ThreadPoolBuildError</span> {
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">deprecated</span>)]</span>
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">str</span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">kind</span> {
<span class="ident">ErrorKind::GlobalPoolAlreadyInitialized</span> <span class="op">=</span><span class="op">></span> <span class="ident">GLOBAL_POOL_ALREADY_INITIALIZED</span>,
<span class="ident">ErrorKind::IOError</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="ident">e</span>.<span class="ident">description</span>(),
}
}
<span class="kw">fn</span> <span class="ident">source</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span>(<span class="kw">dyn</span> <span class="ident">Error</span> <span class="op">+</span> <span class="lifetime">'static</span>)<span class="op">></span> {
<span class="kw">match</span> <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">kind</span> {
<span class="ident">ErrorKind::GlobalPoolAlreadyInitialized</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">None</span>,
<span class="ident">ErrorKind::IOError</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">e</span>),
}
}
}
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">ThreadPoolBuildError</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt::Result</span> {
<span class="kw">match</span> <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">kind</span> {
<span class="ident">ErrorKind::GlobalPoolAlreadyInitialized</span> <span class="op">=</span><span class="op">></span> <span class="ident">GLOBAL_POOL_ALREADY_INITIALIZED</span>.<span class="ident">fmt</span>(<span class="ident">f</span>),
<span class="ident">ErrorKind::IOError</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="ident">e</span>.<span class="ident">fmt</span>(<span class="ident">f</span>),
}
}
}
<span class="doccomment">/// Deprecated in favor of `ThreadPoolBuilder::build_global`.</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">note</span> <span class="op">=</span> <span class="string">"use `ThreadPoolBuilder::build_global`"</span>)]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">deprecated</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">initialize</span>(<span class="ident">config</span>: <span class="ident">Configuration</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Error</span><span class="op">></span><span class="op">></span> {
<span class="ident">config</span>.<span class="ident">into_builder</span>().<span class="ident">build_global</span>().<span class="ident">map_err</span>(<span class="ident">Box::from</span>)
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="ident">fmt::Debug</span> <span class="kw">for</span> <span class="ident">ThreadPoolBuilder</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt::Result</span> {
<span class="kw">let</span> <span class="ident">ThreadPoolBuilder</span> {
<span class="kw-2">ref</span> <span class="ident">num_threads</span>,
<span class="kw-2">ref</span> <span class="ident">get_thread_name</span>,
<span class="kw-2">ref</span> <span class="ident">panic_handler</span>,
<span class="kw-2">ref</span> <span class="ident">stack_size</span>,
<span class="kw-2">ref</span> <span class="ident">start_handler</span>,
<span class="kw-2">ref</span> <span class="ident">exit_handler</span>,
<span class="ident">spawn_handler</span>: <span class="kw">_</span>,
<span class="kw-2">ref</span> <span class="ident">breadth_first</span>,
} <span class="op">=</span> <span class="kw-2">*</span><span class="self">self</span>;
<span class="comment">// Just print `Some(<closure>)` or `None` to the debug</span>
<span class="comment">// output.</span>
<span class="kw">struct</span> <span class="ident">ClosurePlaceholder</span>;
<span class="kw">impl</span> <span class="ident">fmt::Debug</span> <span class="kw">for</span> <span class="ident">ClosurePlaceholder</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt::Result</span> {
<span class="ident">f</span>.<span class="ident">write_str</span>(<span class="string">"<closure>"</span>)
}
}
<span class="kw">let</span> <span class="ident">get_thread_name</span> <span class="op">=</span> <span class="ident">get_thread_name</span>.<span class="ident">as_ref</span>().<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">ClosurePlaceholder</span>);
<span class="kw">let</span> <span class="ident">panic_handler</span> <span class="op">=</span> <span class="ident">panic_handler</span>.<span class="ident">as_ref</span>().<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">ClosurePlaceholder</span>);
<span class="kw">let</span> <span class="ident">start_handler</span> <span class="op">=</span> <span class="ident">start_handler</span>.<span class="ident">as_ref</span>().<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">ClosurePlaceholder</span>);
<span class="kw">let</span> <span class="ident">exit_handler</span> <span class="op">=</span> <span class="ident">exit_handler</span>.<span class="ident">as_ref</span>().<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">ClosurePlaceholder</span>);
<span class="ident">f</span>.<span class="ident">debug_struct</span>(<span class="string">"ThreadPoolBuilder"</span>)
.<span class="ident">field</span>(<span class="string">"num_threads"</span>, <span class="ident">num_threads</span>)
.<span class="ident">field</span>(<span class="string">"get_thread_name"</span>, <span class="kw-2">&</span><span class="ident">get_thread_name</span>)
.<span class="ident">field</span>(<span class="string">"panic_handler"</span>, <span class="kw-2">&</span><span class="ident">panic_handler</span>)
.<span class="ident">field</span>(<span class="string">"stack_size"</span>, <span class="kw-2">&</span><span class="ident">stack_size</span>)
.<span class="ident">field</span>(<span class="string">"start_handler"</span>, <span class="kw-2">&</span><span class="ident">start_handler</span>)
.<span class="ident">field</span>(<span class="string">"exit_handler"</span>, <span class="kw-2">&</span><span class="ident">exit_handler</span>)
.<span class="ident">field</span>(<span class="string">"breadth_first"</span>, <span class="kw-2">&</span><span class="ident">breadth_first</span>)
.<span class="ident">finish</span>()
}
}
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">deprecated</span>)]</span>
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">Configuration</span> {
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="ident">Configuration</span> {
<span class="ident">builder</span>: <span class="ident">Default::default</span>(),
}
}
}
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">deprecated</span>)]</span>
<span class="kw">impl</span> <span class="ident">fmt::Debug</span> <span class="kw">for</span> <span class="ident">Configuration</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt::Result</span> {
<span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">fmt</span>(<span class="ident">f</span>)
}
}
<span class="doccomment">/// Provides the calling context to a closure called by `join_context`.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">FnContext</span> {
<span class="ident">migrated</span>: <span class="ident">bool</span>,
<span class="doccomment">/// disable `Send` and `Sync`, just for a little future-proofing.</span>
<span class="ident">_marker</span>: <span class="ident">PhantomData</span><span class="op"><</span><span class="kw-2">*</span><span class="kw-2">mut</span> ()<span class="op">></span>,
}
<span class="kw">impl</span> <span class="ident">FnContext</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">migrated</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="ident">FnContext</span> {
<span class="ident">migrated</span>,
<span class="ident">_marker</span>: <span class="ident">PhantomData</span>,
}
}
}
<span class="kw">impl</span> <span class="ident">FnContext</span> {
<span class="doccomment">/// Returns `true` if the closure was called from a different thread</span>
<span class="doccomment">/// than it was provided from.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">migrated</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">migrated</span>
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rayon_core" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>