<!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 to the Rust file `libstd/thread/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs.html -- 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="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><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> <span id="783"> 783</span> <span id="784"> 784</span> <span id="785"> 785</span> <span id="786"> 786</span> <span id="787"> 787</span> <span id="788"> 788</span> <span id="789"> 789</span> <span id="790"> 790</span> <span id="791"> 791</span> <span id="792"> 792</span> <span id="793"> 793</span> <span id="794"> 794</span> <span id="795"> 795</span> <span id="796"> 796</span> <span id="797"> 797</span> <span id="798"> 798</span> <span id="799"> 799</span> <span id="800"> 800</span> <span id="801"> 801</span> <span id="802"> 802</span> <span id="803"> 803</span> <span id="804"> 804</span> <span id="805"> 805</span> <span id="806"> 806</span> <span id="807"> 807</span> <span id="808"> 808</span> <span id="809"> 809</span> <span id="810"> 810</span> <span id="811"> 811</span> <span id="812"> 812</span> <span id="813"> 813</span> <span id="814"> 814</span> <span id="815"> 815</span> <span id="816"> 816</span> <span id="817"> 817</span> <span id="818"> 818</span> <span id="819"> 819</span> <span id="820"> 820</span> <span id="821"> 821</span> <span id="822"> 822</span> <span id="823"> 823</span> <span id="824"> 824</span> <span id="825"> 825</span> <span id="826"> 826</span> <span id="827"> 827</span> <span id="828"> 828</span> <span id="829"> 829</span> <span id="830"> 830</span> <span id="831"> 831</span> <span id="832"> 832</span> <span id="833"> 833</span> <span id="834"> 834</span> <span id="835"> 835</span> <span id="836"> 836</span> <span id="837"> 837</span> <span id="838"> 838</span> <span id="839"> 839</span> <span id="840"> 840</span> <span id="841"> 841</span> <span id="842"> 842</span> <span id="843"> 843</span> <span id="844"> 844</span> <span id="845"> 845</span> <span id="846"> 846</span> <span id="847"> 847</span> <span id="848"> 848</span> <span id="849"> 849</span> <span id="850"> 850</span> <span id="851"> 851</span> <span id="852"> 852</span> <span id="853"> 853</span> <span id="854"> 854</span> <span id="855"> 855</span> <span id="856"> 856</span> <span id="857"> 857</span> <span id="858"> 858</span> <span id="859"> 859</span> <span id="860"> 860</span> <span id="861"> 861</span> <span id="862"> 862</span> <span id="863"> 863</span> <span id="864"> 864</span> <span id="865"> 865</span> <span id="866"> 866</span> <span id="867"> 867</span> <span id="868"> 868</span> <span id="869"> 869</span> <span id="870"> 870</span> <span id="871"> 871</span> <span id="872"> 872</span> <span id="873"> 873</span> <span id="874"> 874</span> <span id="875"> 875</span> <span id="876"> 876</span> <span id="877"> 877</span> <span id="878"> 878</span> <span id="879"> 879</span> <span id="880"> 880</span> <span id="881"> 881</span> <span id="882"> 882</span> <span id="883"> 883</span> <span id="884"> 884</span> <span id="885"> 885</span> <span id="886"> 886</span> <span id="887"> 887</span> <span id="888"> 888</span> <span id="889"> 889</span> <span id="890"> 890</span> <span id="891"> 891</span> <span id="892"> 892</span> <span id="893"> 893</span> <span id="894"> 894</span> <span id="895"> 895</span> <span id="896"> 896</span> <span id="897"> 897</span> <span id="898"> 898</span> <span id="899"> 899</span> <span id="900"> 900</span> <span id="901"> 901</span> <span id="902"> 902</span> <span id="903"> 903</span> <span id="904"> 904</span> <span id="905"> 905</span> <span id="906"> 906</span> <span id="907"> 907</span> <span id="908"> 908</span> <span id="909"> 909</span> <span id="910"> 910</span> <span id="911"> 911</span> <span id="912"> 912</span> <span id="913"> 913</span> <span id="914"> 914</span> <span id="915"> 915</span> <span id="916"> 916</span> <span id="917"> 917</span> <span id="918"> 918</span> <span id="919"> 919</span> <span id="920"> 920</span> <span id="921"> 921</span> <span id="922"> 922</span> <span id="923"> 923</span> <span id="924"> 924</span> <span id="925"> 925</span> <span id="926"> 926</span> <span id="927"> 927</span> <span id="928"> 928</span> <span id="929"> 929</span> <span id="930"> 930</span> <span id="931"> 931</span> <span id="932"> 932</span> <span id="933"> 933</span> <span id="934"> 934</span> <span id="935"> 935</span> <span id="936"> 936</span> <span id="937"> 937</span> <span id="938"> 938</span> <span id="939"> 939</span> <span id="940"> 940</span> <span id="941"> 941</span> <span id="942"> 942</span> <span id="943"> 943</span> <span id="944"> 944</span> <span id="945"> 945</span> <span id="946"> 946</span> <span id="947"> 947</span> <span id="948"> 948</span> <span id="949"> 949</span> <span id="950"> 950</span> <span id="951"> 951</span> <span id="952"> 952</span> <span id="953"> 953</span> <span id="954"> 954</span> <span id="955"> 955</span> <span id="956"> 956</span> <span id="957"> 957</span> <span id="958"> 958</span> <span id="959"> 959</span> <span id="960"> 960</span> <span id="961"> 961</span> <span id="962"> 962</span> <span id="963"> 963</span> <span id="964"> 964</span> <span id="965"> 965</span> <span id="966"> 966</span> <span id="967"> 967</span> <span id="968"> 968</span> <span id="969"> 969</span> <span id="970"> 970</span> <span id="971"> 971</span> <span id="972"> 972</span> <span id="973"> 973</span> <span id="974"> 974</span> <span id="975"> 975</span> <span id="976"> 976</span> <span id="977"> 977</span> <span id="978"> 978</span> <span id="979"> 979</span> <span id="980"> 980</span> <span id="981"> 981</span> <span id="982"> 982</span> <span id="983"> 983</span> <span id="984"> 984</span> <span id="985"> 985</span> <span id="986"> 986</span> <span id="987"> 987</span> <span id="988"> 988</span> <span id="989"> 989</span> <span id="990"> 990</span> <span id="991"> 991</span> <span id="992"> 992</span> <span id="993"> 993</span> <span id="994"> 994</span> <span id="995"> 995</span> <span id="996"> 996</span> <span id="997"> 997</span> <span id="998"> 998</span> <span id="999"> 999</span> <span id="1000">1000</span> <span id="1001">1001</span> <span id="1002">1002</span> <span id="1003">1003</span> <span id="1004">1004</span> <span id="1005">1005</span> <span id="1006">1006</span> <span id="1007">1007</span> <span id="1008">1008</span> <span id="1009">1009</span> <span id="1010">1010</span> <span id="1011">1011</span> <span id="1012">1012</span> <span id="1013">1013</span> <span id="1014">1014</span> <span id="1015">1015</span> <span id="1016">1016</span> <span id="1017">1017</span> <span id="1018">1018</span> <span id="1019">1019</span> <span id="1020">1020</span> <span id="1021">1021</span> <span id="1022">1022</span> <span id="1023">1023</span> <span id="1024">1024</span> <span id="1025">1025</span> <span id="1026">1026</span> <span id="1027">1027</span> <span id="1028">1028</span> <span id="1029">1029</span> <span id="1030">1030</span> <span id="1031">1031</span> <span id="1032">1032</span> <span id="1033">1033</span> <span id="1034">1034</span> <span id="1035">1035</span> <span id="1036">1036</span> <span id="1037">1037</span> <span id="1038">1038</span> <span id="1039">1039</span> <span id="1040">1040</span> <span id="1041">1041</span> <span id="1042">1042</span> <span id="1043">1043</span> <span id="1044">1044</span> <span id="1045">1045</span> <span id="1046">1046</span> <span id="1047">1047</span> <span id="1048">1048</span> <span id="1049">1049</span> <span id="1050">1050</span> <span id="1051">1051</span> <span id="1052">1052</span> <span id="1053">1053</span> <span id="1054">1054</span> <span id="1055">1055</span> <span id="1056">1056</span> <span id="1057">1057</span> <span id="1058">1058</span> <span id="1059">1059</span> <span id="1060">1060</span> <span id="1061">1061</span> <span id="1062">1062</span> <span id="1063">1063</span> <span id="1064">1064</span> <span id="1065">1065</span> <span id="1066">1066</span> <span id="1067">1067</span> <span id="1068">1068</span> <span id="1069">1069</span> <span id="1070">1070</span> <span id="1071">1071</span> <span id="1072">1072</span> <span id="1073">1073</span> <span id="1074">1074</span> <span id="1075">1075</span> <span id="1076">1076</span> <span id="1077">1077</span> <span id="1078">1078</span> <span id="1079">1079</span> <span id="1080">1080</span> <span id="1081">1081</span> <span id="1082">1082</span> <span id="1083">1083</span> <span id="1084">1084</span> <span id="1085">1085</span> <span id="1086">1086</span> <span id="1087">1087</span> <span id="1088">1088</span> <span id="1089">1089</span> <span id="1090">1090</span> <span id="1091">1091</span> <span id="1092">1092</span> <span id="1093">1093</span> <span id="1094">1094</span> <span id="1095">1095</span> <span id="1096">1096</span> <span id="1097">1097</span> <span id="1098">1098</span> <span id="1099">1099</span> <span id="1100">1100</span> <span id="1101">1101</span> <span id="1102">1102</span> <span id="1103">1103</span> <span id="1104">1104</span> <span id="1105">1105</span> <span id="1106">1106</span> <span id="1107">1107</span> <span id="1108">1108</span> <span id="1109">1109</span> <span id="1110">1110</span> <span id="1111">1111</span> <span id="1112">1112</span> <span id="1113">1113</span> <span id="1114">1114</span> <span id="1115">1115</span> <span id="1116">1116</span> <span id="1117">1117</span> <span id="1118">1118</span> <span id="1119">1119</span> <span id="1120">1120</span> <span id="1121">1121</span> <span id="1122">1122</span> <span id="1123">1123</span> <span id="1124">1124</span> <span id="1125">1125</span> <span id="1126">1126</span> <span id="1127">1127</span> <span id="1128">1128</span> <span id="1129">1129</span> <span id="1130">1130</span> <span id="1131">1131</span> <span id="1132">1132</span> <span id="1133">1133</span> <span id="1134">1134</span> <span id="1135">1135</span> <span id="1136">1136</span> <span id="1137">1137</span> <span id="1138">1138</span> <span id="1139">1139</span> <span id="1140">1140</span> <span id="1141">1141</span> <span id="1142">1142</span> <span id="1143">1143</span> <span id="1144">1144</span> <span id="1145">1145</span> <span id="1146">1146</span> <span id="1147">1147</span> <span id="1148">1148</span> <span id="1149">1149</span> <span id="1150">1150</span> <span id="1151">1151</span> <span id="1152">1152</span> <span id="1153">1153</span> <span id="1154">1154</span> <span id="1155">1155</span> <span id="1156">1156</span> <span id="1157">1157</span> <span id="1158">1158</span> <span id="1159">1159</span> <span id="1160">1160</span> <span id="1161">1161</span> <span id="1162">1162</span> <span id="1163">1163</span> <span id="1164">1164</span> <span id="1165">1165</span> <span id="1166">1166</span> <span id="1167">1167</span> <span id="1168">1168</span> <span id="1169">1169</span> <span id="1170">1170</span> <span id="1171">1171</span> <span id="1172">1172</span> <span id="1173">1173</span> <span id="1174">1174</span> <span id="1175">1175</span> <span id="1176">1176</span> <span id="1177">1177</span> <span id="1178">1178</span> <span id="1179">1179</span> <span id="1180">1180</span> <span id="1181">1181</span> <span id="1182">1182</span> <span id="1183">1183</span> <span id="1184">1184</span> <span id="1185">1185</span> <span id="1186">1186</span> <span id="1187">1187</span> <span id="1188">1188</span> <span id="1189">1189</span> <span id="1190">1190</span> <span id="1191">1191</span> <span id="1192">1192</span> <span id="1193">1193</span> <span id="1194">1194</span> <span id="1195">1195</span> <span id="1196">1196</span> <span id="1197">1197</span> <span id="1198">1198</span> <span id="1199">1199</span> <span id="1200">1200</span> <span id="1201">1201</span> <span id="1202">1202</span> <span id="1203">1203</span> <span id="1204">1204</span> <span id="1205">1205</span> <span id="1206">1206</span> <span id="1207">1207</span> <span id="1208">1208</span> <span id="1209">1209</span> <span id="1210">1210</span> <span id="1211">1211</span> <span id="1212">1212</span> <span id="1213">1213</span> <span id="1214">1214</span> <span id="1215">1215</span> <span id="1216">1216</span> <span id="1217">1217</span> <span id="1218">1218</span> <span id="1219">1219</span> <span id="1220">1220</span> <span id="1221">1221</span> <span id="1222">1222</span> <span id="1223">1223</span> <span id="1224">1224</span> <span id="1225">1225</span> <span id="1226">1226</span> <span id="1227">1227</span> <span id="1228">1228</span> <span id="1229">1229</span> <span id="1230">1230</span> <span id="1231">1231</span> <span id="1232">1232</span> <span id="1233">1233</span> <span id="1234">1234</span> <span id="1235">1235</span> <span id="1236">1236</span> <span id="1237">1237</span> <span id="1238">1238</span> <span id="1239">1239</span> <span id="1240">1240</span> <span id="1241">1241</span> <span id="1242">1242</span> <span id="1243">1243</span> <span id="1244">1244</span> <span id="1245">1245</span> <span id="1246">1246</span> <span id="1247">1247</span> <span id="1248">1248</span> <span id="1249">1249</span> <span id="1250">1250</span> <span id="1251">1251</span> <span id="1252">1252</span> <span id="1253">1253</span> <span id="1254">1254</span> <span id="1255">1255</span> <span id="1256">1256</span> <span id="1257">1257</span> <span id="1258">1258</span> <span id="1259">1259</span> <span id="1260">1260</span> <span id="1261">1261</span> <span id="1262">1262</span> <span id="1263">1263</span> <span id="1264">1264</span> <span id="1265">1265</span> <span id="1266">1266</span> <span id="1267">1267</span> <span id="1268">1268</span> <span id="1269">1269</span> <span id="1270">1270</span> <span id="1271">1271</span> <span id="1272">1272</span> <span id="1273">1273</span> <span id="1274">1274</span> <span id="1275">1275</span> <span id="1276">1276</span> <span id="1277">1277</span> <span id="1278">1278</span> <span id="1279">1279</span> <span id="1280">1280</span> <span id="1281">1281</span> <span id="1282">1282</span> <span id="1283">1283</span> <span id="1284">1284</span> <span id="1285">1285</span> <span id="1286">1286</span> <span id="1287">1287</span> <span id="1288">1288</span> <span id="1289">1289</span> <span id="1290">1290</span> <span id="1291">1291</span> <span id="1292">1292</span> <span id="1293">1293</span> <span id="1294">1294</span> <span id="1295">1295</span> <span id="1296">1296</span> <span id="1297">1297</span> <span id="1298">1298</span> <span id="1299">1299</span> <span id="1300">1300</span> <span id="1301">1301</span> <span id="1302">1302</span> <span id="1303">1303</span> <span id="1304">1304</span> <span id="1305">1305</span> <span id="1306">1306</span> <span id="1307">1307</span> <span id="1308">1308</span> <span id="1309">1309</span> <span id="1310">1310</span> <span id="1311">1311</span> <span id="1312">1312</span> <span id="1313">1313</span> <span id="1314">1314</span> <span id="1315">1315</span> <span id="1316">1316</span> <span id="1317">1317</span> <span id="1318">1318</span> <span id="1319">1319</span> <span id="1320">1320</span> <span id="1321">1321</span> <span id="1322">1322</span> <span id="1323">1323</span> <span id="1324">1324</span> <span id="1325">1325</span> <span id="1326">1326</span> <span id="1327">1327</span> <span id="1328">1328</span> <span id="1329">1329</span> <span id="1330">1330</span> <span id="1331">1331</span> <span id="1332">1332</span> <span id="1333">1333</span> <span id="1334">1334</span> <span id="1335">1335</span> <span id="1336">1336</span> <span id="1337">1337</span> <span id="1338">1338</span> <span id="1339">1339</span> <span id="1340">1340</span> <span id="1341">1341</span> <span id="1342">1342</span> <span id="1343">1343</span> <span id="1344">1344</span> <span id="1345">1345</span> <span id="1346">1346</span> <span id="1347">1347</span> <span id="1348">1348</span> <span id="1349">1349</span> <span id="1350">1350</span> <span id="1351">1351</span> <span id="1352">1352</span> <span id="1353">1353</span> <span id="1354">1354</span> <span id="1355">1355</span> <span id="1356">1356</span> <span id="1357">1357</span> <span id="1358">1358</span> <span id="1359">1359</span> <span id="1360">1360</span> <span id="1361">1361</span> <span id="1362">1362</span> <span id="1363">1363</span> <span id="1364">1364</span> <span id="1365">1365</span> <span id="1366">1366</span> <span id="1367">1367</span> <span id="1368">1368</span> <span id="1369">1369</span> <span id="1370">1370</span> <span id="1371">1371</span> <span id="1372">1372</span> <span id="1373">1373</span> <span id="1374">1374</span> <span id="1375">1375</span> <span id="1376">1376</span> <span id="1377">1377</span> <span id="1378">1378</span> <span id="1379">1379</span> <span id="1380">1380</span> <span id="1381">1381</span> <span id="1382">1382</span> <span id="1383">1383</span> <span id="1384">1384</span> <span id="1385">1385</span> <span id="1386">1386</span> <span id="1387">1387</span> <span id="1388">1388</span> <span id="1389">1389</span> <span id="1390">1390</span> <span id="1391">1391</span> <span id="1392">1392</span> <span id="1393">1393</span> <span id="1394">1394</span> <span id="1395">1395</span> <span id="1396">1396</span> <span id="1397">1397</span> <span id="1398">1398</span> <span id="1399">1399</span> <span id="1400">1400</span> <span id="1401">1401</span> <span id="1402">1402</span> <span id="1403">1403</span> <span id="1404">1404</span> <span id="1405">1405</span> <span id="1406">1406</span> <span id="1407">1407</span> <span id="1408">1408</span> <span id="1409">1409</span> <span id="1410">1410</span> <span id="1411">1411</span> <span id="1412">1412</span> <span id="1413">1413</span> <span id="1414">1414</span> <span id="1415">1415</span> <span id="1416">1416</span> <span id="1417">1417</span> <span id="1418">1418</span> <span id="1419">1419</span> <span id="1420">1420</span> <span id="1421">1421</span> <span id="1422">1422</span> <span id="1423">1423</span> <span id="1424">1424</span> <span id="1425">1425</span> <span id="1426">1426</span> <span id="1427">1427</span> <span id="1428">1428</span> <span id="1429">1429</span> <span id="1430">1430</span> <span id="1431">1431</span> <span id="1432">1432</span> <span id="1433">1433</span> <span id="1434">1434</span> <span id="1435">1435</span> <span id="1436">1436</span> <span id="1437">1437</span> <span id="1438">1438</span> <span id="1439">1439</span> <span id="1440">1440</span> <span id="1441">1441</span> <span id="1442">1442</span> <span id="1443">1443</span> <span id="1444">1444</span> <span id="1445">1445</span> <span id="1446">1446</span> <span id="1447">1447</span> <span id="1448">1448</span> <span id="1449">1449</span> <span id="1450">1450</span> <span id="1451">1451</span> <span id="1452">1452</span> <span id="1453">1453</span> <span id="1454">1454</span> <span id="1455">1455</span> <span id="1456">1456</span> <span id="1457">1457</span> <span id="1458">1458</span> <span id="1459">1459</span> <span id="1460">1460</span> <span id="1461">1461</span> <span id="1462">1462</span> <span id="1463">1463</span> <span id="1464">1464</span> <span id="1465">1465</span> <span id="1466">1466</span> <span id="1467">1467</span> <span id="1468">1468</span> <span id="1469">1469</span> <span id="1470">1470</span> <span id="1471">1471</span> <span id="1472">1472</span> <span id="1473">1473</span> <span id="1474">1474</span> <span id="1475">1475</span> <span id="1476">1476</span> <span id="1477">1477</span> <span id="1478">1478</span> <span id="1479">1479</span> <span id="1480">1480</span> <span id="1481">1481</span> <span id="1482">1482</span> <span id="1483">1483</span> <span id="1484">1484</span> <span id="1485">1485</span> <span id="1486">1486</span> <span id="1487">1487</span> <span id="1488">1488</span> <span id="1489">1489</span> <span id="1490">1490</span> <span id="1491">1491</span> <span id="1492">1492</span> <span id="1493">1493</span> <span id="1494">1494</span> <span id="1495">1495</span> <span id="1496">1496</span> <span id="1497">1497</span> <span id="1498">1498</span> <span id="1499">1499</span> <span id="1500">1500</span> <span id="1501">1501</span> <span id="1502">1502</span> <span id="1503">1503</span> <span id="1504">1504</span> <span id="1505">1505</span> <span id="1506">1506</span> <span id="1507">1507</span> <span id="1508">1508</span> <span id="1509">1509</span> <span id="1510">1510</span> <span id="1511">1511</span> <span id="1512">1512</span> <span id="1513">1513</span> <span id="1514">1514</span> <span id="1515">1515</span> <span id="1516">1516</span> <span id="1517">1517</span> <span id="1518">1518</span> <span id="1519">1519</span> <span id="1520">1520</span> <span id="1521">1521</span> <span id="1522">1522</span> <span id="1523">1523</span> <span id="1524">1524</span> <span id="1525">1525</span> <span id="1526">1526</span> <span id="1527">1527</span> <span id="1528">1528</span> <span id="1529">1529</span> <span id="1530">1530</span> <span id="1531">1531</span> <span id="1532">1532</span> <span id="1533">1533</span> <span id="1534">1534</span> <span id="1535">1535</span> <span id="1536">1536</span> <span id="1537">1537</span> <span id="1538">1538</span> <span id="1539">1539</span> <span id="1540">1540</span> <span id="1541">1541</span> <span id="1542">1542</span> <span id="1543">1543</span> <span id="1544">1544</span> <span id="1545">1545</span> <span id="1546">1546</span> <span id="1547">1547</span> <span id="1548">1548</span> <span id="1549">1549</span> <span id="1550">1550</span> <span id="1551">1551</span> <span id="1552">1552</span> <span id="1553">1553</span> <span id="1554">1554</span> <span id="1555">1555</span> <span id="1556">1556</span> <span id="1557">1557</span> <span id="1558">1558</span> <span id="1559">1559</span> <span id="1560">1560</span> <span id="1561">1561</span> <span id="1562">1562</span> <span id="1563">1563</span> <span id="1564">1564</span> <span id="1565">1565</span> <span id="1566">1566</span> <span id="1567">1567</span> <span id="1568">1568</span> <span id="1569">1569</span> <span id="1570">1570</span> <span id="1571">1571</span> <span id="1572">1572</span> <span id="1573">1573</span> <span id="1574">1574</span> <span id="1575">1575</span> <span id="1576">1576</span> <span id="1577">1577</span> <span id="1578">1578</span> <span id="1579">1579</span> <span id="1580">1580</span> <span id="1581">1581</span> <span id="1582">1582</span> <span id="1583">1583</span> <span id="1584">1584</span> <span id="1585">1585</span> <span id="1586">1586</span> <span id="1587">1587</span> <span id="1588">1588</span> <span id="1589">1589</span> <span id="1590">1590</span> <span id="1591">1591</span> <span id="1592">1592</span> <span id="1593">1593</span> <span id="1594">1594</span> <span id="1595">1595</span> <span id="1596">1596</span> <span id="1597">1597</span> <span id="1598">1598</span> <span id="1599">1599</span> <span id="1600">1600</span> <span id="1601">1601</span> <span id="1602">1602</span> <span id="1603">1603</span> </pre><pre class="rust "> <span class="comment">// Copyright 2014 The Rust Project Developers. See the COPYRIGHT</span> <span class="comment">// file at the top-level directory of this distribution and at</span> <span class="comment">// http://rust-lang.org/COPYRIGHT.</span> <span class="comment">//</span> <span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span> <span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span> <span class="comment">// option. This file may not be copied, modified, or distributed</span> <span class="comment">// except according to those terms.</span> <span class="doccomment">//! Native threads.</span> <span class="doccomment">//!</span> <span class="doccomment">//! ## The threading model</span> <span class="doccomment">//!</span> <span class="doccomment">//! An executing Rust program consists of a collection of native OS threads,</span> <span class="doccomment">//! each with their own stack and local state. Threads can be named, and</span> <span class="doccomment">//! provide some built-in support for low-level synchronization.</span> <span class="doccomment">//!</span> <span class="doccomment">//! Communication between threads can be done through</span> <span class="doccomment">//! [channels], Rust's message-passing types, along with [other forms of thread</span> <span class="doccomment">//! synchronization](../../std/sync/index.html) and shared-memory data</span> <span class="doccomment">//! structures. In particular, types that are guaranteed to be</span> <span class="doccomment">//! threadsafe are easily shared between threads using the</span> <span class="doccomment">//! atomically-reference-counted container, [`Arc`].</span> <span class="doccomment">//!</span> <span class="doccomment">//! Fatal logic errors in Rust cause *thread panic*, during which</span> <span class="doccomment">//! a thread will unwind the stack, running destructors and freeing</span> <span class="doccomment">//! owned resources. While not meant as a 'try/catch' mechanism, panics</span> <span class="doccomment">//! in Rust can nonetheless be caught (unless compiling with `panic=abort`) with</span> <span class="doccomment">//! [`catch_unwind`](../../std/panic/fn.catch_unwind.html) and recovered</span> <span class="doccomment">//! from, or alternatively be resumed with</span> <span class="doccomment">//! [`resume_unwind`](../../std/panic/fn.resume_unwind.html). If the panic</span> <span class="doccomment">//! is not caught the thread will exit, but the panic may optionally be</span> <span class="doccomment">//! detected from a different thread with [`join`]. If the main thread panics</span> <span class="doccomment">//! without the panic being caught, the application will exit with a</span> <span class="doccomment">//! non-zero exit code.</span> <span class="doccomment">//!</span> <span class="doccomment">//! When the main thread of a Rust program terminates, the entire program shuts</span> <span class="doccomment">//! down, even if other threads are still running. However, this module provides</span> <span class="doccomment">//! convenient facilities for automatically waiting for the termination of a</span> <span class="doccomment">//! child thread (i.e., join).</span> <span class="doccomment">//!</span> <span class="doccomment">//! ## Spawning a thread</span> <span class="doccomment">//!</span> <span class="doccomment">//! A new thread can be spawned using the [`thread::spawn`][`spawn`] function:</span> <span class="doccomment">//!</span> <span class="doccomment">//! ```rust</span> <span class="doccomment">//! use std::thread;</span> <span class="doccomment">//!</span> <span class="doccomment">//! thread::spawn(move || {</span> <span class="doccomment">//! // some work here</span> <span class="doccomment">//! });</span> <span class="doccomment">//! ```</span> <span class="doccomment">//!</span> <span class="doccomment">//! In this example, the spawned thread is "detached" from the current</span> <span class="doccomment">//! thread. This means that it can outlive its parent (the thread that spawned</span> <span class="doccomment">//! it), unless this parent is the main thread.</span> <span class="doccomment">//!</span> <span class="doccomment">//! The parent thread can also wait on the completion of the child</span> <span class="doccomment">//! thread; a call to [`spawn`] produces a [`JoinHandle`], which provides</span> <span class="doccomment">//! a `join` method for waiting:</span> <span class="doccomment">//!</span> <span class="doccomment">//! ```rust</span> <span class="doccomment">//! use std::thread;</span> <span class="doccomment">//!</span> <span class="doccomment">//! let child = thread::spawn(move || {</span> <span class="doccomment">//! // some work here</span> <span class="doccomment">//! });</span> <span class="doccomment">//! // some work here</span> <span class="doccomment">//! let res = child.join();</span> <span class="doccomment">//! ```</span> <span class="doccomment">//!</span> <span class="doccomment">//! The [`join`] method returns a [`thread::Result`] containing [`Ok`] of the final</span> <span class="doccomment">//! value produced by the child thread, or [`Err`] of the value given to</span> <span class="doccomment">//! a call to [`panic!`] if the child panicked.</span> <span class="doccomment">//!</span> <span class="doccomment">//! ## Configuring threads</span> <span class="doccomment">//!</span> <span class="doccomment">//! A new thread can be configured before it is spawned via the [`Builder`] type,</span> <span class="doccomment">//! which currently allows you to set the name and stack size for the child thread:</span> <span class="doccomment">//!</span> <span class="doccomment">//! ```rust</span> <span class="doccomment">//! # #![allow(unused_must_use)]</span> <span class="doccomment">//! use std::thread;</span> <span class="doccomment">//!</span> <span class="doccomment">//! thread::Builder::new().name("child1".to_string()).spawn(move || {</span> <span class="doccomment">//! println!("Hello, world!");</span> <span class="doccomment">//! });</span> <span class="doccomment">//! ```</span> <span class="doccomment">//!</span> <span class="doccomment">//! ## The `Thread` type</span> <span class="doccomment">//!</span> <span class="doccomment">//! Threads are represented via the [`Thread`] type, which you can get in one of</span> <span class="doccomment">//! two ways:</span> <span class="doccomment">//!</span> <span class="doccomment">//! * By spawning a new thread, e.g. using the [`thread::spawn`][`spawn`]</span> <span class="doccomment">//! function, and calling [`thread`][`JoinHandle::thread`] on the [`JoinHandle`].</span> <span class="doccomment">//! * By requesting the current thread, using the [`thread::current`] function.</span> <span class="doccomment">//!</span> <span class="doccomment">//! The [`thread::current`] function is available even for threads not spawned</span> <span class="doccomment">//! by the APIs of this module.</span> <span class="doccomment">//!</span> <span class="doccomment">//! ## Thread-local storage</span> <span class="doccomment">//!</span> <span class="doccomment">//! This module also provides an implementation of thread-local storage for Rust</span> <span class="doccomment">//! programs. Thread-local storage is a method of storing data into a global</span> <span class="doccomment">//! variable that each thread in the program will have its own copy of.</span> <span class="doccomment">//! Threads do not share this data, so accesses do not need to be synchronized.</span> <span class="doccomment">//!</span> <span class="doccomment">//! A thread-local key owns the value it contains and will destroy the value when the</span> <span class="doccomment">//! thread exits. It is created with the [`thread_local!`] macro and can contain any</span> <span class="doccomment">//! value that is `'static` (no borrowed pointers). It provides an accessor function,</span> <span class="doccomment">//! [`with`], that yields a shared reference to the value to the specified</span> <span class="doccomment">//! closure. Thread-local keys allow only shared access to values, as there would be no</span> <span class="doccomment">//! way to guarantee uniqueness if mutable borrows were allowed. Most values</span> <span class="doccomment">//! will want to make use of some form of **interior mutability** through the</span> <span class="doccomment">//! [`Cell`] or [`RefCell`] types.</span> <span class="doccomment">//!</span> <span class="doccomment">//! ## Naming threads</span> <span class="doccomment">//!</span> <span class="doccomment">//! Threads are able to have associated names for identification purposes. By default, spawned</span> <span class="doccomment">//! threads are unnamed. To specify a name for a thread, build the thread with [`Builder`] and pass</span> <span class="doccomment">//! the desired thread name to [`Builder::name`]. To retrieve the thread name from within the</span> <span class="doccomment">//! thread, use [`Thread::name`]. A couple examples of where the name of a thread gets used:</span> <span class="doccomment">//!</span> <span class="doccomment">//! * If a panic occurs in a named thread, the thread name will be printed in the panic message.</span> <span class="doccomment">//! * The thread name is provided to the OS where applicable (e.g. `pthread_setname_np` in</span> <span class="doccomment">//! unix-like platforms).</span> <span class="doccomment">//!</span> <span class="doccomment">//! ## Stack size</span> <span class="doccomment">//!</span> <span class="doccomment">//! The default stack size for spawned threads is 2 MiB, though this particular stack size is</span> <span class="doccomment">//! subject to change in the future. There are two ways to manually specify the stack size for</span> <span class="doccomment">//! spawned threads:</span> <span class="doccomment">//!</span> <span class="doccomment">//! * Build the thread with [`Builder`] and pass the desired stack size to [`Builder::stack_size`].</span> <span class="doccomment">//! * Set the `RUST_MIN_STACK` environment variable to an integer representing the desired stack</span> <span class="doccomment">//! size (in bytes). Note that setting [`Builder::stack_size`] will override this.</span> <span class="doccomment">//!</span> <span class="doccomment">//! Note that the stack size of the main thread is *not* determined by Rust.</span> <span class="doccomment">//!</span> <span class="doccomment">//! [channels]: ../../std/sync/mpsc/index.html</span> <span class="doccomment">//! [`Arc`]: ../../std/sync/struct.Arc.html</span> <span class="doccomment">//! [`spawn`]: ../../std/thread/fn.spawn.html</span> <span class="doccomment">//! [`JoinHandle`]: ../../std/thread/struct.JoinHandle.html</span> <span class="doccomment">//! [`JoinHandle::thread`]: ../../std/thread/struct.JoinHandle.html#method.thread</span> <span class="doccomment">//! [`join`]: ../../std/thread/struct.JoinHandle.html#method.join</span> <span class="doccomment">//! [`Result`]: ../../std/result/enum.Result.html</span> <span class="doccomment">//! [`Ok`]: ../../std/result/enum.Result.html#variant.Ok</span> <span class="doccomment">//! [`Err`]: ../../std/result/enum.Result.html#variant.Err</span> <span class="doccomment">//! [`panic!`]: ../../std/macro.panic.html</span> <span class="doccomment">//! [`Builder`]: ../../std/thread/struct.Builder.html</span> <span class="doccomment">//! [`Builder::stack_size`]: ../../std/thread/struct.Builder.html#method.stack_size</span> <span class="doccomment">//! [`Builder::name`]: ../../std/thread/struct.Builder.html#method.name</span> <span class="doccomment">//! [`thread::current`]: ../../std/thread/fn.current.html</span> <span class="doccomment">//! [`thread::Result`]: ../../std/thread/type.Result.html</span> <span class="doccomment">//! [`Thread`]: ../../std/thread/struct.Thread.html</span> <span class="doccomment">//! [`park`]: ../../std/thread/fn.park.html</span> <span class="doccomment">//! [`unpark`]: ../../std/thread/struct.Thread.html#method.unpark</span> <span class="doccomment">//! [`Thread::name`]: ../../std/thread/struct.Thread.html#method.name</span> <span class="doccomment">//! [`thread::park_timeout`]: ../../std/thread/fn.park_timeout.html</span> <span class="doccomment">//! [`Cell`]: ../cell/struct.Cell.html</span> <span class="doccomment">//! [`RefCell`]: ../cell/struct.RefCell.html</span> <span class="doccomment">//! [`thread_local!`]: ../macro.thread_local.html</span> <span class="doccomment">//! [`with`]: struct.LocalKey.html#method.with</span> <span class="attribute">#![<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">use</span> <span class="ident">any</span>::<span class="ident">Any</span>; <span class="kw">use</span> <span class="ident">cell</span>::<span class="ident">UnsafeCell</span>; <span class="kw">use</span> <span class="ident">ffi</span>::{<span class="ident">CStr</span>, <span class="ident">CString</span>}; <span class="kw">use</span> <span class="ident">fmt</span>; <span class="kw">use</span> <span class="ident">io</span>; <span class="kw">use</span> <span class="ident">panic</span>; <span class="kw">use</span> <span class="ident">panicking</span>; <span class="kw">use</span> <span class="ident">str</span>; <span class="kw">use</span> <span class="ident">sync</span>::{<span class="ident">Mutex</span>, <span class="ident">Condvar</span>, <span class="ident">Arc</span>}; <span class="kw">use</span> <span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">AtomicUsize</span>; <span class="kw">use</span> <span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>; <span class="kw">use</span> <span class="ident">sys</span>::<span class="ident">thread</span> <span class="kw">as</span> <span class="ident">imp</span>; <span class="kw">use</span> <span class="ident">sys_common</span>::<span class="ident">mutex</span>; <span class="kw">use</span> <span class="ident">sys_common</span>::<span class="ident">thread_info</span>; <span class="kw">use</span> <span class="ident">sys_common</span>::<span class="ident">thread</span>; <span class="kw">use</span> <span class="ident">sys_common</span>::{<span class="ident">AsInner</span>, <span class="ident">IntoInner</span>}; <span class="kw">use</span> <span class="ident">time</span>::<span class="ident">Duration</span>; <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="comment">// Thread-local storage</span> <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">mod</span> <span class="ident">local</span>; <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">local</span>::{<span class="ident">LocalKey</span>, <span class="ident">AccessError</span>}; <span class="comment">// The types used by the thread_local! macro to access TLS keys. Note that there</span> <span class="comment">// are two types, the "OS" type and the "fast" type. The OS thread local key</span> <span class="comment">// type is accessed via platform-specific API calls and is slow, while the fast</span> <span class="comment">// key type is accessed via code generated via LLVM, where TLS keys are set up</span> <span class="comment">// by the elf linker. Note that the OS TLS type is always available: on macOS</span> <span class="comment">// the standard library is compiled with support for older platform versions</span> <span class="comment">// where fast TLS was not available; end-user code is compiled with fast TLS</span> <span class="comment">// where available, but both are needed.</span> <span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"libstd_thread_internals"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"0"</span>)]</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"wasm32"</span>)]</span> <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span> <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">local</span>::<span class="ident">statik</span>::<span class="ident">Key</span> <span class="kw">as</span> <span class="ident">__StaticLocalKeyInner</span>; <span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"libstd_thread_internals"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"0"</span>)]</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_thread_local</span>)]</span> <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span> <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">local</span>::<span class="ident">fast</span>::<span class="ident">Key</span> <span class="kw">as</span> <span class="ident">__FastLocalKeyInner</span>; <span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"libstd_thread_internals"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"0"</span>)]</span> <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span> <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">local</span>::<span class="ident">os</span>::<span class="ident">Key</span> <span class="kw">as</span> <span class="ident">__OsLocalKeyInner</span>; <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="comment">// Builder</span> <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="doccomment">/// Thread factory, which can be used in order to configure the properties of</span> <span class="doccomment">/// a new thread.</span> <span class="doccomment">///</span> <span class="doccomment">/// Methods can be chained on it in order to configure it.</span> <span class="doccomment">///</span> <span class="doccomment">/// The two configurations available are:</span> <span class="doccomment">///</span> <span class="doccomment">/// - [`name`]: specifies an [associated name for the thread][naming-threads]</span> <span class="doccomment">/// - [`stack_size`]: specifies the [desired stack size for the thread][stack-size]</span> <span class="doccomment">///</span> <span class="doccomment">/// The [`spawn`] method will take ownership of the builder and create an</span> <span class="doccomment">/// [`io::Result`] to the thread handle with the given configuration.</span> <span class="doccomment">///</span> <span class="doccomment">/// The [`thread::spawn`] free function uses a `Builder` with default</span> <span class="doccomment">/// configuration and [`unwrap`]s its return value.</span> <span class="doccomment">///</span> <span class="doccomment">/// You may want to use [`spawn`] instead of [`thread::spawn`], when you want</span> <span class="doccomment">/// to recover from a failure to launch a thread, indeed the free function will</span> <span class="doccomment">/// panick where the `Builder` method will return a [`io::Result`].</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let builder = thread::Builder::new();</span> <span class="doccomment">///</span> <span class="doccomment">/// let handler = builder.spawn(|| {</span> <span class="doccomment">/// // thread code</span> <span class="doccomment">/// }).unwrap();</span> <span class="doccomment">///</span> <span class="doccomment">/// handler.join().unwrap();</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [`thread::spawn`]: ../../std/thread/fn.spawn.html</span> <span class="doccomment">/// [`stack_size`]: ../../std/thread/struct.Builder.html#method.stack_size</span> <span class="doccomment">/// [`name`]: ../../std/thread/struct.Builder.html#method.name</span> <span class="doccomment">/// [`spawn`]: ../../std/thread/struct.Builder.html#method.spawn</span> <span class="doccomment">/// [`io::Result`]: ../../std/io/type.Result.html</span> <span class="doccomment">/// [`unwrap`]: ../../std/result/enum.Result.html#method.unwrap</span> <span class="doccomment">/// [naming-threads]: ./index.html#naming-threads</span> <span class="doccomment">/// [stack-size]: ./index.html#stack-size</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</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">Builder</span> { <span class="comment">// A name for the thread-to-be, for identification in panic messages</span> <span class="ident">name</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="comment">// The size of the stack for the spawned thread in bytes</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="kw">impl</span> <span class="ident">Builder</span> { <span class="doccomment">/// Generates the base configuration for spawning a thread, from which</span> <span class="doccomment">/// configuration methods can be chained.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let builder = thread::Builder::new()</span> <span class="doccomment">/// .name("foo".into())</span> <span class="doccomment">/// .stack_size(10);</span> <span class="doccomment">///</span> <span class="doccomment">/// let handler = builder.spawn(|| {</span> <span class="doccomment">/// // thread code</span> <span class="doccomment">/// }).unwrap();</span> <span class="doccomment">///</span> <span class="doccomment">/// handler.join().unwrap();</span> <span class="doccomment">/// ```</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="ident">Builder</span> { <span class="ident">Builder</span> { <span class="ident">name</span>: <span class="prelude-val">None</span>, <span class="ident">stack_size</span>: <span class="prelude-val">None</span>, } } <span class="doccomment">/// Names the thread-to-be. Currently the name is used for identification</span> <span class="doccomment">/// only in panic messages.</span> <span class="doccomment">///</span> <span class="doccomment">/// The name must not contain null bytes (`\0`).</span> <span class="doccomment">///</span> <span class="doccomment">/// For more information about named threads, see</span> <span class="doccomment">/// [this module-level documentation][naming-threads].</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let builder = thread::Builder::new()</span> <span class="doccomment">/// .name("foo".into());</span> <span class="doccomment">///</span> <span class="doccomment">/// let handler = builder.spawn(|| {</span> <span class="doccomment">/// assert_eq!(thread::current().name(), Some("foo"))</span> <span class="doccomment">/// }).unwrap();</span> <span class="doccomment">///</span> <span class="doccomment">/// handler.join().unwrap();</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [naming-threads]: ./index.html#naming-threads</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">name</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">name</span>: <span class="ident">String</span>) <span class="op">-></span> <span class="ident">Builder</span> { <span class="self">self</span>.<span class="ident">name</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">name</span>); <span class="self">self</span> } <span class="doccomment">/// Sets the size of the stack (in bytes) for the new thread.</span> <span class="doccomment">///</span> <span class="doccomment">/// The actual stack size may be greater than this value if</span> <span class="doccomment">/// the platform specifies minimal stack size.</span> <span class="doccomment">///</span> <span class="doccomment">/// For more information about the stack size for threads, see</span> <span class="doccomment">/// [this module-level documentation][stack-size].</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let builder = thread::Builder::new().stack_size(32 * 1024);</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [stack-size]: ./index.html#stack-size</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</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">size</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">Builder</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">size</span>); <span class="self">self</span> } <span class="doccomment">/// Spawns a new thread by taking ownership of the `Builder`, and returns an</span> <span class="doccomment">/// [`io::Result`] to its [`JoinHandle`].</span> <span class="doccomment">///</span> <span class="doccomment">/// The spawned thread may outlive the caller (unless the caller thread</span> <span class="doccomment">/// is the main thread; the whole process is terminated when the main</span> <span class="doccomment">/// thread finishes). The join handle can be used to block on</span> <span class="doccomment">/// termination of the child thread, including recovering its panics.</span> <span class="doccomment">///</span> <span class="doccomment">/// For a more complete documentation see [`thread::spawn`][`spawn`].</span> <span class="doccomment">///</span> <span class="doccomment">/// # Errors</span> <span class="doccomment">///</span> <span class="doccomment">/// Unlike the [`spawn`] free function, this method yields an</span> <span class="doccomment">/// [`io::Result`] to capture any failure to create the thread at</span> <span class="doccomment">/// the OS level.</span> <span class="doccomment">///</span> <span class="doccomment">/// [`spawn`]: ../../std/thread/fn.spawn.html</span> <span class="doccomment">/// [`io::Result`]: ../../std/io/type.Result.html</span> <span class="doccomment">/// [`JoinHandle`]: ../../std/thread/struct.JoinHandle.html</span> <span class="doccomment">///</span> <span class="doccomment">/// # Panics</span> <span class="doccomment">///</span> <span class="doccomment">/// Panics if a thread name was set and it contained null bytes.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let builder = thread::Builder::new();</span> <span class="doccomment">///</span> <span class="doccomment">/// let handler = builder.spawn(|| {</span> <span class="doccomment">/// // thread code</span> <span class="doccomment">/// }).unwrap();</span> <span class="doccomment">///</span> <span class="doccomment">/// handler.join().unwrap();</span> <span class="doccomment">/// ```</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">spawn</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">T</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">JoinHandle</span><span class="op"><</span><span class="ident">T</span><span class="op">>></span> <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>() <span class="op">-></span> <span class="ident">T</span>, <span class="ident">F</span>: <span class="ident">Send</span> <span class="op">+</span> <span class="lifetime">'static</span>, <span class="ident">T</span>: <span class="ident">Send</span> <span class="op">+</span> <span class="lifetime">'static</span> { <span class="kw">let</span> <span class="ident">Builder</span> { <span class="ident">name</span>, <span class="ident">stack_size</span> } <span class="op">=</span> <span class="self">self</span>; <span class="kw">let</span> <span class="ident">stack_size</span> <span class="op">=</span> <span class="ident">stack_size</span>.<span class="ident">unwrap_or_else</span>(<span class="ident">thread</span>::<span class="ident">min_stack</span>); <span class="kw">let</span> <span class="ident">my_thread</span> <span class="op">=</span> <span class="ident">Thread</span>::<span class="ident">new</span>(<span class="ident">name</span>); <span class="kw">let</span> <span class="ident">their_thread</span> <span class="op">=</span> <span class="ident">my_thread</span>.<span class="ident">clone</span>(); <span class="kw">let</span> <span class="ident">my_packet</span> : <span class="ident">Arc</span><span class="op"><</span><span class="ident">UnsafeCell</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">>></span><span class="op">>></span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">UnsafeCell</span>::<span class="ident">new</span>(<span class="prelude-val">None</span>)); <span class="kw">let</span> <span class="ident">their_packet</span> <span class="op">=</span> <span class="ident">my_packet</span>.<span class="ident">clone</span>(); <span class="kw">let</span> <span class="ident">main</span> <span class="op">=</span> <span class="kw">move</span> <span class="op">||</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">their_thread</span>.<span class="ident">cname</span>() { <span class="ident">imp</span>::<span class="ident">Thread</span>::<span class="ident">set_name</span>(<span class="ident">name</span>); } <span class="kw">unsafe</span> { <span class="ident">thread_info</span>::<span class="ident">set</span>(<span class="ident">imp</span>::<span class="ident">guard</span>::<span class="ident">current</span>(), <span class="ident">their_thread</span>); <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"backtrace"</span>)]</span> <span class="kw">let</span> <span class="ident">try_result</span> <span class="op">=</span> <span class="ident">panic</span>::<span class="ident">catch_unwind</span>(<span class="ident">panic</span>::<span class="ident">AssertUnwindSafe</span>(<span class="op">||</span> { ::<span class="ident">sys_common</span>::<span class="ident">backtrace</span>::<span class="ident">__rust_begin_short_backtrace</span>(<span class="ident">f</span>) })); <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"backtrace"</span>))]</span> <span class="kw">let</span> <span class="ident">try_result</span> <span class="op">=</span> <span class="ident">panic</span>::<span class="ident">catch_unwind</span>(<span class="ident">panic</span>::<span class="ident">AssertUnwindSafe</span>(<span class="ident">f</span>)); <span class="kw-2">*</span><span class="ident">their_packet</span>.<span class="ident">get</span>() <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">try_result</span>); } }; <span class="prelude-val">Ok</span>(<span class="ident">JoinHandle</span>(<span class="ident">JoinInner</span> { <span class="ident">native</span>: <span class="kw">unsafe</span> { <span class="prelude-val">Some</span>(<span class="ident">imp</span>::<span class="ident">Thread</span>::<span class="ident">new</span>(<span class="ident">stack_size</span>, <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">main</span>))<span class="question-mark">?</span>) }, <span class="ident">thread</span>: <span class="ident">my_thread</span>, <span class="ident">packet</span>: <span class="ident">Packet</span>(<span class="ident">my_packet</span>), })) } } <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="comment">// Free functions</span> <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="doccomment">/// Spawns a new thread, returning a [`JoinHandle`] for it.</span> <span class="doccomment">///</span> <span class="doccomment">/// The join handle will implicitly *detach* the child thread upon being</span> <span class="doccomment">/// dropped. In this case, the child thread may outlive the parent (unless</span> <span class="doccomment">/// the parent thread is the main thread; the whole process is terminated when</span> <span class="doccomment">/// the main thread finishes). Additionally, the join handle provides a [`join`]</span> <span class="doccomment">/// method that can be used to join the child thread. If the child thread</span> <span class="doccomment">/// panics, [`join`] will return an [`Err`] containing the argument given to</span> <span class="doccomment">/// [`panic`].</span> <span class="doccomment">///</span> <span class="doccomment">/// This will create a thread using default parameters of [`Builder`], if you</span> <span class="doccomment">/// want to specify the stack size or the name of the thread, use this API</span> <span class="doccomment">/// instead.</span> <span class="doccomment">///</span> <span class="doccomment">/// As you can see in the signature of `spawn` there are two constraints on</span> <span class="doccomment">/// both the closure given to `spawn` and its return value, let's explain them:</span> <span class="doccomment">///</span> <span class="doccomment">/// - The `'static` constraint means that the closure and its return value</span> <span class="doccomment">/// must have a lifetime of the whole program execution. The reason for this</span> <span class="doccomment">/// is that threads can `detach` and outlive the lifetime they have been</span> <span class="doccomment">/// created in.</span> <span class="doccomment">/// Indeed if the thread, and by extension its return value, can outlive their</span> <span class="doccomment">/// caller, we need to make sure that they will be valid afterwards, and since</span> <span class="doccomment">/// we *can't* know when it will return we need to have them valid as long as</span> <span class="doccomment">/// possible, that is until the end of the program, hence the `'static`</span> <span class="doccomment">/// lifetime.</span> <span class="doccomment">/// - The [`Send`] constraint is because the closure will need to be passed</span> <span class="doccomment">/// *by value* from the thread where it is spawned to the new thread. Its</span> <span class="doccomment">/// return value will need to be passed from the new thread to the thread</span> <span class="doccomment">/// where it is `join`ed.</span> <span class="doccomment">/// As a reminder, the [`Send`] marker trait expresses that it is safe to be</span> <span class="doccomment">/// passed from thread to thread. [`Sync`] expresses that it is safe to have a</span> <span class="doccomment">/// reference be passed from thread to thread.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Panics</span> <span class="doccomment">///</span> <span class="doccomment">/// Panics if the OS fails to create a thread; use [`Builder::spawn`]</span> <span class="doccomment">/// to recover from such errors.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// Creating a thread.</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let handler = thread::spawn(|| {</span> <span class="doccomment">/// // thread code</span> <span class="doccomment">/// });</span> <span class="doccomment">///</span> <span class="doccomment">/// handler.join().unwrap();</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// As mentioned in the module documentation, threads are usually made to</span> <span class="doccomment">/// communicate using [`channels`], here is how it usually looks.</span> <span class="doccomment">///</span> <span class="doccomment">/// This example also shows how to use `move`, in order to give ownership</span> <span class="doccomment">/// of values to a thread.</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">/// use std::sync::mpsc::channel;</span> <span class="doccomment">///</span> <span class="doccomment">/// let (tx, rx) = channel();</span> <span class="doccomment">///</span> <span class="doccomment">/// let sender = thread::spawn(move || {</span> <span class="doccomment">/// tx.send("Hello, thread".to_owned())</span> <span class="doccomment">/// .expect("Unable to send on channel");</span> <span class="doccomment">/// });</span> <span class="doccomment">///</span> <span class="doccomment">/// let receiver = thread::spawn(move || {</span> <span class="doccomment">/// let value = rx.recv().expect("Unable to receive from channel");</span> <span class="doccomment">/// println!("{}", value);</span> <span class="doccomment">/// });</span> <span class="doccomment">///</span> <span class="doccomment">/// sender.join().expect("The sender thread has panicked");</span> <span class="doccomment">/// receiver.join().expect("The receiver thread has panicked");</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// A thread can also return a value through its [`JoinHandle`], you can use</span> <span class="doccomment">/// this to make asynchronous computations (futures might be more appropriate</span> <span class="doccomment">/// though).</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let computation = thread::spawn(|| {</span> <span class="doccomment">/// // Some expensive computation.</span> <span class="doccomment">/// 42</span> <span class="doccomment">/// });</span> <span class="doccomment">///</span> <span class="doccomment">/// let result = computation.join().unwrap();</span> <span class="doccomment">/// println!("{}", result);</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [`channels`]: ../../std/sync/mpsc/index.html</span> <span class="doccomment">/// [`JoinHandle`]: ../../std/thread/struct.JoinHandle.html</span> <span class="doccomment">/// [`join`]: ../../std/thread/struct.JoinHandle.html#method.join</span> <span class="doccomment">/// [`Err`]: ../../std/result/enum.Result.html#variant.Err</span> <span class="doccomment">/// [`panic`]: ../../std/macro.panic.html</span> <span class="doccomment">/// [`Builder::spawn`]: ../../std/thread/struct.Builder.html#method.spawn</span> <span class="doccomment">/// [`Builder`]: ../../std/thread/struct.Builder.html</span> <span class="doccomment">/// [`Send`]: ../../std/marker/trait.Send.html</span> <span class="doccomment">/// [`Sync`]: ../../std/marker/trait.Sync.html</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">spawn</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">T</span><span class="op">></span>(<span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">JoinHandle</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>() <span class="op">-></span> <span class="ident">T</span>, <span class="ident">F</span>: <span class="ident">Send</span> <span class="op">+</span> <span class="lifetime">'static</span>, <span class="ident">T</span>: <span class="ident">Send</span> <span class="op">+</span> <span class="lifetime">'static</span> { <span class="ident">Builder</span>::<span class="ident">new</span>().<span class="ident">spawn</span>(<span class="ident">f</span>).<span class="ident">unwrap</span>() } <span class="doccomment">/// Gets a handle to the thread that invokes it.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// Getting a handle to the current thread with `thread::current()`:</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let handler = thread::Builder::new()</span> <span class="doccomment">/// .name("named thread".into())</span> <span class="doccomment">/// .spawn(|| {</span> <span class="doccomment">/// let handle = thread::current();</span> <span class="doccomment">/// assert_eq!(handle.name(), Some("named thread"));</span> <span class="doccomment">/// })</span> <span class="doccomment">/// .unwrap();</span> <span class="doccomment">///</span> <span class="doccomment">/// handler.join().unwrap();</span> <span class="doccomment">/// ```</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">current</span>() <span class="op">-></span> <span class="ident">Thread</span> { <span class="ident">thread_info</span>::<span class="ident">current_thread</span>().<span class="ident">expect</span>(<span class="string">"use of std::thread::current() is not \ possible after the thread's local \ data has been destroyed"</span>) } <span class="doccomment">/// Cooperatively gives up a timeslice to the OS scheduler.</span> <span class="doccomment">///</span> <span class="doccomment">/// This is used when the programmer knows that the thread will have nothing</span> <span class="doccomment">/// to do for some time, and thus avoid wasting computing time.</span> <span class="doccomment">///</span> <span class="doccomment">/// For example when polling on a resource, it is common to check that it is</span> <span class="doccomment">/// available, and if not to yield in order to avoid busy waiting.</span> <span class="doccomment">///</span> <span class="doccomment">/// Thus the pattern of `yield`ing after a failed poll is rather common when</span> <span class="doccomment">/// implementing low-level shared resources or synchronization primitives.</span> <span class="doccomment">///</span> <span class="doccomment">/// However programmers will usually prefer to use, [`channel`]s, [`Condvar`]s,</span> <span class="doccomment">/// [`Mutex`]es or [`join`] for their synchronization routines, as they avoid</span> <span class="doccomment">/// thinking about thread scheduling.</span> <span class="doccomment">///</span> <span class="doccomment">/// Note that [`channel`]s for example are implemented using this primitive.</span> <span class="doccomment">/// Indeed when you call `send` or `recv`, which are blocking, they will yield</span> <span class="doccomment">/// if the channel is not available.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// thread::yield_now();</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [`channel`]: ../../std/sync/mpsc/index.html</span> <span class="doccomment">/// [`spawn`]: ../../std/thread/fn.spawn.html</span> <span class="doccomment">/// [`join`]: ../../std/thread/struct.JoinHandle.html#method.join</span> <span class="doccomment">/// [`Mutex`]: ../../std/sync/struct.Mutex.html</span> <span class="doccomment">/// [`Condvar`]: ../../std/sync/struct.Condvar.html</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">yield_now</span>() { <span class="ident">imp</span>::<span class="ident">Thread</span>::<span class="ident">yield_now</span>() } <span class="doccomment">/// Determines whether the current thread is unwinding because of panic.</span> <span class="doccomment">///</span> <span class="doccomment">/// A common use of this feature is to poison shared resources when writing</span> <span class="doccomment">/// unsafe code, by checking `panicking` when the `drop` is called.</span> <span class="doccomment">///</span> <span class="doccomment">/// This is usually not needed when writing safe code, as [`Mutex`es][Mutex]</span> <span class="doccomment">/// already poison themselves when a thread panics while holding the lock.</span> <span class="doccomment">///</span> <span class="doccomment">/// This can also be used in multithreaded applications, in order to send a</span> <span class="doccomment">/// message to other threads warning that a thread has panicked (e.g. for</span> <span class="doccomment">/// monitoring purposes).</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```should_panic</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// struct SomeStruct;</span> <span class="doccomment">///</span> <span class="doccomment">/// impl Drop for SomeStruct {</span> <span class="doccomment">/// fn drop(&mut self) {</span> <span class="doccomment">/// if thread::panicking() {</span> <span class="doccomment">/// println!("dropped while unwinding");</span> <span class="doccomment">/// } else {</span> <span class="doccomment">/// println!("dropped while not unwinding");</span> <span class="doccomment">/// }</span> <span class="doccomment">/// }</span> <span class="doccomment">/// }</span> <span class="doccomment">///</span> <span class="doccomment">/// {</span> <span class="doccomment">/// print!("a: ");</span> <span class="doccomment">/// let a = SomeStruct;</span> <span class="doccomment">/// }</span> <span class="doccomment">///</span> <span class="doccomment">/// {</span> <span class="doccomment">/// print!("b: ");</span> <span class="doccomment">/// let b = SomeStruct;</span> <span class="doccomment">/// panic!()</span> <span class="doccomment">/// }</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [Mutex]: ../../std/sync/struct.Mutex.html</span> <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">panicking</span>() <span class="op">-></span> <span class="ident">bool</span> { <span class="ident">panicking</span>::<span class="ident">panicking</span>() } <span class="doccomment">/// Puts the current thread to sleep for the specified amount of time.</span> <span class="doccomment">///</span> <span class="doccomment">/// The thread may sleep longer than the duration specified due to scheduling</span> <span class="doccomment">/// specifics or platform-dependent functionality.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Platform-specific behavior</span> <span class="doccomment">///</span> <span class="doccomment">/// On Unix platforms this function will not return early due to a</span> <span class="doccomment">/// signal being received or a spurious wakeup.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```no_run</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// // Let's sleep for 2 seconds:</span> <span class="doccomment">/// thread::sleep_ms(2000);</span> <span class="doccomment">/// ```</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="attribute">#[<span class="ident">rustc_deprecated</span>(<span class="ident">since</span> <span class="op">=</span> <span class="string">"1.6.0"</span>, <span class="ident">reason</span> <span class="op">=</span> <span class="string">"replaced by `std::thread::sleep`"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sleep_ms</span>(<span class="ident">ms</span>: <span class="ident">u32</span>) { <span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="ident">ms</span> <span class="kw">as</span> <span class="ident">u64</span>)) } <span class="doccomment">/// Puts the current thread to sleep for the specified amount of time.</span> <span class="doccomment">///</span> <span class="doccomment">/// The thread may sleep longer than the duration specified due to scheduling</span> <span class="doccomment">/// specifics or platform-dependent functionality.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Platform-specific behavior</span> <span class="doccomment">///</span> <span class="doccomment">/// On Unix platforms this function will not return early due to a</span> <span class="doccomment">/// signal being received or a spurious wakeup. Platforms which do not support</span> <span class="doccomment">/// nanosecond precision for sleeping will have `dur` rounded up to the nearest</span> <span class="doccomment">/// granularity of time they can sleep for.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```no_run</span> <span class="doccomment">/// use std::{thread, time};</span> <span class="doccomment">///</span> <span class="doccomment">/// let ten_millis = time::Duration::from_millis(10);</span> <span class="doccomment">/// let now = time::Instant::now();</span> <span class="doccomment">///</span> <span class="doccomment">/// thread::sleep(ten_millis);</span> <span class="doccomment">///</span> <span class="doccomment">/// assert!(now.elapsed() >= ten_millis);</span> <span class="doccomment">/// ```</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"thread_sleep"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.4.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sleep</span>(<span class="ident">dur</span>: <span class="ident">Duration</span>) { <span class="ident">imp</span>::<span class="ident">Thread</span>::<span class="ident">sleep</span>(<span class="ident">dur</span>) } <span class="comment">// constants for park/unpark</span> <span class="kw">const</span> <span class="ident">EMPTY</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">0</span>; <span class="kw">const</span> <span class="ident">PARKED</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">1</span>; <span class="kw">const</span> <span class="ident">NOTIFIED</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">2</span>; <span class="doccomment">/// Blocks unless or until the current thread's token is made available.</span> <span class="doccomment">///</span> <span class="doccomment">/// A call to `park` does not guarantee that the thread will remain parked</span> <span class="doccomment">/// forever, and callers should be prepared for this possibility.</span> <span class="doccomment">///</span> <span class="doccomment">/// # park and unpark</span> <span class="doccomment">///</span> <span class="doccomment">/// Every thread is equipped with some basic low-level blocking support, via the</span> <span class="doccomment">/// [`thread::park`][`park`] function and [`thread::Thread::unpark`][`unpark`]</span> <span class="doccomment">/// method. [`park`] blocks the current thread, which can then be resumed from</span> <span class="doccomment">/// another thread by calling the [`unpark`] method on the blocked thread's</span> <span class="doccomment">/// handle.</span> <span class="doccomment">///</span> <span class="doccomment">/// Conceptually, each [`Thread`] handle has an associated token, which is</span> <span class="doccomment">/// initially not present:</span> <span class="doccomment">///</span> <span class="doccomment">/// * The [`thread::park`][`park`] function blocks the current thread unless or</span> <span class="doccomment">/// until the token is available for its thread handle, at which point it</span> <span class="doccomment">/// atomically consumes the token. It may also return *spuriously*, without</span> <span class="doccomment">/// consuming the token. [`thread::park_timeout`] does the same, but allows</span> <span class="doccomment">/// specifying a maximum time to block the thread for.</span> <span class="doccomment">///</span> <span class="doccomment">/// * The [`unpark`] method on a [`Thread`] atomically makes the token available</span> <span class="doccomment">/// if it wasn't already.</span> <span class="doccomment">///</span> <span class="doccomment">/// In other words, each [`Thread`] acts a bit like a spinlock that can be</span> <span class="doccomment">/// locked and unlocked using `park` and `unpark`.</span> <span class="doccomment">///</span> <span class="doccomment">/// The API is typically used by acquiring a handle to the current thread,</span> <span class="doccomment">/// placing that handle in a shared data structure so that other threads can</span> <span class="doccomment">/// find it, and then `park`ing. When some desired condition is met, another</span> <span class="doccomment">/// thread calls [`unpark`] on the handle.</span> <span class="doccomment">///</span> <span class="doccomment">/// The motivation for this design is twofold:</span> <span class="doccomment">///</span> <span class="doccomment">/// * It avoids the need to allocate mutexes and condvars when building new</span> <span class="doccomment">/// synchronization primitives; the threads already provide basic</span> <span class="doccomment">/// blocking/signaling.</span> <span class="doccomment">///</span> <span class="doccomment">/// * It can be implemented very efficiently on many platforms.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">/// use std::time::Duration;</span> <span class="doccomment">///</span> <span class="doccomment">/// let parked_thread = thread::Builder::new()</span> <span class="doccomment">/// .spawn(|| {</span> <span class="doccomment">/// println!("Parking thread");</span> <span class="doccomment">/// thread::park();</span> <span class="doccomment">/// println!("Thread unparked");</span> <span class="doccomment">/// })</span> <span class="doccomment">/// .unwrap();</span> <span class="doccomment">///</span> <span class="doccomment">/// // Let some time pass for the thread to be spawned.</span> <span class="doccomment">/// thread::sleep(Duration::from_millis(10));</span> <span class="doccomment">///</span> <span class="doccomment">/// println!("Unpark the thread");</span> <span class="doccomment">/// parked_thread.thread().unpark();</span> <span class="doccomment">///</span> <span class="doccomment">/// parked_thread.join().unwrap();</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [`Thread`]: ../../std/thread/struct.Thread.html</span> <span class="doccomment">/// [`park`]: ../../std/thread/fn.park.html</span> <span class="doccomment">/// [`unpark`]: ../../std/thread/struct.Thread.html#method.unpark</span> <span class="doccomment">/// [`thread::park_timeout`]: ../../std/thread/fn.park_timeout.html</span> <span class="comment">//</span> <span class="comment">// The implementation currently uses the trivial strategy of a Mutex+Condvar</span> <span class="comment">// with wakeup flag, which does not actually allow spurious wakeups. In the</span> <span class="comment">// future, this will be implemented in a more efficient way, perhaps along the lines of</span> <span class="comment">// http://cr.openjdk.java.net/~stefank/6989984.1/raw_files/new/src/os/linux/vm/os_linux.cpp</span> <span class="comment">// or futuxes, and in either case may allow spurious wakeups.</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">park</span>() { <span class="kw">let</span> <span class="ident">thread</span> <span class="op">=</span> <span class="ident">current</span>(); <span class="comment">// If we were previously notified then we consume this notification and</span> <span class="comment">// return quickly.</span> <span class="kw">if</span> <span class="ident">thread</span>.<span class="ident">inner</span>.<span class="ident">state</span>.<span class="ident">compare_exchange</span>(<span class="ident">NOTIFIED</span>, <span class="ident">EMPTY</span>, <span class="ident">SeqCst</span>, <span class="ident">SeqCst</span>).<span class="ident">is_ok</span>() { <span class="kw">return</span> } <span class="comment">// Otherwise we need to coordinate going to sleep</span> <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">thread</span>.<span class="ident">inner</span>.<span class="ident">lock</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>(); <span class="kw">match</span> <span class="ident">thread</span>.<span class="ident">inner</span>.<span class="ident">state</span>.<span class="ident">compare_exchange</span>(<span class="ident">EMPTY</span>, <span class="ident">PARKED</span>, <span class="ident">SeqCst</span>, <span class="ident">SeqCst</span>) { <span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=></span> {} <span class="prelude-val">Err</span>(<span class="ident">NOTIFIED</span>) <span class="op">=></span> <span class="kw">return</span>, <span class="comment">// notified after we locked</span> <span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"inconsistent park state"</span>), } <span class="kw">loop</span> { <span class="ident">m</span> <span class="op">=</span> <span class="ident">thread</span>.<span class="ident">inner</span>.<span class="ident">cvar</span>.<span class="ident">wait</span>(<span class="ident">m</span>).<span class="ident">unwrap</span>(); <span class="kw">match</span> <span class="ident">thread</span>.<span class="ident">inner</span>.<span class="ident">state</span>.<span class="ident">compare_exchange</span>(<span class="ident">NOTIFIED</span>, <span class="ident">EMPTY</span>, <span class="ident">SeqCst</span>, <span class="ident">SeqCst</span>) { <span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=></span> <span class="kw">return</span>, <span class="comment">// got a notification</span> <span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=></span> {} <span class="comment">// spurious wakeup, go back to sleep</span> } } } <span class="doccomment">/// Use [`park_timeout`].</span> <span class="doccomment">///</span> <span class="doccomment">/// Blocks unless or until the current thread's token is made available or</span> <span class="doccomment">/// the specified duration has been reached (may wake spuriously).</span> <span class="doccomment">///</span> <span class="doccomment">/// The semantics of this function are equivalent to [`park`] except</span> <span class="doccomment">/// that the thread will be blocked for roughly no longer than `dur`. This</span> <span class="doccomment">/// method should not be used for precise timing due to anomalies such as</span> <span class="doccomment">/// preemption or platform differences that may not cause the maximum</span> <span class="doccomment">/// amount of time waited to be precisely `ms` long.</span> <span class="doccomment">///</span> <span class="doccomment">/// See the [park documentation][`park`] for more detail.</span> <span class="doccomment">///</span> <span class="doccomment">/// [`park_timeout`]: fn.park_timeout.html</span> <span class="doccomment">/// [`park`]: ../../std/thread/fn.park.html</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="attribute">#[<span class="ident">rustc_deprecated</span>(<span class="ident">since</span> <span class="op">=</span> <span class="string">"1.6.0"</span>, <span class="ident">reason</span> <span class="op">=</span> <span class="string">"replaced by `std::thread::park_timeout`"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">park_timeout_ms</span>(<span class="ident">ms</span>: <span class="ident">u32</span>) { <span class="ident">park_timeout</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="ident">ms</span> <span class="kw">as</span> <span class="ident">u64</span>)) } <span class="doccomment">/// Blocks unless or until the current thread's token is made available or</span> <span class="doccomment">/// the specified duration has been reached (may wake spuriously).</span> <span class="doccomment">///</span> <span class="doccomment">/// The semantics of this function are equivalent to [`park`][park] except</span> <span class="doccomment">/// that the thread will be blocked for roughly no longer than `dur`. This</span> <span class="doccomment">/// method should not be used for precise timing due to anomalies such as</span> <span class="doccomment">/// preemption or platform differences that may not cause the maximum</span> <span class="doccomment">/// amount of time waited to be precisely `dur` long.</span> <span class="doccomment">///</span> <span class="doccomment">/// See the [park documentation][park] for more details.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Platform-specific behavior</span> <span class="doccomment">///</span> <span class="doccomment">/// Platforms which do not support nanosecond precision for sleeping will have</span> <span class="doccomment">/// `dur` rounded up to the nearest granularity of time they can sleep for.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// Waiting for the complete expiration of the timeout:</span> <span class="doccomment">///</span> <span class="doccomment">/// ```rust,no_run</span> <span class="doccomment">/// use std::thread::park_timeout;</span> <span class="doccomment">/// use std::time::{Instant, Duration};</span> <span class="doccomment">///</span> <span class="doccomment">/// let timeout = Duration::from_secs(2);</span> <span class="doccomment">/// let beginning_park = Instant::now();</span> <span class="doccomment">///</span> <span class="doccomment">/// let mut timeout_remaining = timeout;</span> <span class="doccomment">/// loop {</span> <span class="doccomment">/// park_timeout(timeout_remaining);</span> <span class="doccomment">/// let elapsed = beginning_park.elapsed();</span> <span class="doccomment">/// if elapsed >= timeout {</span> <span class="doccomment">/// break;</span> <span class="doccomment">/// }</span> <span class="doccomment">/// println!("restarting park_timeout after {:?}", elapsed);</span> <span class="doccomment">/// timeout_remaining = timeout - elapsed;</span> <span class="doccomment">/// }</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [park]: fn.park.html</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"park_timeout"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.4.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">park_timeout</span>(<span class="ident">dur</span>: <span class="ident">Duration</span>) { <span class="kw">let</span> <span class="ident">thread</span> <span class="op">=</span> <span class="ident">current</span>(); <span class="comment">// Like `park` above we have a fast path for an already-notified thread, and</span> <span class="comment">// afterwards we start coordinating for a sleep.</span> <span class="comment">// return quickly.</span> <span class="kw">if</span> <span class="ident">thread</span>.<span class="ident">inner</span>.<span class="ident">state</span>.<span class="ident">compare_exchange</span>(<span class="ident">NOTIFIED</span>, <span class="ident">EMPTY</span>, <span class="ident">SeqCst</span>, <span class="ident">SeqCst</span>).<span class="ident">is_ok</span>() { <span class="kw">return</span> } <span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">thread</span>.<span class="ident">inner</span>.<span class="ident">lock</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>(); <span class="kw">match</span> <span class="ident">thread</span>.<span class="ident">inner</span>.<span class="ident">state</span>.<span class="ident">compare_exchange</span>(<span class="ident">EMPTY</span>, <span class="ident">PARKED</span>, <span class="ident">SeqCst</span>, <span class="ident">SeqCst</span>) { <span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=></span> {} <span class="prelude-val">Err</span>(<span class="ident">NOTIFIED</span>) <span class="op">=></span> <span class="kw">return</span>, <span class="comment">// notified after we locked</span> <span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"inconsistent park_timeout state"</span>), } <span class="comment">// Wait with a timeout, and if we spuriously wake up or otherwise wake up</span> <span class="comment">// from a notification we just want to unconditionally set the state back to</span> <span class="comment">// empty, either consuming a notification or un-flagging ourselves as</span> <span class="comment">// parked.</span> <span class="kw">let</span> (<span class="ident">_m</span>, <span class="ident">_result</span>) <span class="op">=</span> <span class="ident">thread</span>.<span class="ident">inner</span>.<span class="ident">cvar</span>.<span class="ident">wait_timeout</span>(<span class="ident">m</span>, <span class="ident">dur</span>).<span class="ident">unwrap</span>(); <span class="kw">match</span> <span class="ident">thread</span>.<span class="ident">inner</span>.<span class="ident">state</span>.<span class="ident">swap</span>(<span class="ident">EMPTY</span>, <span class="ident">SeqCst</span>) { <span class="ident">NOTIFIED</span> <span class="op">=></span> {} <span class="comment">// got a notification, hurray!</span> <span class="ident">PARKED</span> <span class="op">=></span> {} <span class="comment">// no notification, alas</span> <span class="ident">n</span> <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"inconsistent park_timeout state: {}"</span>, <span class="ident">n</span>), } } <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="comment">// ThreadId</span> <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="doccomment">/// A unique identifier for a running thread.</span> <span class="doccomment">///</span> <span class="doccomment">/// A `ThreadId` is an opaque object that has a unique value for each thread</span> <span class="doccomment">/// that creates one. `ThreadId`s are not guaranteed to correspond to a thread's</span> <span class="doccomment">/// system-designated identifier. A `ThreadId` can be retrieved from the [`id`]</span> <span class="doccomment">/// method on a [`Thread`].</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let other_thread = thread::spawn(|| {</span> <span class="doccomment">/// thread::current().id()</span> <span class="doccomment">/// });</span> <span class="doccomment">///</span> <span class="doccomment">/// let other_thread_id = other_thread.join().unwrap();</span> <span class="doccomment">/// assert!(thread::current().id() != other_thread_id);</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [`id`]: ../../std/thread/struct.Thread.html#method.id</span> <span class="doccomment">/// [`Thread`]: ../../std/thread/struct.Thread.html</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"thread_id"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.19.0"</span>)]</span> <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Eq</span>, <span class="ident">PartialEq</span>, <span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Hash</span>, <span class="ident">Debug</span>)]</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ThreadId</span>(<span class="ident">u64</span>); <span class="kw">impl</span> <span class="ident">ThreadId</span> { <span class="comment">// Generate a new unique thread ID.</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="ident">ThreadId</span> { <span class="kw">static</span> <span class="ident">GUARD</span>: <span class="ident">mutex</span>::<span class="ident">Mutex</span> <span class="op">=</span> <span class="ident">mutex</span>::<span class="ident">Mutex</span>::<span class="ident">new</span>(); <span class="kw">static</span> <span class="kw-2">mut</span> <span class="ident">COUNTER</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">0</span>; <span class="kw">unsafe</span> { <span class="ident">GUARD</span>.<span class="ident">lock</span>(); <span class="comment">// If we somehow use up all our bits, panic so that we're not</span> <span class="comment">// covering up subtle bugs of IDs being reused.</span> <span class="kw">if</span> <span class="ident">COUNTER</span> <span class="op">==</span> ::<span class="ident">u64</span>::<span class="ident">MAX</span> { <span class="ident">GUARD</span>.<span class="ident">unlock</span>(); <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"failed to generate unique thread ID: bitspace exhausted"</span>); } <span class="kw">let</span> <span class="ident">id</span> <span class="op">=</span> <span class="ident">COUNTER</span>; <span class="ident">COUNTER</span> <span class="op">+=</span> <span class="number">1</span>; <span class="ident">GUARD</span>.<span class="ident">unlock</span>(); <span class="ident">ThreadId</span>(<span class="ident">id</span>) } } } <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="comment">// Thread</span> <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="doccomment">/// The internal representation of a `Thread` handle</span> <span class="kw">struct</span> <span class="ident">Inner</span> { <span class="ident">name</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">CString</span><span class="op">></span>, <span class="comment">// Guaranteed to be UTF-8</span> <span class="ident">id</span>: <span class="ident">ThreadId</span>, <span class="comment">// state for thread park/unpark</span> <span class="ident">state</span>: <span class="ident">AtomicUsize</span>, <span class="ident">lock</span>: <span class="ident">Mutex</span><span class="op"><</span>()<span class="op">></span>, <span class="ident">cvar</span>: <span class="ident">Condvar</span>, } <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>)]</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="doccomment">/// A handle to a thread.</span> <span class="doccomment">///</span> <span class="doccomment">/// Threads are represented via the `Thread` type, which you can get in one of</span> <span class="doccomment">/// two ways:</span> <span class="doccomment">///</span> <span class="doccomment">/// * By spawning a new thread, e.g. using the [`thread::spawn`][`spawn`]</span> <span class="doccomment">/// function, and calling [`thread`][`JoinHandle::thread`] on the</span> <span class="doccomment">/// [`JoinHandle`].</span> <span class="doccomment">/// * By requesting the current thread, using the [`thread::current`] function.</span> <span class="doccomment">///</span> <span class="doccomment">/// The [`thread::current`] function is available even for threads not spawned</span> <span class="doccomment">/// by the APIs of this module.</span> <span class="doccomment">///</span> <span class="doccomment">/// There is usually no need to create a `Thread` struct yourself, one</span> <span class="doccomment">/// should instead use a function like `spawn` to create new threads, see the</span> <span class="doccomment">/// docs of [`Builder`] and [`spawn`] for more details.</span> <span class="doccomment">///</span> <span class="doccomment">/// [`Builder`]: ../../std/thread/struct.Builder.html</span> <span class="doccomment">/// [`JoinHandle::thread`]: ../../std/thread/struct.JoinHandle.html#method.thread</span> <span class="doccomment">/// [`JoinHandle`]: ../../std/thread/struct.JoinHandle.html</span> <span class="doccomment">/// [`thread::current`]: ../../std/thread/fn.current.html</span> <span class="doccomment">/// [`spawn`]: ../../std/thread/fn.spawn.html</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Thread</span> { <span class="ident">inner</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Inner</span><span class="op">></span>, } <span class="kw">impl</span> <span class="ident">Thread</span> { <span class="comment">// Used only internally to construct a thread object without spawning</span> <span class="comment">// Panics if the name contains nuls.</span> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">name</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) <span class="op">-></span> <span class="ident">Thread</span> { <span class="kw">let</span> <span class="ident">cname</span> <span class="op">=</span> <span class="ident">name</span>.<span class="ident">map</span>(<span class="op">|</span><span class="ident">n</span><span class="op">|</span> { <span class="ident">CString</span>::<span class="ident">new</span>(<span class="ident">n</span>).<span class="ident">expect</span>(<span class="string">"thread name may not contain interior null bytes"</span>) }); <span class="ident">Thread</span> { <span class="ident">inner</span>: <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">Inner</span> { <span class="ident">name</span>: <span class="ident">cname</span>, <span class="ident">id</span>: <span class="ident">ThreadId</span>::<span class="ident">new</span>(), <span class="ident">state</span>: <span class="ident">AtomicUsize</span>::<span class="ident">new</span>(<span class="ident">EMPTY</span>), <span class="ident">lock</span>: <span class="ident">Mutex</span>::<span class="ident">new</span>(()), <span class="ident">cvar</span>: <span class="ident">Condvar</span>::<span class="ident">new</span>(), }) } } <span class="doccomment">/// Atomically makes the handle's token available if it is not already.</span> <span class="doccomment">///</span> <span class="doccomment">/// Every thread is equipped with some basic low-level blocking support, via</span> <span class="doccomment">/// the [`park`][park] function and the `unpark()` method. These can be</span> <span class="doccomment">/// used as a more CPU-efficient implementation of a spinlock.</span> <span class="doccomment">///</span> <span class="doccomment">/// See the [park documentation][park] for more details.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">/// use std::time::Duration;</span> <span class="doccomment">///</span> <span class="doccomment">/// let parked_thread = thread::Builder::new()</span> <span class="doccomment">/// .spawn(|| {</span> <span class="doccomment">/// println!("Parking thread");</span> <span class="doccomment">/// thread::park();</span> <span class="doccomment">/// println!("Thread unparked");</span> <span class="doccomment">/// })</span> <span class="doccomment">/// .unwrap();</span> <span class="doccomment">///</span> <span class="doccomment">/// // Let some time pass for the thread to be spawned.</span> <span class="doccomment">/// thread::sleep(Duration::from_millis(10));</span> <span class="doccomment">///</span> <span class="doccomment">/// println!("Unpark the thread");</span> <span class="doccomment">/// parked_thread.thread().unpark();</span> <span class="doccomment">///</span> <span class="doccomment">/// parked_thread.join().unwrap();</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [park]: fn.park.html</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unpark</span>(<span class="kw-2">&</span><span class="self">self</span>) { <span class="kw">loop</span> { <span class="kw">match</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">state</span>.<span class="ident">compare_exchange</span>(<span class="ident">EMPTY</span>, <span class="ident">NOTIFIED</span>, <span class="ident">SeqCst</span>, <span class="ident">SeqCst</span>) { <span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=></span> <span class="kw">return</span>, <span class="comment">// no one was waiting</span> <span class="prelude-val">Err</span>(<span class="ident">NOTIFIED</span>) <span class="op">=></span> <span class="kw">return</span>, <span class="comment">// already unparked</span> <span class="prelude-val">Err</span>(<span class="ident">PARKED</span>) <span class="op">=></span> {} <span class="comment">// gotta go wake someone up</span> <span class="kw">_</span> <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"inconsistent state in unpark"</span>), } <span class="comment">// Coordinate wakeup through the mutex and a condvar notification</span> <span class="kw">let</span> <span class="ident">_lock</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">lock</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>(); <span class="kw">match</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">state</span>.<span class="ident">compare_exchange</span>(<span class="ident">PARKED</span>, <span class="ident">NOTIFIED</span>, <span class="ident">SeqCst</span>, <span class="ident">SeqCst</span>) { <span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=></span> <span class="kw">return</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">cvar</span>.<span class="ident">notify_one</span>(), <span class="prelude-val">Err</span>(<span class="ident">NOTIFIED</span>) <span class="op">=></span> <span class="kw">return</span>, <span class="comment">// a different thread unparked</span> <span class="prelude-val">Err</span>(<span class="ident">EMPTY</span>) <span class="op">=></span> {} <span class="comment">// parked thread went away, try again</span> <span class="kw">_</span> <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"inconsistent state in unpark"</span>), } } } <span class="doccomment">/// Gets the thread's unique identifier.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let other_thread = thread::spawn(|| {</span> <span class="doccomment">/// thread::current().id()</span> <span class="doccomment">/// });</span> <span class="doccomment">///</span> <span class="doccomment">/// let other_thread_id = other_thread.join().unwrap();</span> <span class="doccomment">/// assert!(thread::current().id() != other_thread_id);</span> <span class="doccomment">/// ```</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"thread_id"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.19.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">id</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">ThreadId</span> { <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">id</span> } <span class="doccomment">/// Gets the thread's name.</span> <span class="doccomment">///</span> <span class="doccomment">/// For more information about named threads, see</span> <span class="doccomment">/// [this module-level documentation][naming-threads].</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// Threads by default have no name specified:</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let builder = thread::Builder::new();</span> <span class="doccomment">///</span> <span class="doccomment">/// let handler = builder.spawn(|| {</span> <span class="doccomment">/// assert!(thread::current().name().is_none());</span> <span class="doccomment">/// }).unwrap();</span> <span class="doccomment">///</span> <span class="doccomment">/// handler.join().unwrap();</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// Thread with a specified name:</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let builder = thread::Builder::new()</span> <span class="doccomment">/// .name("foo".into());</span> <span class="doccomment">///</span> <span class="doccomment">/// let handler = builder.spawn(|| {</span> <span class="doccomment">/// assert_eq!(thread::current().name(), Some("foo"))</span> <span class="doccomment">/// }).unwrap();</span> <span class="doccomment">///</span> <span class="doccomment">/// handler.join().unwrap();</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [naming-threads]: ./index.html#naming-threads</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">name</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> { <span class="self">self</span>.<span class="ident">cname</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="kw">unsafe</span> { <span class="ident">str</span>::<span class="ident">from_utf8_unchecked</span>(<span class="ident">s</span>.<span class="ident">to_bytes</span>()) } ) } <span class="kw">fn</span> <span class="ident">cname</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">CStr</span><span class="op">></span> { <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">name</span>.<span class="ident">as_ref</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="kw-2">&</span><span class="kw-2">*</span><span class="kw-2">*</span><span class="ident">s</span>) } } <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">Thread</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</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { <span class="ident">fmt</span>::<span class="ident">Debug</span>::<span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">name</span>(), <span class="ident">f</span>) } } <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="comment">// JoinHandle</span> <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="doccomment">/// A specialized [`Result`] type for threads.</span> <span class="doccomment">///</span> <span class="doccomment">/// Indicates the manner in which a thread exited.</span> <span class="doccomment">///</span> <span class="doccomment">/// A thread that completes without panicking is considered to exit successfully.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```no_run</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">/// use std::fs;</span> <span class="doccomment">///</span> <span class="doccomment">/// fn copy_in_thread() -> thread::Result<()> {</span> <span class="doccomment">/// thread::spawn(move || { fs::copy("foo.txt", "bar.txt").unwrap(); }).join()</span> <span class="doccomment">/// }</span> <span class="doccomment">///</span> <span class="doccomment">/// fn main() {</span> <span class="doccomment">/// match copy_in_thread() {</span> <span class="doccomment">/// Ok(_) => println!("this is fine"),</span> <span class="doccomment">/// Err(_) => println!("thread panicked"),</span> <span class="doccomment">/// }</span> <span class="doccomment">/// }</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [`Result`]: ../../std/result/enum.Result.html</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">type</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="op">=</span> ::<span class="ident">result</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Box</span><span class="op"><</span><span class="ident">Any</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="lifetime">'static</span><span class="op">>></span>; <span class="comment">// This packet is used to communicate the return value between the child thread</span> <span class="comment">// and the parent thread. Memory is shared through the `Arc` within and there's</span> <span class="comment">// no need for a mutex here because synchronization happens with `join()` (the</span> <span class="comment">// parent thread never reads this packet until the child has exited).</span> <span class="comment">//</span> <span class="comment">// This packet itself is then stored into a `JoinInner` which in turns is placed</span> <span class="comment">// in `JoinHandle` and `JoinGuard`. Due to the usage of `UnsafeCell` we need to</span> <span class="comment">// manually worry about impls like Send and Sync. The type `T` should</span> <span class="comment">// already always be Send (otherwise the thread could not have been created) and</span> <span class="comment">// this type is inherently Sync because no methods take &self. Regardless,</span> <span class="comment">// however, we add inheriting impls for Send/Sync to this type to ensure it's</span> <span class="comment">// Send/Sync and that future modifications will still appropriately classify it.</span> <span class="kw">struct</span> <span class="ident">Packet</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">Arc</span><span class="op"><</span><span class="ident">UnsafeCell</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">>></span><span class="op">>></span>); <span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Send</span><span class="op">></span> <span class="ident">Send</span> <span class="kw">for</span> <span class="ident">Packet</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {} <span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Sync</span><span class="op">></span> <span class="ident">Sync</span> <span class="kw">for</span> <span class="ident">Packet</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {} <span class="doccomment">/// Inner representation for JoinHandle</span> <span class="kw">struct</span> <span class="ident">JoinInner</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { <span class="ident">native</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">imp</span>::<span class="ident">Thread</span><span class="op">></span>, <span class="ident">thread</span>: <span class="ident">Thread</span>, <span class="ident">packet</span>: <span class="ident">Packet</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>, } <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">JoinInner</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { <span class="kw">fn</span> <span class="ident">join</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { <span class="self">self</span>.<span class="ident">native</span>.<span class="ident">take</span>().<span class="ident">unwrap</span>().<span class="ident">join</span>(); <span class="kw">unsafe</span> { (<span class="kw-2">*</span><span class="self">self</span>.<span class="ident">packet</span>.<span class="number">0</span>.<span class="ident">get</span>()).<span class="ident">take</span>().<span class="ident">unwrap</span>() } } } <span class="doccomment">/// An owned permission to join on a thread (block on its termination).</span> <span class="doccomment">///</span> <span class="doccomment">/// A `JoinHandle` *detaches* the associated thread when it is dropped, which</span> <span class="doccomment">/// means that there is no longer any handle to thread and no way to `join`</span> <span class="doccomment">/// on it.</span> <span class="doccomment">///</span> <span class="doccomment">/// Due to platform restrictions, it is not possible to [`Clone`] this</span> <span class="doccomment">/// handle: the ability to join a thread is a uniquely-owned permission.</span> <span class="doccomment">///</span> <span class="doccomment">/// This `struct` is created by the [`thread::spawn`] function and the</span> <span class="doccomment">/// [`thread::Builder::spawn`] method.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// Creation from [`thread::spawn`]:</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let join_handle: thread::JoinHandle<_> = thread::spawn(|| {</span> <span class="doccomment">/// // some work here</span> <span class="doccomment">/// });</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// Creation from [`thread::Builder::spawn`]:</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let builder = thread::Builder::new();</span> <span class="doccomment">///</span> <span class="doccomment">/// let join_handle: thread::JoinHandle<_> = builder.spawn(|| {</span> <span class="doccomment">/// // some work here</span> <span class="doccomment">/// }).unwrap();</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// Child being detached and outliving its parent:</span> <span class="doccomment">///</span> <span class="doccomment">/// ```no_run</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">/// use std::time::Duration;</span> <span class="doccomment">///</span> <span class="doccomment">/// let original_thread = thread::spawn(|| {</span> <span class="doccomment">/// let _detached_thread = thread::spawn(|| {</span> <span class="doccomment">/// // Here we sleep to make sure that the first thread returns before.</span> <span class="doccomment">/// thread::sleep(Duration::from_millis(10));</span> <span class="doccomment">/// // This will be called, even though the JoinHandle is dropped.</span> <span class="doccomment">/// println!("♫ Still alive ♫");</span> <span class="doccomment">/// });</span> <span class="doccomment">/// });</span> <span class="doccomment">///</span> <span class="doccomment">/// original_thread.join().expect("The thread being joined has panicked");</span> <span class="doccomment">/// println!("Original thread is joined.");</span> <span class="doccomment">///</span> <span class="doccomment">/// // We make sure that the new thread has time to run, before the main</span> <span class="doccomment">/// // thread returns.</span> <span class="doccomment">///</span> <span class="doccomment">/// thread::sleep(Duration::from_millis(1000));</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// [`Clone`]: ../../std/clone/trait.Clone.html</span> <span class="doccomment">/// [`thread::spawn`]: fn.spawn.html</span> <span class="doccomment">/// [`thread::Builder::spawn`]: struct.Builder.html#method.spawn</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">JoinHandle</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">JoinInner</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>); <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">JoinHandle</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { <span class="doccomment">/// Extracts a handle to the underlying thread.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let builder = thread::Builder::new();</span> <span class="doccomment">///</span> <span class="doccomment">/// let join_handle: thread::JoinHandle<_> = builder.spawn(|| {</span> <span class="doccomment">/// // some work here</span> <span class="doccomment">/// }).unwrap();</span> <span class="doccomment">///</span> <span class="doccomment">/// let thread = join_handle.thread();</span> <span class="doccomment">/// println!("thread id: {:?}", thread.id());</span> <span class="doccomment">/// ```</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">thread</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">Thread</span> { <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>.<span class="ident">thread</span> } <span class="doccomment">/// Waits for the associated thread to finish.</span> <span class="doccomment">///</span> <span class="doccomment">/// If the child thread panics, [`Err`] is returned with the parameter given</span> <span class="doccomment">/// to [`panic`].</span> <span class="doccomment">///</span> <span class="doccomment">/// [`Err`]: ../../std/result/enum.Result.html#variant.Err</span> <span class="doccomment">/// [`panic`]: ../../std/macro.panic.html</span> <span class="doccomment">///</span> <span class="doccomment">/// # Panics</span> <span class="doccomment">///</span> <span class="doccomment">/// This function may panic on some platforms if a thread attempts to join</span> <span class="doccomment">/// itself or otherwise may create a deadlock with joining threads.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Examples</span> <span class="doccomment">///</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// use std::thread;</span> <span class="doccomment">///</span> <span class="doccomment">/// let builder = thread::Builder::new();</span> <span class="doccomment">///</span> <span class="doccomment">/// let join_handle: thread::JoinHandle<_> = builder.spawn(|| {</span> <span class="doccomment">/// // some work here</span> <span class="doccomment">/// }).unwrap();</span> <span class="doccomment">/// join_handle.join().expect("Couldn't join on the associated thread");</span> <span class="doccomment">/// ```</span> <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">join</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">join</span>() } } <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">AsInner</span><span class="op"><</span><span class="ident">imp</span>::<span class="ident">Thread</span><span class="op">></span> <span class="kw">for</span> <span class="ident">JoinHandle</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { <span class="kw">fn</span> <span class="ident">as_inner</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">imp</span>::<span class="ident">Thread</span> { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">native</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>() } } <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">IntoInner</span><span class="op"><</span><span class="ident">imp</span>::<span class="ident">Thread</span><span class="op">></span> <span class="kw">for</span> <span class="ident">JoinHandle</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { <span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">imp</span>::<span class="ident">Thread</span> { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">native</span>.<span class="ident">unwrap</span>() } } <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"std_debug"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.16.0"</span>)]</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">JoinHandle</span><span class="op"><</span><span class="ident">T</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</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { <span class="ident">f</span>.<span class="ident">pad</span>(<span class="string">"JoinHandle { .. }"</span>) } } <span class="kw">fn</span> <span class="ident">_assert_sync_and_send</span>() { <span class="kw">fn</span> <span class="ident">_assert_both</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span><span class="op">></span>() {} <span class="ident">_assert_both</span>::<span class="op"><</span><span class="ident">JoinHandle</span><span class="op"><</span>()<span class="op">>></span>(); <span class="ident">_assert_both</span>::<span class="op"><</span><span class="ident">Thread</span><span class="op">></span>(); } <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="comment">// Tests</span> <span class="comment">////////////////////////////////////////////////////////////////////////////////</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">test</span>, <span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"emscripten"</span>)))]</span> <span class="kw">mod</span> <span class="ident">tests</span> { <span class="kw">use</span> <span class="ident">any</span>::<span class="ident">Any</span>; <span class="kw">use</span> <span class="ident">sync</span>::<span class="ident">mpsc</span>::{<span class="ident">channel</span>, <span class="ident">Sender</span>}; <span class="kw">use</span> <span class="ident">result</span>; <span class="kw">use</span> <span class="kw">super</span>::{<span class="ident">Builder</span>}; <span class="kw">use</span> <span class="ident">thread</span>; <span class="kw">use</span> <span class="ident">time</span>::<span class="ident">Duration</span>; <span class="kw">use</span> <span class="ident">u32</span>; <span class="comment">// !!! These tests are dangerous. If something is buggy, they will hang, !!!</span> <span class="comment">// !!! instead of exiting cleanly. This might wedge the buildbots. !!!</span> <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_unnamed_thread</span>() { <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">thread</span>::<span class="ident">current</span>().<span class="ident">name</span>().<span class="ident">is_none</span>()); }).<span class="ident">join</span>().<span class="ident">ok</span>().<span class="ident">unwrap</span>(); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_named_thread</span>() { <span class="ident">Builder</span>::<span class="ident">new</span>().<span class="ident">name</span>(<span class="string">"ada lovelace"</span>.<span class="ident">to_string</span>()).<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">thread</span>::<span class="ident">current</span>().<span class="ident">name</span>().<span class="ident">unwrap</span>() <span class="op">==</span> <span class="string">"ada lovelace"</span>.<span class="ident">to_string</span>()); }).<span class="ident">unwrap</span>().<span class="ident">join</span>().<span class="ident">unwrap</span>(); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="attribute">#[<span class="ident">should_panic</span>]</span> <span class="kw">fn</span> <span class="ident">test_invalid_named_thread</span>() { <span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>().<span class="ident">name</span>(<span class="string">"ada l\0velace"</span>.<span class="ident">to_string</span>()).<span class="ident">spawn</span>(<span class="op">||</span> {}); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_run_basic</span>() { <span class="kw">let</span> (<span class="ident">tx</span>, <span class="ident">rx</span>) <span class="op">=</span> <span class="ident">channel</span>(); <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="ident">tx</span>.<span class="ident">send</span>(()).<span class="ident">unwrap</span>(); }); <span class="ident">rx</span>.<span class="ident">recv</span>().<span class="ident">unwrap</span>(); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_join_panic</span>() { <span class="kw">match</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="macro">panic</span><span class="macro">!</span>() }).<span class="ident">join</span>() { <span class="ident">result</span>::<span class="prelude-ty">Result</span>::<span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=></span> (), <span class="ident">result</span>::<span class="prelude-ty">Result</span>::<span class="prelude-val">Ok</span>(()) <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>() } } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_spawn_sched</span>() { <span class="kw">let</span> (<span class="ident">tx</span>, <span class="ident">rx</span>) <span class="op">=</span> <span class="ident">channel</span>(); <span class="kw">fn</span> <span class="ident">f</span>(<span class="ident">i</span>: <span class="ident">i32</span>, <span class="ident">tx</span>: <span class="ident">Sender</span><span class="op"><</span>()<span class="op">></span>) { <span class="kw">let</span> <span class="ident">tx</span> <span class="op">=</span> <span class="ident">tx</span>.<span class="ident">clone</span>(); <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="kw">if</span> <span class="ident">i</span> <span class="op">==</span> <span class="number">0</span> { <span class="ident">tx</span>.<span class="ident">send</span>(()).<span class="ident">unwrap</span>(); } <span class="kw">else</span> { <span class="ident">f</span>(<span class="ident">i</span> <span class="op">-</span> <span class="number">1</span>, <span class="ident">tx</span>); } }); } <span class="ident">f</span>(<span class="number">10</span>, <span class="ident">tx</span>); <span class="ident">rx</span>.<span class="ident">recv</span>().<span class="ident">unwrap</span>(); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_spawn_sched_childs_on_default_sched</span>() { <span class="kw">let</span> (<span class="ident">tx</span>, <span class="ident">rx</span>) <span class="op">=</span> <span class="ident">channel</span>(); <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="ident">tx</span>.<span class="ident">send</span>(()).<span class="ident">unwrap</span>(); }); }); <span class="ident">rx</span>.<span class="ident">recv</span>().<span class="ident">unwrap</span>(); } <span class="kw">fn</span> <span class="ident">avoid_copying_the_body</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>(<span class="ident">spawnfn</span>: <span class="ident">F</span>) <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="ident">Box</span><span class="op"><</span><span class="ident">Fn</span>() <span class="op">+</span> <span class="ident">Send</span><span class="op">></span>) { <span class="kw">let</span> (<span class="ident">tx</span>, <span class="ident">rx</span>) <span class="op">=</span> <span class="ident">channel</span>(); <span class="kw">let</span> <span class="ident">x</span>: <span class="ident">Box</span><span class="op"><</span><span class="kw">_</span><span class="op">></span> <span class="op">=</span> <span class="kw">box</span> <span class="number">1</span>; <span class="kw">let</span> <span class="ident">x_in_parent</span> <span class="op">=</span> (<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">x</span>) <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">i32</span> <span class="kw">as</span> <span class="ident">usize</span>; <span class="ident">spawnfn</span>(<span class="ident">Box</span>::<span class="ident">new</span>(<span class="kw">move</span><span class="op">||</span> { <span class="kw">let</span> <span class="ident">x_in_child</span> <span class="op">=</span> (<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">x</span>) <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">i32</span> <span class="kw">as</span> <span class="ident">usize</span>; <span class="ident">tx</span>.<span class="ident">send</span>(<span class="ident">x_in_child</span>).<span class="ident">unwrap</span>(); })); <span class="kw">let</span> <span class="ident">x_in_child</span> <span class="op">=</span> <span class="ident">rx</span>.<span class="ident">recv</span>().<span class="ident">unwrap</span>(); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x_in_parent</span>, <span class="ident">x_in_child</span>); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_avoid_copying_the_body_spawn</span>() { <span class="ident">avoid_copying_the_body</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> { <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> <span class="ident">v</span>()); }); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_avoid_copying_the_body_thread_spawn</span>() { <span class="ident">avoid_copying_the_body</span>(<span class="op">|</span><span class="ident">f</span><span class="op">|</span> { <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="ident">f</span>(); }); }) } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_avoid_copying_the_body_join</span>() { <span class="ident">avoid_copying_the_body</span>(<span class="op">|</span><span class="ident">f</span><span class="op">|</span> { <span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="ident">f</span>() }).<span class="ident">join</span>(); }) } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_child_doesnt_ref_parent</span>() { <span class="comment">// If the child refcounts the parent thread, this will stack overflow when</span> <span class="comment">// climbing the thread tree to dereference each ancestor. (See #1789)</span> <span class="comment">// (well, it would if the constant were 8000+ - I lowered it to be more</span> <span class="comment">// valgrind-friendly. try this at home, instead..!)</span> <span class="kw">const</span> <span class="ident">GENERATIONS</span>: <span class="ident">u32</span> <span class="op">=</span> <span class="number">16</span>; <span class="kw">fn</span> <span class="ident">child_no</span>(<span class="ident">x</span>: <span class="ident">u32</span>) <span class="op">-></span> <span class="ident">Box</span><span class="op"><</span><span class="ident">Fn</span>() <span class="op">+</span> <span class="ident">Send</span><span class="op">></span> { <span class="kw">return</span> <span class="ident">Box</span>::<span class="ident">new</span>(<span class="kw">move</span><span class="op">||</span> { <span class="kw">if</span> <span class="ident">x</span> <span class="op"><</span> <span class="ident">GENERATIONS</span> { <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> <span class="ident">child_no</span>(<span class="ident">x</span><span class="op">+</span><span class="number">1</span>)()); } }); } <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="op">||</span> <span class="ident">child_no</span>(<span class="number">0</span>)()); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_simple_newsched_spawn</span>() { <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> {}); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_try_panic_message_static_str</span>() { <span class="kw">match</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"static string"</span>); }).<span class="ident">join</span>() { <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=></span> { <span class="kw">type</span> <span class="ident">T</span> <span class="op">=</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>; <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="ident">is</span>::<span class="op"><</span><span class="ident">T</span><span class="op">></span>()); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">e</span>.<span class="ident">downcast</span>::<span class="op"><</span><span class="ident">T</span><span class="op">></span>().<span class="ident">unwrap</span>(), <span class="string">"static string"</span>); } <span class="prelude-val">Ok</span>(()) <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>() } } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_try_panic_message_owned_str</span>() { <span class="kw">match</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"owned string"</span>.<span class="ident">to_string</span>()); }).<span class="ident">join</span>() { <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=></span> { <span class="kw">type</span> <span class="ident">T</span> <span class="op">=</span> <span class="ident">String</span>; <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="ident">is</span>::<span class="op"><</span><span class="ident">T</span><span class="op">></span>()); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">e</span>.<span class="ident">downcast</span>::<span class="op"><</span><span class="ident">T</span><span class="op">></span>().<span class="ident">unwrap</span>(), <span class="string">"owned string"</span>.<span class="ident">to_string</span>()); } <span class="prelude-val">Ok</span>(()) <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>() } } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_try_panic_message_any</span>() { <span class="kw">match</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="macro">panic</span><span class="macro">!</span>(<span class="kw">box</span> <span class="number">413u16</span> <span class="kw">as</span> <span class="ident">Box</span><span class="op"><</span><span class="ident">Any</span> <span class="op">+</span> <span class="ident">Send</span><span class="op">></span>); }).<span class="ident">join</span>() { <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=></span> { <span class="kw">type</span> <span class="ident">T</span> <span class="op">=</span> <span class="ident">Box</span><span class="op"><</span><span class="ident">Any</span> <span class="op">+</span> <span class="ident">Send</span><span class="op">></span>; <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="ident">is</span>::<span class="op"><</span><span class="ident">T</span><span class="op">></span>()); <span class="kw">let</span> <span class="ident">any</span> <span class="op">=</span> <span class="ident">e</span>.<span class="ident">downcast</span>::<span class="op"><</span><span class="ident">T</span><span class="op">></span>().<span class="ident">unwrap</span>(); <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">any</span>.<span class="ident">is</span>::<span class="op"><</span><span class="ident">u16</span><span class="op">></span>()); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">any</span>.<span class="ident">downcast</span>::<span class="op"><</span><span class="ident">u16</span><span class="op">></span>().<span class="ident">unwrap</span>(), <span class="number">413</span>); } <span class="prelude-val">Ok</span>(()) <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>() } } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_try_panic_message_unit_struct</span>() { <span class="kw">struct</span> <span class="ident">Juju</span>; <span class="kw">match</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span><span class="op">||</span> { <span class="macro">panic</span><span class="macro">!</span>(<span class="ident">Juju</span>) }).<span class="ident">join</span>() { <span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">is</span>::<span class="op"><</span><span class="ident">Juju</span><span class="op">></span>() <span class="op">=></span> {} <span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">|</span> <span class="prelude-val">Ok</span>(()) <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>() } } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_park_timeout_unpark_before</span>() { <span class="kw">for</span> <span class="kw">_</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">10</span> { <span class="ident">thread</span>::<span class="ident">current</span>().<span class="ident">unpark</span>(); <span class="ident">thread</span>::<span class="ident">park_timeout</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="ident">u32</span>::<span class="ident">MAX</span> <span class="kw">as</span> <span class="ident">u64</span>)); } } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_park_timeout_unpark_not_called</span>() { <span class="kw">for</span> <span class="kw">_</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">10</span> { <span class="ident">thread</span>::<span class="ident">park_timeout</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">10</span>)); } } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_park_timeout_unpark_called_other_thread</span>() { <span class="kw">for</span> <span class="kw">_</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">10</span> { <span class="kw">let</span> <span class="ident">th</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">current</span>(); <span class="kw">let</span> <span class="ident">_guard</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> { <span class="kw">super</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">50</span>)); <span class="ident">th</span>.<span class="ident">unpark</span>(); }); <span class="ident">thread</span>::<span class="ident">park_timeout</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="ident">u32</span>::<span class="ident">MAX</span> <span class="kw">as</span> <span class="ident">u64</span>)); } } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">sleep_ms_smoke</span>() { <span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">2</span>)); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_thread_id_equal</span>() { <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">thread</span>::<span class="ident">current</span>().<span class="ident">id</span>() <span class="op">==</span> <span class="ident">thread</span>::<span class="ident">current</span>().<span class="ident">id</span>()); } <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_thread_id_not_equal</span>() { <span class="kw">let</span> <span class="ident">spawned_id</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="op">||</span> <span class="ident">thread</span>::<span class="ident">current</span>().<span class="ident">id</span>()).<span class="ident">join</span>().<span class="ident">unwrap</span>(); <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">thread</span>::<span class="ident">current</span>().<span class="ident">id</span>() <span class="op">!=</span> <span class="ident">spawned_id</span>); } <span class="comment">// NOTE: the corresponding test for stderr is in run-pass/thread-stderr, due</span> <span class="comment">// to the test harness apparently interfering with stderr configuration.</span> } </pre> </section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "std";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>