<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="Source to the Rust file `/Users/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/futures-0.1.20/src/sync/oneshot.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>oneshot.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../../dark.css">
<link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle">
<script src="../../../storage.js"></script>
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
</pre><pre class="rust ">
<span class="doccomment">//! A one-shot, futures-aware channel</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">AtomicBool</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
<span class="kw">use</span> {<span class="ident">Future</span>, <span class="ident">Poll</span>, <span class="ident">Async</span>};
<span class="kw">use</span> <span class="ident">future</span>::{<span class="ident">lazy</span>, <span class="ident">Lazy</span>, <span class="ident">Executor</span>, <span class="ident">IntoFuture</span>};
<span class="kw">use</span> <span class="ident">lock</span>::<span class="ident">Lock</span>;
<span class="kw">use</span> <span class="ident">task</span>::{<span class="self">self</span>, <span class="ident">Task</span>};
<span class="doccomment">/// A future representing the completion of a computation happening elsewhere in</span>
<span class="doccomment">/// memory.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is created by the `oneshot::channel` function.</span>
<span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"futures do nothing unless polled"</span>]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Receiver</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">inner</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Inner</span><span class="op"><</span><span class="ident">T</span><span class="op">>></span>,
}
<span class="doccomment">/// Represents the completion half of a oneshot through which the result of a</span>
<span class="doccomment">/// computation is signaled.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is created by the `oneshot::channel` function.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Sender</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">inner</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Inner</span><span class="op"><</span><span class="ident">T</span><span class="op">>></span>,
}
<span class="doccomment">/// Internal state of the `Receiver`/`Sender` pair above. This is all used as</span>
<span class="doccomment">/// the internal synchronization between the two for send/recv operations.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">struct</span> <span class="ident">Inner</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="doccomment">/// Indicates whether this oneshot is complete yet. This is filled in both</span>
<span class="doccomment">/// by `Sender::drop` and by `Receiver::drop`, and both sides interpret it</span>
<span class="doccomment">/// appropriately.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For `Receiver`, if this is `true`, then it's guaranteed that `data` is</span>
<span class="doccomment">/// unlocked and ready to be inspected.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For `Sender` if this is `true` then the oneshot has gone away and it</span>
<span class="doccomment">/// can return ready from `poll_cancel`.</span>
<span class="ident">complete</span>: <span class="ident">AtomicBool</span>,
<span class="doccomment">/// The actual data being transferred as part of this `Receiver`. This is</span>
<span class="doccomment">/// filled in by `Sender::complete` and read by `Receiver::poll`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this is protected by `Lock`, but it is in theory safe to</span>
<span class="doccomment">/// replace with an `UnsafeCell` as it's actually protected by `complete`</span>
<span class="doccomment">/// above. I wouldn't recommend doing this, however, unless someone is</span>
<span class="doccomment">/// supremely confident in the various atomic orderings here and there.</span>
<span class="ident">data</span>: <span class="ident">Lock</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">T</span><span class="op">>></span>,
<span class="doccomment">/// Field to store the task which is blocked in `Receiver::poll`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is filled in when a oneshot is polled but not ready yet. Note that</span>
<span class="doccomment">/// the `Lock` here, unlike in `data` above, is important to resolve races.</span>
<span class="doccomment">/// Both the `Receiver` and the `Sender` halves understand that if they</span>
<span class="doccomment">/// can't acquire the lock then some important interference is happening.</span>
<span class="ident">rx_task</span>: <span class="ident">Lock</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Task</span><span class="op">>></span>,
<span class="doccomment">/// Like `rx_task` above, except for the task blocked in</span>
<span class="doccomment">/// `Sender::poll_cancel`. Additionally, `Lock` cannot be `UnsafeCell`.</span>
<span class="ident">tx_task</span>: <span class="ident">Lock</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Task</span><span class="op">>></span>,
}
<span class="doccomment">/// Creates a new futures-aware, one-shot channel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function is similar to Rust's channels found in the standard library.</span>
<span class="doccomment">/// Two halves are returned, the first of which is a `Sender` handle, used to</span>
<span class="doccomment">/// signal the end of a computation and provide its value. The second half is a</span>
<span class="doccomment">/// `Receiver` which implements the `Future` trait, resolving to the value that</span>
<span class="doccomment">/// was given to the `Sender` handle.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Each half can be separately owned and sent across threads/tasks.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::thread;</span>
<span class="doccomment">/// use futures::sync::oneshot;</span>
<span class="doccomment">/// use futures::*;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (p, c) = oneshot::channel::<i32>();</span>
<span class="doccomment">///</span>
<span class="doccomment">/// thread::spawn(|| {</span>
<span class="doccomment">/// c.map(|i| {</span>
<span class="doccomment">/// println!("got: {}", i);</span>
<span class="doccomment">/// }).wait();</span>
<span class="doccomment">/// });</span>
<span class="doccomment">///</span>
<span class="doccomment">/// p.send(3).unwrap();</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">channel</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>() <span class="op">-></span> (<span class="ident">Sender</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>, <span class="ident">Receiver</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>) {
<span class="kw">let</span> <span class="ident">inner</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">Inner</span>::<span class="ident">new</span>());
<span class="kw">let</span> <span class="ident">receiver</span> <span class="op">=</span> <span class="ident">Receiver</span> {
<span class="ident">inner</span>: <span class="ident">inner</span>.<span class="ident">clone</span>(),
};
<span class="kw">let</span> <span class="ident">sender</span> <span class="op">=</span> <span class="ident">Sender</span> {
<span class="ident">inner</span>: <span class="ident">inner</span>,
};
(<span class="ident">sender</span>, <span class="ident">receiver</span>)
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Inner</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="ident">Inner</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">Inner</span> {
<span class="ident">complete</span>: <span class="ident">AtomicBool</span>::<span class="ident">new</span>(<span class="bool-val">false</span>),
<span class="ident">data</span>: <span class="ident">Lock</span>::<span class="ident">new</span>(<span class="prelude-val">None</span>),
<span class="ident">rx_task</span>: <span class="ident">Lock</span>::<span class="ident">new</span>(<span class="prelude-val">None</span>),
<span class="ident">tx_task</span>: <span class="ident">Lock</span>::<span class="ident">new</span>(<span class="prelude-val">None</span>),
}
}
<span class="kw">fn</span> <span class="ident">send</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">t</span>: <span class="ident">T</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">T</span><span class="op">></span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">complete</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">t</span>)
}
<span class="comment">// Note that this lock acquisition may fail if the receiver</span>
<span class="comment">// is closed and sets the `complete` flag to true, whereupon</span>
<span class="comment">// the receiver may call `poll()`.</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">mut</span> <span class="ident">slot</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">data</span>.<span class="ident">try_lock</span>() {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">slot</span>.<span class="ident">is_none</span>());
<span class="kw-2">*</span><span class="ident">slot</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">t</span>);
<span class="ident">drop</span>(<span class="ident">slot</span>);
<span class="comment">// If the receiver called `close()` between the check at the</span>
<span class="comment">// start of the function, and the lock being released, then</span>
<span class="comment">// the receiver may not be around to receive it, so try to</span>
<span class="comment">// pull it back out.</span>
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">complete</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
<span class="comment">// If lock acquisition fails, then receiver is actually</span>
<span class="comment">// receiving it, so we're good.</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">mut</span> <span class="ident">slot</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">data</span>.<span class="ident">try_lock</span>() {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">t</span>) <span class="op">=</span> <span class="ident">slot</span>.<span class="ident">take</span>() {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">t</span>);
}
}
}
<span class="prelude-val">Ok</span>(())
} <span class="kw">else</span> {
<span class="comment">// Must have been closed</span>
<span class="prelude-val">Err</span>(<span class="ident">t</span>)
}
}
<span class="kw">fn</span> <span class="ident">poll_cancel</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span>(), ()<span class="op">></span> {
<span class="comment">// Fast path up first, just read the flag and see if our other half is</span>
<span class="comment">// gone. This flag is set both in our destructor and the oneshot</span>
<span class="comment">// destructor, but our destructor hasn't run yet so if it's set then the</span>
<span class="comment">// oneshot is gone.</span>
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">complete</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(()))
}
<span class="comment">// If our other half is not gone then we need to park our current task</span>
<span class="comment">// and move it into the `notify_cancel` slot to get notified when it's</span>
<span class="comment">// actually gone.</span>
<span class="comment">//</span>
<span class="comment">// If `try_lock` fails, then the `Receiver` is in the process of using</span>
<span class="comment">// it, so we can deduce that it's now in the process of going away and</span>
<span class="comment">// hence we're canceled. If it succeeds then we just store our handle.</span>
<span class="comment">//</span>
<span class="comment">// Crucially we then check `oneshot_gone` *again* before we return.</span>
<span class="comment">// While we were storing our handle inside `notify_cancel` the `Receiver`</span>
<span class="comment">// may have been dropped. The first thing it does is set the flag, and</span>
<span class="comment">// if it fails to acquire the lock it assumes that we'll see the flag</span>
<span class="comment">// later on. So... we then try to see the flag later on!</span>
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="ident">task</span>::<span class="ident">current</span>();
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">tx_task</span>.<span class="ident">try_lock</span>() {
<span class="prelude-val">Some</span>(<span class="kw-2">mut</span> <span class="ident">p</span>) <span class="op">=></span> <span class="kw-2">*</span><span class="ident">p</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">handle</span>),
<span class="prelude-val">None</span> <span class="op">=></span> <span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(())),
}
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">complete</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(()))
} <span class="kw">else</span> {
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">NotReady</span>)
}
}
<span class="kw">fn</span> <span class="ident">is_canceled</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">complete</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>)
}
<span class="kw">fn</span> <span class="ident">drop_tx</span>(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="comment">// Flag that we're a completed `Sender` and try to wake up a receiver.</span>
<span class="comment">// Whether or not we actually stored any data will get picked up and</span>
<span class="comment">// translated to either an item or cancellation.</span>
<span class="comment">//</span>
<span class="comment">// Note that if we fail to acquire the `rx_task` lock then that means</span>
<span class="comment">// we're in one of two situations:</span>
<span class="comment">//</span>
<span class="comment">// 1. The receiver is trying to block in `poll`</span>
<span class="comment">// 2. The receiver is being dropped</span>
<span class="comment">//</span>
<span class="comment">// In the first case it'll check the `complete` flag after it's done</span>
<span class="comment">// blocking to see if it succeeded. In the latter case we don't need to</span>
<span class="comment">// wake up anyone anyway. So in both cases it's ok to ignore the `None`</span>
<span class="comment">// case of `try_lock` and bail out.</span>
<span class="comment">//</span>
<span class="comment">// The first case crucially depends on `Lock` using `SeqCst` ordering</span>
<span class="comment">// under the hood. If it instead used `Release` / `Acquire` ordering,</span>
<span class="comment">// then it would not necessarily synchronize with `inner.complete`</span>
<span class="comment">// and deadlock might be possible, as was observed in</span>
<span class="comment">// https://github.com/rust-lang-nursery/futures-rs/pull/219.</span>
<span class="self">self</span>.<span class="ident">complete</span>.<span class="ident">store</span>(<span class="bool-val">true</span>, <span class="ident">SeqCst</span>);
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">mut</span> <span class="ident">slot</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">rx_task</span>.<span class="ident">try_lock</span>() {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">task</span>) <span class="op">=</span> <span class="ident">slot</span>.<span class="ident">take</span>() {
<span class="ident">drop</span>(<span class="ident">slot</span>);
<span class="ident">task</span>.<span class="ident">notify</span>();
}
}
}
<span class="kw">fn</span> <span class="ident">close_rx</span>(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="comment">// Flag our completion and then attempt to wake up the sender if it's</span>
<span class="comment">// blocked. See comments in `drop` below for more info</span>
<span class="self">self</span>.<span class="ident">complete</span>.<span class="ident">store</span>(<span class="bool-val">true</span>, <span class="ident">SeqCst</span>);
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">mut</span> <span class="ident">handle</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">tx_task</span>.<span class="ident">try_lock</span>() {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">task</span>) <span class="op">=</span> <span class="ident">handle</span>.<span class="ident">take</span>() {
<span class="ident">drop</span>(<span class="ident">handle</span>);
<span class="ident">task</span>.<span class="ident">notify</span>()
}
}
}
<span class="kw">fn</span> <span class="ident">recv</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Canceled</span><span class="op">></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">done</span> <span class="op">=</span> <span class="bool-val">false</span>;
<span class="comment">// Check to see if some data has arrived. If it hasn't then we need to</span>
<span class="comment">// block our task.</span>
<span class="comment">//</span>
<span class="comment">// Note that the acquisition of the `rx_task` lock might fail below, but</span>
<span class="comment">// the only situation where this can happen is during `Sender::drop`</span>
<span class="comment">// when we are indeed completed already. If that's happening then we</span>
<span class="comment">// know we're completed so keep going.</span>
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">complete</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
<span class="ident">done</span> <span class="op">=</span> <span class="bool-val">true</span>;
} <span class="kw">else</span> {
<span class="kw">let</span> <span class="ident">task</span> <span class="op">=</span> <span class="ident">task</span>::<span class="ident">current</span>();
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">rx_task</span>.<span class="ident">try_lock</span>() {
<span class="prelude-val">Some</span>(<span class="kw-2">mut</span> <span class="ident">slot</span>) <span class="op">=></span> <span class="kw-2">*</span><span class="ident">slot</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">task</span>),
<span class="prelude-val">None</span> <span class="op">=></span> <span class="ident">done</span> <span class="op">=</span> <span class="bool-val">true</span>,
}
}
<span class="comment">// If we're `done` via one of the paths above, then look at the data and</span>
<span class="comment">// figure out what the answer is. If, however, we stored `rx_task`</span>
<span class="comment">// successfully above we need to check again if we're completed in case</span>
<span class="comment">// a message was sent while `rx_task` was locked and couldn't notify us</span>
<span class="comment">// otherwise.</span>
<span class="comment">//</span>
<span class="comment">// If we're not done, and we're not complete, though, then we've</span>
<span class="comment">// successfully blocked our task and we return `NotReady`.</span>
<span class="kw">if</span> <span class="ident">done</span> <span class="op">||</span> <span class="self">self</span>.<span class="ident">complete</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
<span class="comment">// If taking the lock fails, the sender will realise that the we're</span>
<span class="comment">// `done` when it checks the `complete` flag on the way out, and will</span>
<span class="comment">// treat the send as a failure.</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">mut</span> <span class="ident">slot</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">data</span>.<span class="ident">try_lock</span>() {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">data</span>) <span class="op">=</span> <span class="ident">slot</span>.<span class="ident">take</span>() {
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">data</span>.<span class="ident">into</span>());
}
}
<span class="prelude-val">Err</span>(<span class="ident">Canceled</span>)
} <span class="kw">else</span> {
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">NotReady</span>)
}
}
<span class="kw">fn</span> <span class="ident">drop_rx</span>(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="comment">// Indicate to the `Sender` that we're done, so any future calls to</span>
<span class="comment">// `poll_cancel` are weeded out.</span>
<span class="self">self</span>.<span class="ident">complete</span>.<span class="ident">store</span>(<span class="bool-val">true</span>, <span class="ident">SeqCst</span>);
<span class="comment">// If we've blocked a task then there's no need for it to stick around,</span>
<span class="comment">// so we need to drop it. If this lock acquisition fails, though, then</span>
<span class="comment">// it's just because our `Sender` is trying to take the task, so we</span>
<span class="comment">// let them take care of that.</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">mut</span> <span class="ident">slot</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">rx_task</span>.<span class="ident">try_lock</span>() {
<span class="kw">let</span> <span class="ident">task</span> <span class="op">=</span> <span class="ident">slot</span>.<span class="ident">take</span>();
<span class="ident">drop</span>(<span class="ident">slot</span>);
<span class="ident">drop</span>(<span class="ident">task</span>);
}
<span class="comment">// Finally, if our `Sender` wants to get notified of us going away, it</span>
<span class="comment">// would have stored something in `tx_task`. Here we try to peel that</span>
<span class="comment">// out and unpark it.</span>
<span class="comment">//</span>
<span class="comment">// Note that the `try_lock` here may fail, but only if the `Sender` is</span>
<span class="comment">// in the process of filling in the task. If that happens then we</span>
<span class="comment">// already flagged `complete` and they'll pick that up above.</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">mut</span> <span class="ident">handle</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">tx_task</span>.<span class="ident">try_lock</span>() {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">task</span>) <span class="op">=</span> <span class="ident">handle</span>.<span class="ident">take</span>() {
<span class="ident">drop</span>(<span class="ident">handle</span>);
<span class="ident">task</span>.<span class="ident">notify</span>()
}
}
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Sender</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">note</span> <span class="op">=</span> <span class="string">"renamed to `send`"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"0.1.11"</span>)]</span>
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"with-deprecated"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">complete</span>(<span class="self">self</span>, <span class="ident">t</span>: <span class="ident">T</span>) {
<span class="ident">drop</span>(<span class="self">self</span>.<span class="ident">send</span>(<span class="ident">t</span>));
}
<span class="doccomment">/// Completes this oneshot with a successful result.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will consume `self` and indicate to the other end, the</span>
<span class="doccomment">/// `Receiver`, that the value provided is the result of the computation this</span>
<span class="doccomment">/// represents.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If the value is successfully enqueued for the remote end to receive,</span>
<span class="doccomment">/// then `Ok(())` is returned. If the receiving end was deallocated before</span>
<span class="doccomment">/// this function was called, however, then `Err` is returned with the value</span>
<span class="doccomment">/// provided.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">send</span>(<span class="self">self</span>, <span class="ident">t</span>: <span class="ident">T</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">T</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">send</span>(<span class="ident">t</span>)
}
<span class="doccomment">/// Polls this `Sender` half to detect whether the `Receiver` this has</span>
<span class="doccomment">/// paired with has gone away.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function can be used to learn about when the `Receiver` (consumer)</span>
<span class="doccomment">/// half has gone away and nothing will be able to receive a message sent</span>
<span class="doccomment">/// from `send`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If `Ready` is returned then it means that the `Receiver` has disappeared</span>
<span class="doccomment">/// and the result this `Sender` would otherwise produce should no longer</span>
<span class="doccomment">/// be produced.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If `NotReady` is returned then the `Receiver` is still alive and may be</span>
<span class="doccomment">/// able to receive a message if sent. The current task, however, is</span>
<span class="doccomment">/// scheduled to receive a notification if the corresponding `Receiver` goes</span>
<span class="doccomment">/// away.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Like `Future::poll`, this function will panic if it's not called from</span>
<span class="doccomment">/// within the context of a task. In other words, this should only ever be</span>
<span class="doccomment">/// called from inside another future.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If you're calling this function from a context that does not have a</span>
<span class="doccomment">/// task, then you can use the `is_canceled` API instead.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">poll_cancel</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span>(), ()<span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">poll_cancel</span>()
}
<span class="doccomment">/// Tests to see whether this `Sender`'s corresponding `Receiver`</span>
<span class="doccomment">/// has gone away.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function can be used to learn about when the `Receiver` (consumer)</span>
<span class="doccomment">/// half has gone away and nothing will be able to receive a message sent</span>
<span class="doccomment">/// from `send`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this function is intended to *not* be used in the context of a</span>
<span class="doccomment">/// future. If you're implementing a future you probably want to call the</span>
<span class="doccomment">/// `poll_cancel` function which will block the current task if the</span>
<span class="doccomment">/// cancellation hasn't happened yet. This can be useful when working on a</span>
<span class="doccomment">/// non-futures related thread, though, which would otherwise panic if</span>
<span class="doccomment">/// `poll_cancel` were called.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_canceled</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">is_canceled</span>()
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Sender</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">drop_tx</span>()
}
}
<span class="doccomment">/// Error returned from a `Receiver<T>` whenever the corresponding `Sender<T>`</span>
<span class="doccomment">/// is dropped.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Canceled</span>;
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">Canceled</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">fmt</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">fmt</span>, <span class="string">"oneshot canceled"</span>)
}
}
<span class="kw">impl</span> <span class="ident">Error</span> <span class="kw">for</span> <span class="ident">Canceled</span> {
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">str</span> {
<span class="string">"oneshot canceled"</span>
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Receiver</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="doccomment">/// Gracefully close this receiver, preventing sending any future messages.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Any `send` operation which happens after this method returns is</span>
<span class="doccomment">/// guaranteed to fail. Once this method is called the normal `poll` method</span>
<span class="doccomment">/// can be used to determine whether a message was actually sent or not. If</span>
<span class="doccomment">/// `Canceled` is returned from `poll` then no message was sent.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">close</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">close_rx</span>()
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">Receiver</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">T</span>;
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">Canceled</span>;
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Canceled</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">recv</span>()
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Receiver</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">drop_rx</span>()
}
}
<span class="doccomment">/// Handle returned from the `spawn` function.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This handle is a future representing the completion of a different future on</span>
<span class="doccomment">/// a separate executor. Created through the `oneshot::spawn` function this</span>
<span class="doccomment">/// handle will resolve when the future provided to `spawn` resolves on the</span>
<span class="doccomment">/// `Executor` instance provided to that function.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If this handle is dropped then the future will automatically no longer be</span>
<span class="doccomment">/// polled and is scheduled to be dropped. This can be canceled with the</span>
<span class="doccomment">/// `forget` function, however.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">SpawnHandle</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> {
<span class="ident">rx</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">ExecuteInner</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">>></span><span class="op">></span>,
}
<span class="kw">struct</span> <span class="ident">ExecuteInner</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">inner</span>: <span class="ident">Inner</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>,
<span class="ident">keep_running</span>: <span class="ident">AtomicBool</span>,
}
<span class="doccomment">/// Type of future which `Execute` instances below must be able to spawn.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Execute</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">Future</span><span class="op">></span> {
<span class="ident">future</span>: <span class="ident">F</span>,
<span class="ident">tx</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">ExecuteInner</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">F</span>::<span class="ident">Item</span>, <span class="ident">F</span>::<span class="ident">Error</span><span class="op">>></span><span class="op">></span>,
}
<span class="doccomment">/// Spawns a `future` onto the instance of `Executor` provided, `executor`,</span>
<span class="doccomment">/// returning a handle representing the completion of the future.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The `SpawnHandle` returned is a future that is a proxy for `future` itself.</span>
<span class="doccomment">/// When `future` completes on `executor` then the `SpawnHandle` will itself be</span>
<span class="doccomment">/// resolved. Internally `SpawnHandle` contains a `oneshot` channel and is</span>
<span class="doccomment">/// thus safe to send across threads.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The `future` will be canceled if the `SpawnHandle` is dropped. If this is</span>
<span class="doccomment">/// not desired then the `SpawnHandle::forget` function can be used to continue</span>
<span class="doccomment">/// running the future to completion.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will panic if the instance of `Spawn` provided is unable to</span>
<span class="doccomment">/// spawn the `future` provided.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If the provided instance of `Spawn` does not actually run `future` to</span>
<span class="doccomment">/// completion, then the returned handle may panic when polled. Typically this</span>
<span class="doccomment">/// is not a problem, though, as most instances of `Spawn` will run futures to</span>
<span class="doccomment">/// completion.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that the returned future will likely panic if the `futures` provided</span>
<span class="doccomment">/// panics. If a future running on an executor panics that typically means that</span>
<span class="doccomment">/// the executor drops the future, which falls into the above case of not</span>
<span class="doccomment">/// running the future to completion essentially.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">spawn</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">E</span><span class="op">></span>(<span class="ident">future</span>: <span class="ident">F</span>, <span class="ident">executor</span>: <span class="kw-2">&</span><span class="ident">E</span>) <span class="op">-></span> <span class="ident">SpawnHandle</span><span class="op"><</span><span class="ident">F</span>::<span class="ident">Item</span>, <span class="ident">F</span>::<span class="ident">Error</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">Future</span>,
<span class="ident">E</span>: <span class="ident">Executor</span><span class="op"><</span><span class="ident">Execute</span><span class="op"><</span><span class="ident">F</span><span class="op">>></span>,
{
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">ExecuteInner</span> {
<span class="ident">inner</span>: <span class="ident">Inner</span>::<span class="ident">new</span>(),
<span class="ident">keep_running</span>: <span class="ident">AtomicBool</span>::<span class="ident">new</span>(<span class="bool-val">false</span>),
});
<span class="ident">executor</span>.<span class="ident">execute</span>(<span class="ident">Execute</span> {
<span class="ident">future</span>: <span class="ident">future</span>,
<span class="ident">tx</span>: <span class="ident">data</span>.<span class="ident">clone</span>(),
}).<span class="ident">expect</span>(<span class="string">"failed to spawn future"</span>);
<span class="ident">SpawnHandle</span> { <span class="ident">rx</span>: <span class="ident">data</span> }
}
<span class="doccomment">/// Spawns a function `f` onto the `Spawn` instance provided `s`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For more information see the `spawn` function in this module. This function</span>
<span class="doccomment">/// is just a thin wrapper around `spawn` which will execute the closure on the</span>
<span class="doccomment">/// executor provided and then complete the future that the closure returns.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">spawn_fn</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">R</span>, <span class="ident">E</span><span class="op">></span>(<span class="ident">f</span>: <span class="ident">F</span>, <span class="ident">executor</span>: <span class="kw-2">&</span><span class="ident">E</span>) <span class="op">-></span> <span class="ident">SpawnHandle</span><span class="op"><</span><span class="ident">R</span>::<span class="ident">Item</span>, <span class="ident">R</span>::<span class="ident">Error</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>() <span class="op">-></span> <span class="ident">R</span>,
<span class="ident">R</span>: <span class="ident">IntoFuture</span>,
<span class="ident">E</span>: <span class="ident">Executor</span><span class="op"><</span><span class="ident">Execute</span><span class="op"><</span><span class="ident">Lazy</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">R</span><span class="op">>></span><span class="op">></span>,
{
<span class="ident">spawn</span>(<span class="ident">lazy</span>(<span class="ident">f</span>), <span class="ident">executor</span>)
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> <span class="ident">SpawnHandle</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> {
<span class="doccomment">/// Drop this future without canceling the underlying future.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When `SpawnHandle` is dropped, the spawned future will be canceled as</span>
<span class="doccomment">/// well if the future hasn't already resolved. This function can be used</span>
<span class="doccomment">/// when to drop this future but keep executing the underlying future.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">forget</span>(<span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">rx</span>.<span class="ident">keep_running</span>.<span class="ident">store</span>(<span class="bool-val">true</span>, <span class="ident">SeqCst</span>);
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">SpawnHandle</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">T</span>;
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">E</span>;
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">rx</span>.<span class="ident">inner</span>.<span class="ident">recv</span>() {
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="prelude-val">Ok</span>(<span class="ident">t</span>))) <span class="op">=></span> <span class="prelude-val">Ok</span>(<span class="ident">t</span>.<span class="ident">into</span>()),
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="prelude-val">Err</span>(<span class="ident">e</span>))) <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">e</span>),
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">NotReady</span>) <span class="op">=></span> <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">NotReady</span>),
<span class="prelude-val">Err</span>(_) <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"future was canceled before completion"</span>),
}
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">fmt</span>::<span class="ident">Debug</span>, <span class="ident">E</span>: <span class="ident">fmt</span>::<span class="ident">Debug</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">SpawnHandle</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="ident">f</span>.<span class="ident">debug_struct</span>(<span class="string">"SpawnHandle"</span>)
.<span class="ident">finish</span>()
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">SpawnHandle</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">rx</span>.<span class="ident">inner</span>.<span class="ident">drop_rx</span>();
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">Future</span><span class="op">></span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">Execute</span><span class="op"><</span><span class="ident">F</span><span class="op">></span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> ();
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> ();
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span>(), ()<span class="op">></span> {
<span class="comment">// If we're canceled then we may want to bail out early.</span>
<span class="comment">//</span>
<span class="comment">// If the `forget` function was called, though, then we keep going.</span>
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">tx</span>.<span class="ident">inner</span>.<span class="ident">poll_cancel</span>().<span class="ident">unwrap</span>().<span class="ident">is_ready</span>() {
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">tx</span>.<span class="ident">keep_running</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
<span class="kw">return</span> <span class="prelude-val">Ok</span>(().<span class="ident">into</span>())
}
}
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">future</span>.<span class="ident">poll</span>() {
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">NotReady</span>) <span class="op">=></span> <span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">NotReady</span>),
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="ident">t</span>)) <span class="op">=></span> <span class="prelude-val">Ok</span>(<span class="ident">t</span>),
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">e</span>),
};
<span class="ident">drop</span>(<span class="self">self</span>.<span class="ident">tx</span>.<span class="ident">inner</span>.<span class="ident">send</span>(<span class="ident">result</span>));
<span class="prelude-val">Ok</span>(().<span class="ident">into</span>())
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">Future</span> <span class="op">+</span> <span class="ident">fmt</span>::<span class="ident">Debug</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">Execute</span><span class="op"><</span><span class="ident">F</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="ident">f</span>.<span class="ident">debug_struct</span>(<span class="string">"Execute"</span>)
.<span class="ident">field</span>(<span class="string">"future"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">future</span>)
.<span class="ident">finish</span>()
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">Future</span><span class="op">></span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Execute</span><span class="op"><</span><span class="ident">F</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">tx</span>.<span class="ident">inner</span>.<span class="ident">drop_tx</span>();
}
}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "futures";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>