| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/oneshot-0.1.5/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../oneshot/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../oneshot/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| <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> |
| </pre><pre class="rust"><code><span class="doccomment">//! Oneshot spsc (single producer, single consumer) channel. Meaning each channel instance |
| //! can only transport a single message. This has a few nice outcomes. One thing is that |
| //! the implementation can be very efficient, utilizing the knowledge that there will |
| //! only be one message. But more importantly, it allows the API to be expressed in such |
| //! a way that certain edge cases that you don't want to care about when only sending a |
| //! single message on a channel does not exist. For example: The sender can't be copied |
| //! or cloned, and the send method takes ownership and consumes the sender. |
| //! So you are guaranteed, at the type level, that there can only be one message sent. |
| //! |
| //! The sender's send method is non-blocking, and potentially lock- and wait-free. |
| //! See documentation on [Sender::send] for situations where it might not be fully wait-free. |
| //! The receiver supports both lock- and wait-free `try_recv` as well as indefinite and time |
| //! limited thread blocking receive operations. The receiver also implements `Future` and |
| //! supports asynchronously awaiting the message. |
| //! |
| //! |
| //! # Examples |
| //! |
| //! This example sets up a background worker that processes requests coming in on a standard |
| //! mpsc channel and replies on a oneshot channel provided with each request. The worker can |
| //! be interacted with both from sync and async contexts since the oneshot receiver |
| //! can receive both blocking and async. |
| //! |
| //! ```rust |
| //! use std::sync::mpsc; |
| //! use std::thread; |
| //! use std::time::Duration; |
| //! |
| //! type Request = String; |
| //! |
| //! // Starts a background thread performing some computation on requests sent to it. |
| //! // Delivers the response back over a oneshot channel. |
| //! fn spawn_processing_thread() -> mpsc::Sender<(Request, oneshot::Sender<usize>)> { |
| //! let (request_sender, request_receiver) = mpsc::channel::<(Request, oneshot::Sender<usize>)>(); |
| //! thread::spawn(move || { |
| //! for (request_data, response_sender) in request_receiver.iter() { |
| //! let compute_operation = || request_data.len(); |
| //! let _ = response_sender.send(compute_operation()); // <- Send on the oneshot channel |
| //! } |
| //! }); |
| //! request_sender |
| //! } |
| //! |
| //! let processor = spawn_processing_thread(); |
| //! |
| //! // If compiled with `std` the library can receive messages with timeout on regular threads |
| //! #[cfg(feature = "std")] { |
| //! let (response_sender, response_receiver) = oneshot::channel(); |
| //! let request = Request::from("data from sync thread"); |
| //! |
| //! processor.send((request, response_sender)).expect("Processor down"); |
| //! match response_receiver.recv_timeout(Duration::from_secs(1)) { // <- Receive on the oneshot channel |
| //! Ok(result) => println!("Processor returned {}", result), |
| //! Err(oneshot::RecvTimeoutError::Timeout) => eprintln!("Processor was too slow"), |
| //! Err(oneshot::RecvTimeoutError::Disconnected) => panic!("Processor exited"), |
| //! } |
| //! } |
| //! |
| //! // If compiled with the `async` feature, the `Receiver` can be awaited in an async context |
| //! #[cfg(feature = "async")] { |
| //! tokio::runtime::Runtime::new() |
| //! .unwrap() |
| //! .block_on(async move { |
| //! let (response_sender, response_receiver) = oneshot::channel(); |
| //! let request = Request::from("data from sync thread"); |
| //! |
| //! processor.send((request, response_sender)).expect("Processor down"); |
| //! match response_receiver.await { // <- Receive on the oneshot channel asynchronously |
| //! Ok(result) => println!("Processor returned {}", result), |
| //! Err(_e) => panic!("Processor exited"), |
| //! } |
| //! }); |
| //! } |
| //! ``` |
| //! |
| //! # Sync vs async |
| //! |
| //! The main motivation for writing this library was that there were no (known to me) channel |
| //! implementations allowing you to seamlessly send messages between a normal thread and an async |
| //! task, or the other way around. If message passing is the way you are communicating, of course |
| //! that should work smoothly between the sync and async parts of the program! |
| //! |
| //! This library achieves that by having a fast and cheap send operation that can |
| //! be used in both sync threads and async tasks. The receiver has both thread blocking |
| //! receive methods for synchronous usage, and implements `Future` for asynchronous usage. |
| //! |
| //! The receiving endpoint of this channel implements Rust's `Future` trait and can be waited on |
| //! in an asynchronous task. This implementation is completely executor/runtime agnostic. It should |
| //! be possible to use this library with any executor. |
| //! |
| |
| </span><span class="comment">// # Implementation description |
| // |
| // When a channel is created via the channel function, it creates a single heap allocation |
| // containing: |
| // * A one byte atomic integer that represents the current channel state, |
| // * Uninitialized memory to fit the message, |
| // * Uninitialized memory to fit the waker that can wake the receiving task or thread up. |
| // |
| // The size of the waker depends on which features are activated, it ranges from 0 to 24 bytes[1]. |
| // So with all features enabled (the default) each channel allocates 25 bytes plus the size of the |
| // message, plus any padding needed to get correct memory alignment. |
| // |
| // The Sender and Receiver only holds a raw pointer to the heap channel object. The last endpoint |
| // to be consumed or dropped is responsible for freeing the heap memory. The first endpoint to |
| // be consumed or dropped signal via the state that it is gone. And the second one see this and |
| // frees the memory. |
| // |
| // ## Footnotes |
| // |
| // [1]: Mind that the waker only takes zero bytes when all features are disabled, making it |
| // impossible to *wait* for the message. `try_recv` the only available method in this scenario. |
| |
| </span><span class="attribute">#![deny(rust_2018_idioms)] |
| #![cfg_attr(not(feature = <span class="string">"std"</span>), no_std)] |
| |
| #[cfg(not(loom))] |
| </span><span class="kw">extern crate </span>alloc; |
| |
| <span class="kw">use </span>core::{ |
| marker::PhantomData, |
| mem::{<span class="self">self</span>, MaybeUninit}, |
| ptr::{<span class="self">self</span>, NonNull}, |
| }; |
| |
| <span class="attribute">#[cfg(not(loom))] |
| </span><span class="kw">use </span>core::{ |
| cell::UnsafeCell, |
| sync::atomic::{fence, AtomicU8, Ordering::<span class="kw-2">*</span>}, |
| }; |
| <span class="attribute">#[cfg(loom)] |
| </span><span class="kw">use </span>loom::{ |
| cell::UnsafeCell, |
| sync::atomic::{fence, AtomicU8, Ordering::<span class="kw-2">*</span>}, |
| }; |
| |
| <span class="attribute">#[cfg(all(feature = <span class="string">"async"</span>, not(loom)))] |
| </span><span class="kw">use </span>core::hint; |
| <span class="attribute">#[cfg(all(feature = <span class="string">"async"</span>, loom))] |
| </span><span class="kw">use </span>loom::hint; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"async"</span>)] |
| </span><span class="kw">use </span>core::{ |
| pin::Pin, |
| task::{<span class="self">self</span>, Poll}, |
| }; |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">use </span>std::time::{Duration, Instant}; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">mod </span>thread { |
| <span class="attribute">#[cfg(not(loom))] |
| </span><span class="kw">pub use </span>std::thread::{current, park, park_timeout, yield_now, Thread}; |
| |
| <span class="attribute">#[cfg(loom)] |
| </span><span class="kw">pub use </span>loom::thread::{current, park, yield_now, Thread}; |
| |
| <span class="comment">// loom does not support parking with a timeout. So we just |
| // yield. This means that the "park" will "spuriously" wake up |
| // way too early. But the code should properly handle this. |
| // One thing to note is that very short timeouts are needed |
| // when using loom, since otherwise the looping will cause |
| // an overflow in loom. |
| </span><span class="attribute">#[cfg(loom)] |
| </span><span class="kw">pub fn </span>park_timeout(_timeout: std::time::Duration) { |
| loom::thread::yield_now() |
| } |
| } |
| |
| <span class="attribute">#[cfg(loom)] |
| </span><span class="kw">mod </span>loombox; |
| <span class="attribute">#[cfg(not(loom))] |
| </span><span class="kw">use </span>alloc::boxed::Box; |
| <span class="attribute">#[cfg(loom)] |
| </span><span class="kw">use </span>loombox::Box; |
| |
| <span class="kw">mod </span>errors; |
| <span class="kw">pub use </span>errors::{RecvError, RecvTimeoutError, SendError, TryRecvError}; |
| |
| <span class="doccomment">/// Creates a new oneshot channel and returns the two endpoints, [`Sender`] and [`Receiver`]. |
| </span><span class="kw">pub fn </span>channel<T>() -> (Sender<T>, Receiver<T>) { |
| <span class="comment">// Allocate the channel on the heap and get the pointer. |
| // The last endpoint of the channel to be alive is responsible for freeing the channel |
| // and dropping any object that might have been written to it. |
| |
| </span><span class="kw">let </span>channel_ptr = Box::into_raw(Box::new(Channel::new())); |
| |
| <span class="comment">// SAFETY: `channel_ptr` came from a Box and thus is not null |
| </span><span class="kw">let </span>channel_ptr = <span class="kw">unsafe </span>{ NonNull::new_unchecked(channel_ptr) }; |
| |
| ( |
| Sender { |
| channel_ptr, |
| _invariant: PhantomData, |
| }, |
| Receiver { channel_ptr }, |
| ) |
| } |
| |
| <span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Sender<T> { |
| channel_ptr: NonNull<Channel<T>>, |
| <span class="comment">// In reality we want contravariance, however we can't obtain that. |
| // |
| // Consider the following scenario: |
| // ``` |
| // let (mut tx, rx) = channel::<&'short u8>(); |
| // let (tx2, rx2) = channel::<&'long u8>(); |
| // |
| // tx = tx2; |
| // |
| // // Pretend short_ref is some &'short u8 |
| // tx.send(short_ref).unwrap(); |
| // let long_ref = rx2.recv().unwrap(); |
| // ``` |
| // |
| // If this type were covariant then we could safely extend lifetimes, which is not okay. |
| // Hence, we enforce invariance. |
| </span>_invariant: PhantomData<<span class="kw">fn</span>(T) -> T>, |
| } |
| |
| <span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Receiver<T> { |
| <span class="comment">// Covariance is the right choice here. Consider the example presented in Sender, and you'll |
| // see that if we replaced `rx` instead then we would get the expected behavior |
| </span>channel_ptr: NonNull<Channel<T>>, |
| } |
| |
| <span class="kw">unsafe impl</span><T: Send> Send <span class="kw">for </span>Sender<T> {} |
| <span class="kw">unsafe impl</span><T: Send> Send <span class="kw">for </span>Receiver<T> {} |
| <span class="kw">impl</span><T> Unpin <span class="kw">for </span>Receiver<T> {} |
| |
| <span class="kw">impl</span><T> Sender<T> { |
| <span class="doccomment">/// Sends `message` over the channel to the corresponding [`Receiver`]. |
| /// |
| /// Returns an error if the receiver has already been dropped. The message can |
| /// be extracted from the error. |
| /// |
| /// This method is lock-free and wait-free when sending on a channel that the |
| /// receiver is currently not receiving on. If the receiver is receiving during the send |
| /// operation this method includes waking up the thread/task. Unparking a thread involves |
| /// a mutex in Rust's standard library at the time of writing this. |
| /// How lock-free waking up an async task is |
| /// depends on your executor. If this method returns a `SendError`, please mind that dropping |
| /// the error involves running any drop implementation on the message type, and freeing the |
| /// channel's heap allocation, which might or might not be lock-free. |
| </span><span class="kw">pub fn </span>send(<span class="self">self</span>, message: T) -> <span class="prelude-ty">Result</span><(), SendError<T>> { |
| <span class="kw">let </span>channel_ptr = <span class="self">self</span>.channel_ptr; |
| |
| <span class="comment">// Don't run our Drop implementation if send was called, any cleanup now happens here |
| </span>mem::forget(<span class="self">self</span>); |
| |
| <span class="comment">// SAFETY: The channel exists on the heap for the entire duration of this method and we |
| // only ever acquire shared references to it. Note that if the receiver disconnects it |
| // does not free the channel. |
| </span><span class="kw">let </span>channel = <span class="kw">unsafe </span>{ channel_ptr.as_ref() }; |
| |
| <span class="comment">// Write the message into the channel on the heap. |
| // SAFETY: The receiver only ever accesses this memory location if we are in the MESSAGE |
| // state, and since we're responsible for setting that state, we can guarantee that we have |
| // exclusive access to this memory location to perform this write. |
| </span><span class="kw">unsafe </span>{ channel.write_message(message) }; |
| |
| <span class="comment">// Set the state to signal there is a message on the channel. |
| // ORDERING: we use release ordering to ensure the write of the message is visible to the |
| // receiving thread. The EMPTY and DISCONNECTED branches do not observe any shared state, |
| // and thus we do not need acquire orderng. The RECEIVING branch manages synchronization |
| // independent of this operation. |
| // |
| // EMPTY + 1 = MESSAGE |
| // RECEIVING + 1 = UNPARKING |
| // DISCONNECTED + 1 = invalid, however this state is never observed |
| </span><span class="kw">match </span>channel.state.fetch_add(<span class="number">1</span>, Release) { |
| <span class="comment">// The receiver is alive and has not started waiting. Send done. |
| </span>EMPTY => <span class="prelude-val">Ok</span>(()), |
| <span class="comment">// The receiver is waiting. Wake it up so it can return the message. |
| </span>RECEIVING => { |
| <span class="comment">// ORDERING: Synchronizes with the write of the waker to memory, and prevents the |
| // taking of the waker from being ordered before this operation. |
| </span>fence(Acquire); |
| |
| <span class="comment">// Take the waker, but critically do not unpark it. If we unparked now, then the |
| // receiving thread could still observe the UNPARKING state and re-park, meaning |
| // that after we change to the MESSAGE state, it would remain parked indefinitely |
| // or until a spurious wakeup. |
| // SAFETY: at this point we are in the UNPARKING state, and the receiving thread |
| // does not access the waker while in this state, nor does it free the channel |
| // allocation in this state. |
| </span><span class="kw">let </span>waker = <span class="kw">unsafe </span>{ channel.take_waker() }; |
| |
| <span class="comment">// ORDERING: this ordering serves two-fold: it synchronizes with the acquire load |
| // in the receiving thread, ensuring that both our read of the waker and write of |
| // the message happen-before the taking of the message and freeing of the channel. |
| // Furthermore, we need acquire ordering to ensure the unparking of the receiver |
| // happens after the channel state is updated. |
| </span>channel.state.swap(MESSAGE, AcqRel); |
| |
| <span class="comment">// Note: it is possible that between the store above and this statement that |
| // the receiving thread is spuriously unparked, takes the message, and frees |
| // the channel allocation. However, we took ownership of the channel out of |
| // that allocation, and freeing the channel does not drop the waker since the |
| // waker is wrapped in MaybeUninit. Therefore this data is valid regardless of |
| // whether or not the receive has completed by this point. |
| </span>waker.unpark(); |
| |
| <span class="prelude-val">Ok</span>(()) |
| } |
| <span class="comment">// The receiver was already dropped. The error is responsible for freeing the channel. |
| // SAFETY: since the receiver disconnected it will no longer access `channel_ptr`, so |
| // we can transfer exclusive ownership of the channel's resources to the error. |
| // Moreover, since we just placed the message in the channel, the channel contains a |
| // valid message. |
| </span>DISCONNECTED => <span class="prelude-val">Err</span>(<span class="kw">unsafe </span>{ SendError::new(channel_ptr) }), |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> Drop <span class="kw">for </span>Sender<T> { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="comment">// SAFETY: The receiver only ever frees the channel if we are in the MESSAGE or |
| // DISCONNECTED states. If we are in the MESSAGE state, then we called |
| // mem::forget(self), so we should not be in this function call. If we are in the |
| // DISCONNECTED state, then the receiver either received a MESSAGE so this statement is |
| // unreachable, or was dropped and observed that our side was still alive, and thus didn't |
| // free the channel. |
| </span><span class="kw">let </span>channel = <span class="kw">unsafe </span>{ <span class="self">self</span>.channel_ptr.as_ref() }; |
| |
| <span class="comment">// Set the channel state to disconnected and read what state the receiver was in |
| // ORDERING: we don't need release ordering here since there are no modifications we |
| // need to make visible to other thread, and the Err(RECEIVING) branch handles |
| // synchronization independent of this cmpxchg |
| // |
| // EMPTY ^ 001 = DISCONNECTED |
| // RECEIVING ^ 001 = UNPARKING |
| // DISCONNECTED ^ 001 = EMPTY (invalid), but this state is never observed |
| </span><span class="kw">match </span>channel.state.fetch_xor(<span class="number">0b001</span>, Relaxed) { |
| <span class="comment">// The receiver has not started waiting, nor is it dropped. |
| </span>EMPTY => (), |
| <span class="comment">// The receiver is waiting. Wake it up so it can detect that the channel disconnected. |
| </span>RECEIVING => { |
| <span class="comment">// See comments in Sender::send |
| |
| </span>fence(Acquire); |
| |
| <span class="kw">let </span>waker = <span class="kw">unsafe </span>{ channel.take_waker() }; |
| |
| <span class="comment">// We still need release ordering here to make sure our read of the waker happens |
| // before this, and acquire ordering to ensure the unparking of the receiver |
| // happens after this. |
| </span>channel.state.swap(DISCONNECTED, AcqRel); |
| |
| <span class="comment">// The Acquire ordering above ensures that the write of the DISCONNECTED state |
| // happens-before unparking the receiver. |
| </span>waker.unpark(); |
| } |
| <span class="comment">// The receiver was already dropped. We are responsible for freeing the channel. |
| </span>DISCONNECTED => { |
| <span class="comment">// SAFETY: when the receiver switches the state to DISCONNECTED they have received |
| // the message or will no longer be trying to receive the message, and have |
| // observed that the sender is still alive, meaning that we're responsible for |
| // freeing the channel allocation. |
| </span><span class="kw">unsafe </span>{ dealloc(<span class="self">self</span>.channel_ptr) }; |
| } |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> Receiver<T> { |
| <span class="doccomment">/// Checks if there is a message in the channel without blocking. Returns: |
| /// * `Ok(message)` if there was a message in the channel. |
| /// * `Err(Empty)` if the [`Sender`] is alive, but has not yet sent a message. |
| /// * `Err(Disconnected)` if the [`Sender`] was dropped before sending anything or if the |
| /// message has already been extracted by a previous receive call. |
| /// |
| /// If a message is returned, the channel is disconnected and any subsequent receive operation |
| /// using this receiver will return an error. |
| /// |
| /// This method is completely lock-free and wait-free. The only thing it does is an atomic |
| /// integer load of the channel state. And if there is a message in the channel it additionally |
| /// performs one atomic integer store and copies the message from the heap to the stack for |
| /// returning it. |
| </span><span class="kw">pub fn </span>try_recv(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><T, TryRecvError> { |
| <span class="comment">// SAFETY: The channel will not be freed while this method is still running. |
| </span><span class="kw">let </span>channel = <span class="kw">unsafe </span>{ <span class="self">self</span>.channel_ptr.as_ref() }; |
| |
| <span class="comment">// ORDERING: we use acquire ordering to synchronize with the store of the message. |
| </span><span class="kw">match </span>channel.state.load(Acquire) { |
| MESSAGE => { |
| <span class="comment">// It's okay to break up the load and store since once we're in the message state |
| // the sender no longer modifies the state |
| // ORDERING: at this point the sender has done its job and is no longer active, so |
| // we don't need to make any side effects visible to it |
| </span>channel.state.store(DISCONNECTED, Relaxed); |
| |
| <span class="comment">// SAFETY: we are in the MESSAGE state so the message is present |
| </span><span class="prelude-val">Ok</span>(<span class="kw">unsafe </span>{ channel.take_message() }) |
| } |
| EMPTY => <span class="prelude-val">Err</span>(TryRecvError::Empty), |
| DISCONNECTED => <span class="prelude-val">Err</span>(TryRecvError::Disconnected), |
| <span class="attribute">#[cfg(feature = <span class="string">"async"</span>)] |
| </span>RECEIVING | UNPARKING => <span class="prelude-val">Err</span>(TryRecvError::Empty), |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| |
| <span class="doccomment">/// Attempts to wait for a message from the [`Sender`], returning an error if the channel is |
| /// disconnected. |
| /// |
| /// This method will always block the current thread if there is no data available and it is |
| /// still possible for the message to be sent. Once the message is sent to the corresponding |
| /// [`Sender`], then this receiver will wake up and return that message. |
| /// |
| /// If the corresponding [`Sender`] has disconnected (been dropped), or it disconnects while |
| /// this call is blocking, this call will wake up and return `Err` to indicate that the message |
| /// can never be received on this channel. |
| /// |
| /// If a sent message has already been extracted from this channel this method will return an |
| /// error. |
| /// |
| /// # Panics |
| /// |
| /// Panics if called after this receiver has been polled asynchronously. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">pub fn </span>recv(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><T, RecvError> { |
| <span class="comment">// Note that we don't need to worry about changing the state to disconnected or setting the |
| // state to an invalid value at any point in this function because we take ownership of |
| // self, and this function does not exit until the message has been received or both side |
| // of the channel are inactive and cleaned up. |
| |
| </span><span class="kw">let </span>channel_ptr = <span class="self">self</span>.channel_ptr; |
| |
| <span class="comment">// Don't run our Drop implementation if we are receiving consuming ourselves. |
| </span>mem::forget(<span class="self">self</span>); |
| |
| <span class="comment">// SAFETY: the existence of the `self` parameter serves as a certificate that the receiver |
| // is still alive, meaning that even if the sender was dropped then it would have observed |
| // the fact that we're still alive and left the responsibility of deallocating the |
| // channel to us, so channel_ptr is valid |
| </span><span class="kw">let </span>channel = <span class="kw">unsafe </span>{ channel_ptr.as_ref() }; |
| |
| <span class="comment">// ORDERING: we use acquire ordering to synchronize with the write of the message in the |
| // case that it's available |
| </span><span class="kw">match </span>channel.state.load(Acquire) { |
| <span class="comment">// The sender is alive but has not sent anything yet. We prepare to park. |
| </span>EMPTY => { |
| <span class="comment">// Conditionally add a delay here to help the tests trigger the edge cases where |
| // the sender manages to be dropped or send something before we are able to store |
| // our waker object in the channel. |
| </span><span class="attribute">#[cfg(oneshot_test_delay)] |
| </span>std::thread::sleep(std::time::Duration::from_millis(<span class="number">10</span>)); |
| |
| <span class="comment">// Write our waker instance to the channel. |
| // SAFETY: we are not yet in the RECEIVING state, meaning that the sender will not |
| // try to access the waker until it sees the state set to RECEIVING below |
| </span><span class="kw">unsafe </span>{ channel.write_waker(ReceiverWaker::current_thread()) }; |
| |
| <span class="comment">// Switch the state to RECEIVING. We need to do this in one atomic step in case the |
| // sender disconnected or sent the message while we wrote the waker to memory. We |
| // don't need to do a compare exchange here however because if the original state |
| // was not EMPTY, then the sender has either finished sending the message or is |
| // being dropped, so the RECEIVING state will never be observed after we return. |
| // ORDERING: we use release ordering so the sender can synchronize with our writing |
| // of the waker to memory. The individual branches handle any additional |
| // synchronizaton |
| </span><span class="kw">match </span>channel.state.swap(RECEIVING, Release) { |
| <span class="comment">// We stored our waker, now we park until the sender has changed the state |
| </span>EMPTY => <span class="kw">loop </span>{ |
| thread::park(); |
| |
| <span class="comment">// ORDERING: synchronize with the write of the message |
| </span><span class="kw">match </span>channel.state.load(Acquire) { |
| <span class="comment">// The sender sent the message while we were parked. |
| </span>MESSAGE => { |
| <span class="comment">// SAFETY: we are in the message state so the message is valid |
| </span><span class="kw">let </span>message = <span class="kw">unsafe </span>{ channel.take_message() }; |
| |
| <span class="comment">// SAFETY: the Sender delegates the responsibility of deallocating |
| // the channel to us upon sending the message |
| </span><span class="kw">unsafe </span>{ dealloc(channel_ptr) }; |
| |
| <span class="kw">break </span><span class="prelude-val">Ok</span>(message); |
| } |
| <span class="comment">// The sender was dropped while we were parked. |
| </span>DISCONNECTED => { |
| <span class="comment">// SAFETY: the Sender doesn't deallocate the channel allocation in |
| // its drop implementation if we're receiving |
| </span><span class="kw">unsafe </span>{ dealloc(channel_ptr) }; |
| |
| <span class="kw">break </span><span class="prelude-val">Err</span>(RecvError); |
| } |
| <span class="comment">// State did not change, spurious wakeup, park again. |
| </span>RECEIVING | UNPARKING => (), |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| }, |
| <span class="comment">// The sender sent the message while we prepared to park. |
| </span>MESSAGE => { |
| <span class="comment">// ORDERING: Synchronize with the write of the message. This branch is |
| // unlikely to be taken, so it's likely more efficient to use a fence here |
| // instead of AcqRel ordering on the RMW operation |
| </span>fence(Acquire); |
| |
| <span class="comment">// SAFETY: we started in the empty state and the sender switched us to the |
| // message state. This means that it did not take the waker, so we're |
| // responsible for dropping it. |
| </span><span class="kw">unsafe </span>{ channel.drop_waker() }; |
| |
| <span class="comment">// SAFETY: we are in the message state so the message is valid |
| </span><span class="kw">let </span>message = <span class="kw">unsafe </span>{ channel.take_message() }; |
| |
| <span class="comment">// SAFETY: the Sender delegates the responsibility of deallocating the |
| // channel to us upon sending the message |
| </span><span class="kw">unsafe </span>{ dealloc(channel_ptr) }; |
| |
| <span class="prelude-val">Ok</span>(message) |
| } |
| <span class="comment">// The sender was dropped before sending anything while we prepared to park. |
| </span>DISCONNECTED => { |
| <span class="comment">// SAFETY: we started in the empty state and the sender switched us to the |
| // disconnected state. It does not take the waker when it does this so we |
| // need to drop it. |
| </span><span class="kw">unsafe </span>{ channel.drop_waker() }; |
| |
| <span class="comment">// SAFETY: the sender does not deallocate the channel if it switches from |
| // empty to disconnected so we need to free the allocation |
| </span><span class="kw">unsafe </span>{ dealloc(channel_ptr) }; |
| |
| <span class="prelude-val">Err</span>(RecvError) |
| } |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| <span class="comment">// The sender already sent the message. |
| </span>MESSAGE => { |
| <span class="comment">// SAFETY: we are in the message state so the message is valid |
| </span><span class="kw">let </span>message = <span class="kw">unsafe </span>{ channel.take_message() }; |
| |
| <span class="comment">// SAFETY: we are already in the message state so the sender has been forgotten |
| // and it's our job to clean up resources |
| </span><span class="kw">unsafe </span>{ dealloc(channel_ptr) }; |
| |
| <span class="prelude-val">Ok</span>(message) |
| } |
| <span class="comment">// The sender was dropped before sending anything, or we already received the message. |
| </span>DISCONNECTED => { |
| <span class="comment">// SAFETY: the sender does not deallocate the channel if it switches from empty to |
| // disconnected so we need to free the allocation |
| </span><span class="kw">unsafe </span>{ dealloc(channel_ptr) }; |
| |
| <span class="prelude-val">Err</span>(RecvError) |
| } |
| <span class="comment">// The receiver must have been `Future::poll`ed prior to this call. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"async"</span>)] |
| </span>RECEIVING | UNPARKING => <span class="macro">panic!</span>(<span class="string">"{}"</span>, RECEIVER_USED_SYNC_AND_ASYNC_ERROR), |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| |
| <span class="doccomment">/// Attempts to wait for a message from the [`Sender`], returning an error if the channel is |
| /// disconnected. This is a non consuming version of [`Receiver::recv`], but with a bit |
| /// worse performance. Prefer `[`Receiver::recv`]` if your code allows consuming the receiver. |
| /// |
| /// If a message is returned, the channel is disconnected and any subsequent receive operation |
| /// using this receiver will return an error. |
| /// |
| /// # Panics |
| /// |
| /// Panics if called after this receiver has been polled asynchronously. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">pub fn </span>recv_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><T, RecvError> { |
| <span class="self">self</span>.start_recv_ref(RecvError, |channel| { |
| <span class="kw">loop </span>{ |
| thread::park(); |
| |
| <span class="comment">// ORDERING: we use acquire ordering to synchronize with the write of the message |
| </span><span class="kw">match </span>channel.state.load(Acquire) { |
| <span class="comment">// The sender sent the message while we were parked. |
| // We take the message and mark the channel disconnected. |
| </span>MESSAGE => { |
| <span class="comment">// ORDERING: the sender is inactive at this point so we don't need to make |
| // any reads or writes visible to the sending thread |
| </span>channel.state.store(DISCONNECTED, Relaxed); |
| |
| <span class="comment">// SAFETY: we were just in the message state so the message is valid |
| </span><span class="kw">break </span><span class="prelude-val">Ok</span>(<span class="kw">unsafe </span>{ channel.take_message() }); |
| } |
| <span class="comment">// The sender was dropped while we were parked. |
| </span>DISCONNECTED => <span class="kw">break </span><span class="prelude-val">Err</span>(RecvError), |
| <span class="comment">// State did not change, spurious wakeup, park again. |
| </span>RECEIVING | UNPARKING => (), |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| }) |
| } |
| |
| <span class="doccomment">/// Like [`Receiver::recv`], but will not block longer than `timeout`. Returns: |
| /// * `Ok(message)` if there was a message in the channel before the timeout was reached. |
| /// * `Err(Timeout)` if no message arrived on the channel before the timeout was reached. |
| /// * `Err(Disconnected)` if the sender was dropped before sending anything or if the message |
| /// has already been extracted by a previous receive call. |
| /// |
| /// If a message is returned, the channel is disconnected and any subsequent receive operation |
| /// using this receiver will return an error. |
| /// |
| /// If the supplied `timeout` is so large that Rust's `Instant` type can't represent this point |
| /// in the future this falls back to an indefinitely blocking receive operation. |
| /// |
| /// # Panics |
| /// |
| /// Panics if called after this receiver has been polled asynchronously. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">pub fn </span>recv_timeout(<span class="kw-2">&</span><span class="self">self</span>, timeout: Duration) -> <span class="prelude-ty">Result</span><T, RecvTimeoutError> { |
| <span class="kw">match </span>Instant::now().checked_add(timeout) { |
| <span class="prelude-val">Some</span>(deadline) => <span class="self">self</span>.recv_deadline(deadline), |
| <span class="prelude-val">None </span>=> <span class="self">self</span>.recv_ref().map_err(|<span class="kw">_</span>| RecvTimeoutError::Disconnected), |
| } |
| } |
| |
| <span class="doccomment">/// Like [`Receiver::recv`], but will not block longer than until `deadline`. Returns: |
| /// * `Ok(message)` if there was a message in the channel before the deadline was reached. |
| /// * `Err(Timeout)` if no message arrived on the channel before the deadline was reached. |
| /// * `Err(Disconnected)` if the sender was dropped before sending anything or if the message |
| /// has already been extracted by a previous receive call. |
| /// |
| /// If a message is returned, the channel is disconnected and any subsequent receive operation |
| /// using this receiver will return an error. |
| /// |
| /// # Panics |
| /// |
| /// Panics if called after this receiver has been polled asynchronously. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">pub fn </span>recv_deadline(<span class="kw-2">&</span><span class="self">self</span>, deadline: Instant) -> <span class="prelude-ty">Result</span><T, RecvTimeoutError> { |
| <span class="doccomment">/// # Safety |
| /// |
| /// If the sender is unparking us after a message send, the message must already have been |
| /// written to the channel and an acquire memory barrier issued before calling this function |
| </span><span class="attribute">#[cold] |
| </span><span class="kw">unsafe fn </span>wait_for_unpark<T>(channel: <span class="kw-2">&</span>Channel<T>) -> <span class="prelude-ty">Result</span><T, RecvTimeoutError> { |
| <span class="kw">loop </span>{ |
| thread::park(); |
| |
| <span class="comment">// ORDERING: The callee has already synchronized with any message write |
| </span><span class="kw">match </span>channel.state.load(Relaxed) { |
| MESSAGE => { |
| <span class="comment">// ORDERING: the sender has been dropped, so this update only |
| // needs to be visible to us |
| </span>channel.state.store(DISCONNECTED, Relaxed); |
| <span class="kw">break </span><span class="prelude-val">Ok</span>(channel.take_message()); |
| } |
| DISCONNECTED => <span class="kw">break </span><span class="prelude-val">Err</span>(RecvTimeoutError::Disconnected), |
| <span class="comment">// The sender is still unparking us. We continue on the empty state here since |
| // the current implementation eagerly sets the state to EMPTY upon timeout. |
| </span>EMPTY => (), |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| } |
| |
| <span class="self">self</span>.start_recv_ref(RecvTimeoutError::Disconnected, |channel| { |
| <span class="kw">loop </span>{ |
| <span class="kw">match </span>deadline.checked_duration_since(Instant::now()) { |
| <span class="prelude-val">Some</span>(timeout) => { |
| thread::park_timeout(timeout); |
| |
| <span class="comment">// ORDERING: synchronize with the write of the message |
| </span><span class="kw">match </span>channel.state.load(Acquire) { |
| <span class="comment">// The sender sent the message while we were parked. |
| </span>MESSAGE => { |
| <span class="comment">// ORDERING: the sender has been `mem::forget`-ed so this update |
| // only needs to be visible to us. |
| </span>channel.state.store(DISCONNECTED, Relaxed); |
| |
| <span class="comment">// SAFETY: we either are in the message state or were just in the |
| // message state |
| </span><span class="kw">break </span><span class="prelude-val">Ok</span>(<span class="kw">unsafe </span>{ channel.take_message() }); |
| } |
| <span class="comment">// The sender was dropped while we were parked. |
| </span>DISCONNECTED => <span class="kw">break </span><span class="prelude-val">Err</span>(RecvTimeoutError::Disconnected), |
| <span class="comment">// State did not change, spurious wakeup, park again. |
| </span>RECEIVING | UNPARKING => (), |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| <span class="prelude-val">None </span>=> { |
| <span class="comment">// ORDERING: synchronize with the write of the message |
| </span><span class="kw">match </span>channel.state.swap(EMPTY, Acquire) { |
| <span class="comment">// We reached the end of the timeout without receiving a message |
| </span>RECEIVING => { |
| <span class="comment">// SAFETY: we were in the receiving state and are now in the empty |
| // state, so the sender has not and will not try to read the waker, |
| // so we have exclusive access to drop it. |
| </span><span class="kw">unsafe </span>{ channel.drop_waker() }; |
| |
| <span class="kw">break </span><span class="prelude-val">Err</span>(RecvTimeoutError::Timeout); |
| } |
| <span class="comment">// The sender sent the message while we were parked. |
| </span>MESSAGE => { |
| <span class="comment">// Same safety and ordering as the Some branch |
| |
| </span>channel.state.store(DISCONNECTED, Relaxed); |
| <span class="kw">break </span><span class="prelude-val">Ok</span>(<span class="kw">unsafe </span>{ channel.take_message() }); |
| } |
| <span class="comment">// The sender was dropped while we were parked. |
| </span>DISCONNECTED => { |
| <span class="comment">// ORDERING: we were originally in the disconnected state meaning |
| // that the sender is inactive and no longer observing the state, |
| // so we only need to change it back to DISCONNECTED for if the |
| // receiver is dropped or a recv* method is called again |
| </span>channel.state.store(DISCONNECTED, Relaxed); |
| |
| <span class="kw">break </span><span class="prelude-val">Err</span>(RecvTimeoutError::Disconnected); |
| } |
| <span class="comment">// The sender sent the message and started unparking us |
| </span>UNPARKING => { |
| <span class="comment">// We were in the UNPARKING state and are now in the EMPTY state. |
| // We wait to be properly unparked and to observe if the sender |
| // sets MESSAGE or DISCONNECTED state. |
| // SAFETY: The load above has synchronized with any message write. |
| </span><span class="kw">break unsafe </span>{ wait_for_unpark(channel) }; |
| } |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| } |
| } |
| }) |
| } |
| |
| <span class="doccomment">/// Begins the process of receiving on the channel by reference. If the message is already |
| /// ready, or the sender has disconnected, then this function will return the appropriate |
| /// Result immediately. Otherwise, it will write the waker to memory, check to see if the |
| /// sender has finished or disconnected again, and then will call `finish`. `finish` is |
| /// thus responsible for cleaning up the channel's resources appropriately before it returns, |
| /// such as destroying the waker, for instance. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| #[inline] |
| </span><span class="kw">fn </span>start_recv_ref<E>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| disconnected_error: E, |
| finish: <span class="kw">impl </span>FnOnce(<span class="kw-2">&</span>Channel<T>) -> <span class="prelude-ty">Result</span><T, E>, |
| ) -> <span class="prelude-ty">Result</span><T, E> { |
| <span class="comment">// SAFETY: the existence of the `self` parameter serves as a certificate that the receiver |
| // is still alive, meaning that even if the sender was dropped then it would have observed |
| // the fact that we're still alive and left the responsibility of deallocating the |
| // channel to us, so `self.channel` is valid |
| </span><span class="kw">let </span>channel = <span class="kw">unsafe </span>{ <span class="self">self</span>.channel_ptr.as_ref() }; |
| |
| <span class="comment">// ORDERING: synchronize with the write of the message |
| </span><span class="kw">match </span>channel.state.load(Acquire) { |
| <span class="comment">// The sender is alive but has not sent anything yet. We prepare to park. |
| </span>EMPTY => { |
| <span class="comment">// Conditionally add a delay here to help the tests trigger the edge cases where |
| // the sender manages to be dropped or send something before we are able to store |
| // our waker object in the channel. |
| </span><span class="attribute">#[cfg(oneshot_test_delay)] |
| </span>std::thread::sleep(std::time::Duration::from_millis(<span class="number">10</span>)); |
| |
| <span class="comment">// Write our waker instance to the channel. |
| // SAFETY: we are not yet in the RECEIVING state, meaning that the sender will not |
| // try to access the waker until it sees the state set to RECEIVING below |
| </span><span class="kw">unsafe </span>{ channel.write_waker(ReceiverWaker::current_thread()) }; |
| |
| <span class="comment">// ORDERING: we use release ordering on success so the sender can synchronize with |
| // our write of the waker. We use relaxed ordering on failure since the sender does |
| // not need to synchronize with our write and the individual match arms handle any |
| // additional synchronization |
| </span><span class="kw">match </span>channel |
| .state |
| .compare_exchange(EMPTY, RECEIVING, Release, Relaxed) |
| { |
| <span class="comment">// We stored our waker, now we delegate to the callback to finish the receive |
| // operation |
| </span><span class="prelude-val">Ok</span>(<span class="kw">_</span>) => finish(channel), |
| <span class="comment">// The sender sent the message while we prepared to finish |
| </span><span class="prelude-val">Err</span>(MESSAGE) => { |
| <span class="comment">// See comments in `recv` for ordering and safety |
| |
| </span>fence(Acquire); |
| |
| <span class="kw">unsafe </span>{ channel.drop_waker() }; |
| |
| <span class="comment">// ORDERING: the sender has been `mem::forget`-ed so this update only |
| // needs to be visible to us |
| </span>channel.state.store(DISCONNECTED, Relaxed); |
| |
| <span class="comment">// SAFETY: The MESSAGE state tells us there is a correctly initialized |
| // message |
| </span><span class="prelude-val">Ok</span>(<span class="kw">unsafe </span>{ channel.take_message() }) |
| } |
| <span class="comment">// The sender was dropped before sending anything while we prepared to park. |
| </span><span class="prelude-val">Err</span>(DISCONNECTED) => { |
| <span class="comment">// See comments in `recv` for safety |
| </span><span class="kw">unsafe </span>{ channel.drop_waker() }; |
| <span class="prelude-val">Err</span>(disconnected_error) |
| } |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| <span class="comment">// The sender sent the message. We take the message and mark the channel disconnected. |
| </span>MESSAGE => { |
| <span class="comment">// ORDERING: the sender has been `mem::forget`-ed so this update only needs to be |
| // visible to us |
| </span>channel.state.store(DISCONNECTED, Relaxed); |
| |
| <span class="comment">// SAFETY: we are in the message state so the message is valid |
| </span><span class="prelude-val">Ok</span>(<span class="kw">unsafe </span>{ channel.take_message() }) |
| } |
| <span class="comment">// The sender was dropped before sending anything, or we already received the message. |
| </span>DISCONNECTED => <span class="prelude-val">Err</span>(disconnected_error), |
| <span class="comment">// The receiver must have been `Future::poll`ed prior to this call. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"async"</span>)] |
| </span>RECEIVING | UNPARKING => <span class="macro">panic!</span>(<span class="string">"{}"</span>, RECEIVER_USED_SYNC_AND_ASYNC_ERROR), |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"async"</span>)] |
| </span><span class="kw">impl</span><T> core::future::Future <span class="kw">for </span>Receiver<T> { |
| <span class="kw">type </span>Output = <span class="prelude-ty">Result</span><T, RecvError>; |
| |
| <span class="kw">fn </span>poll(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>) -> Poll<<span class="self">Self</span>::Output> { |
| <span class="comment">// SAFETY: the existence of the `self` parameter serves as a certificate that the receiver |
| // is still alive, meaning that even if the sender was dropped then it would have observed |
| // the fact that we're still alive and left the responsibility of deallocating the |
| // channel to us, so `self.channel` is valid |
| </span><span class="kw">let </span>channel = <span class="kw">unsafe </span>{ <span class="self">self</span>.channel_ptr.as_ref() }; |
| |
| <span class="comment">// ORDERING: we use acquire ordering to synchronize with the store of the message. |
| </span><span class="kw">match </span>channel.state.load(Acquire) { |
| <span class="comment">// The sender is alive but has not sent anything yet. |
| </span>EMPTY => { |
| <span class="comment">// SAFETY: We can't be in the forbidden states, and no waker in the channel. |
| </span><span class="kw">unsafe </span>{ channel.write_async_waker(cx) } |
| } |
| <span class="comment">// We were polled again while waiting for the sender. Replace the waker with the new one. |
| </span>RECEIVING => { |
| <span class="comment">// ORDERING: We use relaxed ordering on both success and failure since we have not |
| // written anything above that must be released, and the individual match arms |
| // handle any additional synchronization. |
| </span><span class="kw">match </span>channel |
| .state |
| .compare_exchange(RECEIVING, EMPTY, Relaxed, Relaxed) |
| { |
| <span class="comment">// We successfully changed the state back to EMPTY. Replace the waker. |
| // This is the most likely branch to be taken, which is why we don't use any |
| // memory barriers in the compare_exchange above. |
| </span><span class="prelude-val">Ok</span>(<span class="kw">_</span>) => { |
| <span class="comment">// SAFETY: We wrote the waker in a previous call to poll. We do not need |
| // a memory barrier since the previous write here was by ourselves. |
| </span><span class="kw">unsafe </span>{ channel.drop_waker() }; |
| <span class="comment">// SAFETY: We can't be in the forbidden states, and no waker in the channel. |
| </span><span class="kw">unsafe </span>{ channel.write_async_waker(cx) } |
| } |
| <span class="comment">// The sender sent the message while we prepared to replace the waker. |
| // We take the message and mark the channel disconnected. |
| // The sender has already taken the waker. |
| </span><span class="prelude-val">Err</span>(MESSAGE) => { |
| <span class="comment">// ORDERING: Synchronize with the write of the message. This branch is |
| // unlikely to be taken. |
| </span>channel.state.swap(DISCONNECTED, Acquire); |
| <span class="comment">// SAFETY: The state tells us the sender has initialized the message. |
| </span>Poll::Ready(<span class="prelude-val">Ok</span>(<span class="kw">unsafe </span>{ channel.take_message() })) |
| } |
| <span class="comment">// The sender was dropped before sending anything while we prepared to park. |
| // The sender has taken the waker already. |
| </span><span class="prelude-val">Err</span>(DISCONNECTED) => Poll::Ready(<span class="prelude-val">Err</span>(RecvError)), |
| <span class="comment">// The sender is currently waking us up. |
| </span><span class="prelude-val">Err</span>(UNPARKING) => { |
| <span class="comment">// We can't trust that the old waker that the sender has access to |
| // is honored by the async runtime at this point. So we wake ourselves |
| // up to get polled instantly again. |
| </span>cx.waker().wake_by_ref(); |
| Poll::Pending |
| } |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| <span class="comment">// The sender sent the message. |
| </span>MESSAGE => { |
| <span class="comment">// ORDERING: the sender has been dropped so this update only needs to be |
| // visible to us |
| </span>channel.state.store(DISCONNECTED, Relaxed); |
| Poll::Ready(<span class="prelude-val">Ok</span>(<span class="kw">unsafe </span>{ channel.take_message() })) |
| } |
| <span class="comment">// The sender was dropped before sending anything, or we already received the message. |
| </span>DISCONNECTED => Poll::Ready(<span class="prelude-val">Err</span>(RecvError)), |
| <span class="comment">// The sender has observed the RECEIVING state and is currently reading the waker from |
| // a previous poll. We need to loop here until we observe the MESSAGE or DISCONNECTED |
| // state. We busy loop here since we know the sender is done very soon. |
| </span>UNPARKING => <span class="kw">loop </span>{ |
| hint::spin_loop(); |
| <span class="comment">// ORDERING: The load above has already synchronized with the write of the message. |
| </span><span class="kw">match </span>channel.state.load(Relaxed) { |
| MESSAGE => { |
| <span class="comment">// ORDERING: the sender has been dropped, so this update only |
| // needs to be visible to us |
| </span>channel.state.store(DISCONNECTED, Relaxed); |
| <span class="comment">// SAFETY: We observed the MESSAGE state |
| </span><span class="kw">break </span>Poll::Ready(<span class="prelude-val">Ok</span>(<span class="kw">unsafe </span>{ channel.take_message() })); |
| } |
| DISCONNECTED => <span class="kw">break </span>Poll::Ready(<span class="prelude-val">Err</span>(RecvError)), |
| UNPARKING => (), |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| }, |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> Drop <span class="kw">for </span>Receiver<T> { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="comment">// SAFETY: since the receiving side is still alive the sender would have observed that and |
| // left deallocating the channel allocation to us. |
| </span><span class="kw">let </span>channel = <span class="kw">unsafe </span>{ <span class="self">self</span>.channel_ptr.as_ref() }; |
| |
| <span class="comment">// Set the channel state to disconnected and read what state the receiver was in |
| </span><span class="kw">match </span>channel.state.swap(DISCONNECTED, Acquire) { |
| <span class="comment">// The sender has not sent anything, nor is it dropped. |
| </span>EMPTY => (), |
| <span class="comment">// The sender already sent something. We must drop it, and free the channel. |
| </span>MESSAGE => { |
| <span class="comment">// SAFETY: we are in the message state so the message is initialized |
| </span><span class="kw">unsafe </span>{ channel.drop_message() }; |
| |
| <span class="comment">// SAFETY: see safety comment at top of function |
| </span><span class="kw">unsafe </span>{ dealloc(<span class="self">self</span>.channel_ptr) }; |
| } |
| <span class="comment">// The receiver has been polled. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"async"</span>)] |
| </span>RECEIVING => { |
| <span class="comment">// TODO: figure this out when async is fixed |
| </span><span class="kw">unsafe </span>{ channel.drop_waker() }; |
| } |
| <span class="comment">// The sender was already dropped. We are responsible for freeing the channel. |
| </span>DISCONNECTED => { |
| <span class="comment">// SAFETY: see safety comment at top of function |
| </span><span class="kw">unsafe </span>{ dealloc(<span class="self">self</span>.channel_ptr) }; |
| } |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| } |
| |
| <span class="doccomment">/// All the values that the `Channel::state` field can have during the lifetime of a channel. |
| </span><span class="kw">mod </span>states { |
| <span class="comment">// These values are very explicitly chosen so that we can replace some cmpxchg calls with |
| // fetch_* calls. |
| |
| </span><span class="doccomment">/// The initial channel state. Active while both endpoints are still alive, no message has been |
| /// sent, and the receiver is not receiving. |
| </span><span class="kw">pub const </span>EMPTY: u8 = <span class="number">0b011</span>; |
| <span class="doccomment">/// A message has been sent to the channel, but the receiver has not yet read it. |
| </span><span class="kw">pub const </span>MESSAGE: u8 = <span class="number">0b100</span>; |
| <span class="doccomment">/// No message has yet been sent on the channel, but the receiver is currently receiving. |
| </span><span class="kw">pub const </span>RECEIVING: u8 = <span class="number">0b000</span>; |
| <span class="attribute">#[cfg(any(feature = <span class="string">"std"</span>, feature = <span class="string">"async"</span>))] |
| </span><span class="kw">pub const </span>UNPARKING: u8 = <span class="number">0b001</span>; |
| <span class="doccomment">/// The channel has been closed. This means that either the sender or receiver has been dropped, |
| /// or the message sent to the channel has already been received. Since this is a oneshot |
| /// channel, it is disconnected after the one message it is supposed to hold has been |
| /// transmitted. |
| </span><span class="kw">pub const </span>DISCONNECTED: u8 = <span class="number">0b010</span>; |
| } |
| <span class="kw">use </span>states::<span class="kw-2">*</span>; |
| |
| <span class="doccomment">/// Internal channel data structure structure. the `channel` method allocates and puts one instance |
| /// of this struct on the heap for each oneshot channel instance. The struct holds: |
| /// * The current state of the channel. |
| /// * The message in the channel. This memory is uninitialized until the message is sent. |
| /// * The waker instance for the thread or task that is currently receiving on this channel. |
| /// This memory is uninitialized until the receiver starts receiving. |
| </span><span class="kw">struct </span>Channel<T> { |
| state: AtomicU8, |
| message: UnsafeCell<MaybeUninit<T>>, |
| waker: UnsafeCell<MaybeUninit<ReceiverWaker>>, |
| } |
| |
| <span class="kw">impl</span><T> Channel<T> { |
| <span class="kw">pub fn </span>new() -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| state: AtomicU8::new(EMPTY), |
| message: UnsafeCell::new(MaybeUninit::uninit()), |
| waker: UnsafeCell::new(MaybeUninit::uninit()), |
| } |
| } |
| |
| <span class="attribute">#[inline(always)] |
| </span><span class="kw">unsafe fn </span>message(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>MaybeUninit<T> { |
| <span class="attribute">#[cfg(loom)] |
| </span>{ |
| <span class="self">self</span>.message.with(|ptr| <span class="kw-2">&*</span>ptr) |
| } |
| |
| <span class="attribute">#[cfg(not(loom))] |
| </span>{ |
| <span class="kw-2">&*</span><span class="self">self</span>.message.get() |
| } |
| } |
| |
| <span class="attribute">#[inline(always)] |
| </span><span class="kw">unsafe fn </span>with_message_mut<F>(<span class="kw-2">&</span><span class="self">self</span>, op: F) |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&mut </span>MaybeUninit<T>), |
| { |
| <span class="attribute">#[cfg(loom)] |
| </span>{ |
| <span class="self">self</span>.message.with_mut(|ptr| op(<span class="kw-2">&mut *</span>ptr)) |
| } |
| |
| <span class="attribute">#[cfg(not(loom))] |
| </span>{ |
| op(<span class="kw-2">&mut *</span><span class="self">self</span>.message.get()) |
| } |
| } |
| |
| <span class="attribute">#[inline(always)] |
| #[cfg(any(feature = <span class="string">"std"</span>, feature = <span class="string">"async"</span>))] |
| </span><span class="kw">unsafe fn </span>with_waker_mut<F>(<span class="kw-2">&</span><span class="self">self</span>, op: F) |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&mut </span>MaybeUninit<ReceiverWaker>), |
| { |
| <span class="attribute">#[cfg(loom)] |
| </span>{ |
| <span class="self">self</span>.waker.with_mut(|ptr| op(<span class="kw-2">&mut *</span>ptr)) |
| } |
| |
| <span class="attribute">#[cfg(not(loom))] |
| </span>{ |
| op(<span class="kw-2">&mut *</span><span class="self">self</span>.waker.get()) |
| } |
| } |
| |
| <span class="attribute">#[inline(always)] |
| </span><span class="kw">unsafe fn </span>write_message(<span class="kw-2">&</span><span class="self">self</span>, message: T) { |
| <span class="self">self</span>.with_message_mut(|slot| slot.as_mut_ptr().write(message)); |
| } |
| |
| <span class="attribute">#[inline(always)] |
| </span><span class="kw">unsafe fn </span>take_message(<span class="kw-2">&</span><span class="self">self</span>) -> T { |
| <span class="attribute">#[cfg(loom)] |
| </span>{ |
| <span class="self">self</span>.message.with(|ptr| ptr::read(ptr)).assume_init() |
| } |
| |
| <span class="attribute">#[cfg(not(loom))] |
| </span>{ |
| ptr::read(<span class="self">self</span>.message.get()).assume_init() |
| } |
| } |
| |
| <span class="attribute">#[inline(always)] |
| </span><span class="kw">unsafe fn </span>drop_message(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="self">self</span>.with_message_mut(|slot| slot.assume_init_drop()); |
| } |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"std"</span>, feature = <span class="string">"async"</span>))] |
| #[inline(always)] |
| </span><span class="kw">unsafe fn </span>write_waker(<span class="kw-2">&</span><span class="self">self</span>, waker: ReceiverWaker) { |
| <span class="self">self</span>.with_waker_mut(|slot| slot.as_mut_ptr().write(waker)); |
| } |
| |
| <span class="attribute">#[inline(always)] |
| </span><span class="kw">unsafe fn </span>take_waker(<span class="kw-2">&</span><span class="self">self</span>) -> ReceiverWaker { |
| <span class="attribute">#[cfg(loom)] |
| </span>{ |
| <span class="self">self</span>.waker.with(|ptr| ptr::read(ptr)).assume_init() |
| } |
| |
| <span class="attribute">#[cfg(not(loom))] |
| </span>{ |
| ptr::read(<span class="self">self</span>.waker.get()).assume_init() |
| } |
| } |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"std"</span>, feature = <span class="string">"async"</span>))] |
| #[inline(always)] |
| </span><span class="kw">unsafe fn </span>drop_waker(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="self">self</span>.with_waker_mut(|slot| slot.assume_init_drop()); |
| } |
| |
| <span class="doccomment">/// # Safety |
| /// |
| /// * `Channel::waker` must not have a waker stored in it when calling this method. |
| /// * Channel state must not be RECEIVING or UNPARKING when calling this method. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"async"</span>)] |
| </span><span class="kw">unsafe fn </span>write_async_waker(<span class="kw-2">&</span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><T, RecvError>> { |
| <span class="comment">// Write our thread instance to the channel. |
| // SAFETY: we are not yet in the RECEIVING state, meaning that the sender will not |
| // try to access the waker until it sees the state set to RECEIVING below |
| </span><span class="self">self</span>.write_waker(ReceiverWaker::task_waker(cx)); |
| |
| <span class="comment">// ORDERING: we use release ordering on success so the sender can synchronize with |
| // our write of the waker. We use relaxed ordering on failure since the sender does |
| // not need to synchronize with our write and the individual match arms handle any |
| // additional synchronization |
| </span><span class="kw">match </span><span class="self">self |
| </span>.state |
| .compare_exchange(EMPTY, RECEIVING, Release, Relaxed) |
| { |
| <span class="comment">// We stored our waker, now we return and let the sender wake us up |
| </span><span class="prelude-val">Ok</span>(<span class="kw">_</span>) => Poll::Pending, |
| <span class="comment">// The sender sent the message while we prepared to park. |
| // We take the message and mark the channel disconnected. |
| </span><span class="prelude-val">Err</span>(MESSAGE) => { |
| <span class="comment">// ORDERING: Synchronize with the write of the message. This branch is |
| // unlikely to be taken, so it's likely more efficient to use a fence here |
| // instead of AcqRel ordering on the compare_exchange operation |
| </span>fence(Acquire); |
| |
| <span class="comment">// SAFETY: we started in the EMPTY state and the sender switched us to the |
| // MESSAGE state. This means that it did not take the waker, so we're |
| // responsible for dropping it. |
| </span><span class="self">self</span>.drop_waker(); |
| |
| <span class="comment">// ORDERING: sender does not exist, so this update only needs to be visible to us |
| </span><span class="self">self</span>.state.store(DISCONNECTED, Relaxed); |
| |
| <span class="comment">// SAFETY: The MESSAGE state tells us there is a correctly initialized message |
| </span>Poll::Ready(<span class="prelude-val">Ok</span>(<span class="self">self</span>.take_message())) |
| } |
| <span class="comment">// The sender was dropped before sending anything while we prepared to park. |
| </span><span class="prelude-val">Err</span>(DISCONNECTED) => { |
| <span class="comment">// SAFETY: we started in the EMPTY state and the sender switched us to the |
| // DISCONNECTED state. This means that it did not take the waker, so we're |
| // responsible for dropping it. |
| </span><span class="self">self</span>.drop_waker(); |
| Poll::Ready(<span class="prelude-val">Err</span>(RecvError)) |
| } |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| } |
| |
| <span class="kw">enum </span>ReceiverWaker { |
| <span class="doccomment">/// The receiver is waiting synchronously. Its thread is parked. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span>Thread(thread::Thread), |
| <span class="doccomment">/// The receiver is waiting asynchronously. Its task can be woken up with this `Waker`. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"async"</span>)] |
| </span>Task(task::Waker), |
| <span class="doccomment">/// A little hack to not make this enum an uninhibitable type when no features are enabled. |
| </span><span class="attribute">#[cfg(not(any(feature = <span class="string">"async"</span>, feature = <span class="string">"std"</span>)))] |
| </span>_Uninhabited, |
| } |
| |
| <span class="kw">impl </span>ReceiverWaker { |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">pub fn </span>current_thread() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::Thread(thread::current()) |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"async"</span>)] |
| </span><span class="kw">pub fn </span>task_waker(cx: <span class="kw-2">&</span>task::Context<<span class="lifetime">'_</span>>) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::Task(cx.waker().clone()) |
| } |
| |
| <span class="kw">pub fn </span>unpark(<span class="self">self</span>) { |
| <span class="kw">match </span><span class="self">self </span>{ |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span>ReceiverWaker::Thread(thread) => thread.unpark(), |
| <span class="attribute">#[cfg(feature = <span class="string">"async"</span>)] |
| </span>ReceiverWaker::Task(waker) => waker.wake(), |
| <span class="attribute">#[cfg(not(any(feature = <span class="string">"async"</span>, feature = <span class="string">"std"</span>)))] |
| </span>ReceiverWaker::_Uninhabited => <span class="macro">unreachable!</span>(), |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(not(loom))] |
| #[test] |
| </span><span class="kw">fn </span>receiver_waker_size() { |
| <span class="kw">let </span>expected: usize = <span class="kw">match </span>(<span class="macro">cfg!</span>(feature = <span class="string">"std"</span>), <span class="macro">cfg!</span>(feature = <span class="string">"async"</span>)) { |
| (<span class="bool-val">false</span>, <span class="bool-val">false</span>) => <span class="number">0</span>, |
| (<span class="bool-val">false</span>, <span class="bool-val">true</span>) => <span class="number">16</span>, |
| (<span class="bool-val">true</span>, <span class="bool-val">false</span>) => <span class="number">8</span>, |
| (<span class="bool-val">true</span>, <span class="bool-val">true</span>) => <span class="number">24</span>, |
| }; |
| <span class="macro">assert_eq!</span>(mem::size_of::<ReceiverWaker>(), expected); |
| } |
| |
| <span class="attribute">#[cfg(all(feature = <span class="string">"std"</span>, feature = <span class="string">"async"</span>))] |
| </span><span class="kw">const </span>RECEIVER_USED_SYNC_AND_ASYNC_ERROR: <span class="kw-2">&</span>str = |
| <span class="string">"Invalid to call a blocking receive method on oneshot::Receiver after it has been polled"</span>; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">unsafe fn </span>dealloc<T>(channel: NonNull<Channel<T>>) { |
| drop(Box::from_raw(channel.as_ptr())) |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="oneshot" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |