| <!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/git/checkouts/tokio-377c595163f99a10/dfe252d/tokio/src/sync/mpsc/unbounded.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>unbounded.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../../normalize.css"><link rel="stylesheet" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../../ayu.css" disabled><link rel="stylesheet" href="../../../../dark.css" disabled><link rel="stylesheet" href="../../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../../storage.js"></script><script defer src="../../../../source-script.js"></script><script defer src="../../../../source-files.js"></script><script defer src="../../../../main.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../tokio/index.html"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::loom::sync::{atomic::AtomicUsize, Arc}; |
| <span class="kw">use </span><span class="kw">crate</span>::sync::mpsc::chan; |
| <span class="kw">use </span><span class="kw">crate</span>::sync::mpsc::error::{SendError, TryRecvError}; |
| |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::task::{Context, Poll}; |
| |
| <span class="doccomment">/// Send values to the associated `UnboundedReceiver`. |
| /// |
| /// Instances are created by the |
| /// [`unbounded_channel`](unbounded_channel) function. |
| </span><span class="kw">pub struct </span>UnboundedSender<T> { |
| chan: chan::Tx<T, Semaphore>, |
| } |
| |
| <span class="doccomment">/// An unbounded sender that does not prevent the channel from being closed. |
| /// |
| /// If all [`UnboundedSender`] instances of a channel were dropped and only |
| /// `WeakUnboundedSender` instances remain, the channel is closed. |
| /// |
| /// In order to send messages, the `WeakUnboundedSender` needs to be upgraded using |
| /// [`WeakUnboundedSender::upgrade`], which returns `Option<UnboundedSender>`. It returns `None` |
| /// if all `UnboundedSender`s have been dropped, and otherwise it returns an `UnboundedSender`. |
| /// |
| /// [`UnboundedSender`]: UnboundedSender |
| /// [`WeakUnboundedSender::upgrade`]: WeakUnboundedSender::upgrade |
| /// |
| /// #Examples |
| /// |
| /// ``` |
| /// use tokio::sync::mpsc::unbounded_channel; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, _rx) = unbounded_channel::<i32>(); |
| /// let tx_weak = tx.downgrade(); |
| /// |
| /// // Upgrading will succeed because `tx` still exists. |
| /// assert!(tx_weak.upgrade().is_some()); |
| /// |
| /// // If we drop `tx`, then it will fail. |
| /// drop(tx); |
| /// assert!(tx_weak.clone().upgrade().is_none()); |
| /// } |
| /// ``` |
| </span><span class="kw">pub struct </span>WeakUnboundedSender<T> { |
| chan: Arc<chan::Chan<T, Semaphore>>, |
| } |
| |
| <span class="kw">impl</span><T> Clone <span class="kw">for </span>UnboundedSender<T> { |
| <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| UnboundedSender { |
| chan: <span class="self">self</span>.chan.clone(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> fmt::Debug <span class="kw">for </span>UnboundedSender<T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| fmt.debug_struct(<span class="string">"UnboundedSender"</span>) |
| .field(<span class="string">"chan"</span>, <span class="kw-2">&</span><span class="self">self</span>.chan) |
| .finish() |
| } |
| } |
| |
| <span class="doccomment">/// Receive values from the associated `UnboundedSender`. |
| /// |
| /// Instances are created by the |
| /// [`unbounded_channel`](unbounded_channel) function. |
| /// |
| /// This receiver can be turned into a `Stream` using [`UnboundedReceiverStream`]. |
| /// |
| /// [`UnboundedReceiverStream`]: https://docs.rs/tokio-stream/0.1/tokio_stream/wrappers/struct.UnboundedReceiverStream.html |
| </span><span class="kw">pub struct </span>UnboundedReceiver<T> { |
| <span class="doccomment">/// The channel receiver |
| </span>chan: chan::Rx<T, Semaphore>, |
| } |
| |
| <span class="kw">impl</span><T> fmt::Debug <span class="kw">for </span>UnboundedReceiver<T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| fmt.debug_struct(<span class="string">"UnboundedReceiver"</span>) |
| .field(<span class="string">"chan"</span>, <span class="kw-2">&</span><span class="self">self</span>.chan) |
| .finish() |
| } |
| } |
| |
| <span class="doccomment">/// Creates an unbounded mpsc channel for communicating between asynchronous |
| /// tasks without backpressure. |
| /// |
| /// A `send` on this channel will always succeed as long as the receive half has |
| /// not been closed. If the receiver falls behind, messages will be arbitrarily |
| /// buffered. |
| /// |
| /// **Note** that the amount of available system memory is an implicit bound to |
| /// the channel. Using an `unbounded` channel has the ability of causing the |
| /// process to run out of memory. In this case, the process will be aborted. |
| </span><span class="kw">pub fn </span>unbounded_channel<T>() -> (UnboundedSender<T>, UnboundedReceiver<T>) { |
| <span class="kw">let </span>(tx, rx) = chan::channel(Semaphore(AtomicUsize::new(<span class="number">0</span>))); |
| |
| <span class="kw">let </span>tx = UnboundedSender::new(tx); |
| <span class="kw">let </span>rx = UnboundedReceiver::new(rx); |
| |
| (tx, rx) |
| } |
| |
| <span class="doccomment">/// No capacity |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Semaphore(<span class="kw">pub</span>(<span class="kw">crate</span>) AtomicUsize); |
| |
| <span class="kw">impl</span><T> UnboundedReceiver<T> { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(chan: chan::Rx<T, Semaphore>) -> UnboundedReceiver<T> { |
| UnboundedReceiver { chan } |
| } |
| |
| <span class="doccomment">/// Receives the next value for this receiver. |
| /// |
| /// This method returns `None` if the channel has been closed and there are |
| /// no remaining messages in the channel's buffer. This indicates that no |
| /// further values can ever be received from this `Receiver`. The channel is |
| /// closed when all senders have been dropped, or when [`close`] is called. |
| /// |
| /// If there are no messages in the channel's buffer, but the channel has |
| /// not yet been closed, this method will sleep until a message is sent or |
| /// the channel is closed. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. If `recv` is used as the event in a |
| /// [`tokio::select!`](crate::select) statement and some other branch |
| /// completes first, it is guaranteed that no messages were received on this |
| /// channel. |
| /// |
| /// [`close`]: Self::close |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::mpsc; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx) = mpsc::unbounded_channel(); |
| /// |
| /// tokio::spawn(async move { |
| /// tx.send("hello").unwrap(); |
| /// }); |
| /// |
| /// assert_eq!(Some("hello"), rx.recv().await); |
| /// assert_eq!(None, rx.recv().await); |
| /// } |
| /// ``` |
| /// |
| /// Values are buffered: |
| /// |
| /// ``` |
| /// use tokio::sync::mpsc; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx) = mpsc::unbounded_channel(); |
| /// |
| /// tx.send("hello").unwrap(); |
| /// tx.send("world").unwrap(); |
| /// |
| /// assert_eq!(Some("hello"), rx.recv().await); |
| /// assert_eq!(Some("world"), rx.recv().await); |
| /// } |
| /// ``` |
| </span><span class="kw">pub async fn </span>recv(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><T> { |
| <span class="kw">use </span><span class="kw">crate</span>::future::poll_fn; |
| |
| poll_fn(|cx| <span class="self">self</span>.poll_recv(cx)).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Tries to receive the next value for this receiver. |
| /// |
| /// This method returns the [`Empty`] error if the channel is currently |
| /// empty, but there are still outstanding [senders] or [permits]. |
| /// |
| /// This method returns the [`Disconnected`] error if the channel is |
| /// currently empty, and there are no outstanding [senders] or [permits]. |
| /// |
| /// Unlike the [`poll_recv`] method, this method will never return an |
| /// [`Empty`] error spuriously. |
| /// |
| /// [`Empty`]: crate::sync::mpsc::error::TryRecvError::Empty |
| /// [`Disconnected`]: crate::sync::mpsc::error::TryRecvError::Disconnected |
| /// [`poll_recv`]: Self::poll_recv |
| /// [senders]: crate::sync::mpsc::Sender |
| /// [permits]: crate::sync::mpsc::Permit |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::mpsc; |
| /// use tokio::sync::mpsc::error::TryRecvError; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx) = mpsc::unbounded_channel(); |
| /// |
| /// tx.send("hello").unwrap(); |
| /// |
| /// assert_eq!(Ok("hello"), rx.try_recv()); |
| /// assert_eq!(Err(TryRecvError::Empty), rx.try_recv()); |
| /// |
| /// tx.send("hello").unwrap(); |
| /// // Drop the last sender, closing the channel. |
| /// drop(tx); |
| /// |
| /// assert_eq!(Ok("hello"), rx.try_recv()); |
| /// assert_eq!(Err(TryRecvError::Disconnected), rx.try_recv()); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>try_recv(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><T, TryRecvError> { |
| <span class="self">self</span>.chan.try_recv() |
| } |
| |
| <span class="doccomment">/// Blocking receive to call outside of asynchronous contexts. |
| /// |
| /// # Panics |
| /// |
| /// This function panics if called within an asynchronous execution |
| /// context. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use std::thread; |
| /// use tokio::sync::mpsc; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx) = mpsc::unbounded_channel::<u8>(); |
| /// |
| /// let sync_code = thread::spawn(move || { |
| /// assert_eq!(Some(10), rx.blocking_recv()); |
| /// }); |
| /// |
| /// let _ = tx.send(10); |
| /// sync_code.join().unwrap(); |
| /// } |
| /// ``` |
| </span><span class="attribute">#[track_caller] |
| #[cfg(feature = <span class="string">"sync"</span>)] |
| </span><span class="kw">pub fn </span>blocking_recv(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><T> { |
| <span class="kw">crate</span>::future::block_on(<span class="self">self</span>.recv()) |
| } |
| |
| <span class="doccomment">/// Closes the receiving half of a channel, without dropping it. |
| /// |
| /// This prevents any further messages from being sent on the channel while |
| /// still enabling the receiver to drain messages that are buffered. |
| /// |
| /// To guarantee that no messages are dropped, after calling `close()`, |
| /// `recv()` must be called until `None` is returned. |
| </span><span class="kw">pub fn </span>close(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.chan.close(); |
| } |
| |
| <span class="doccomment">/// Polls to receive the next message on this channel. |
| /// |
| /// This method returns: |
| /// |
| /// * `Poll::Pending` if no messages are available but the channel is not |
| /// closed, or if a spurious failure happens. |
| /// * `Poll::Ready(Some(message))` if a message is available. |
| /// * `Poll::Ready(None)` if the channel has been closed and all messages |
| /// sent before it was closed have been received. |
| /// |
| /// When the method returns `Poll::Pending`, the `Waker` in the provided |
| /// `Context` is scheduled to receive a wakeup when a message is sent on any |
| /// receiver, or when the channel is closed. Note that on multiple calls to |
| /// `poll_recv`, only the `Waker` from the `Context` passed to the most |
| /// recent call is scheduled to receive a wakeup. |
| /// |
| /// If this method returns `Poll::Pending` due to a spurious failure, then |
| /// the `Waker` will be notified when the situation causing the spurious |
| /// failure has been resolved. Note that receiving such a wakeup does not |
| /// guarantee that the next call will succeed — it could fail with another |
| /// spurious failure. |
| </span><span class="kw">pub fn </span>poll_recv(<span class="kw-2">&mut </span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Option</span><T>> { |
| <span class="self">self</span>.chan.recv(cx) |
| } |
| } |
| |
| <span class="kw">impl</span><T> UnboundedSender<T> { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(chan: chan::Tx<T, Semaphore>) -> UnboundedSender<T> { |
| UnboundedSender { chan } |
| } |
| |
| <span class="doccomment">/// Attempts to send a message on this `UnboundedSender` without blocking. |
| /// |
| /// This method is not marked async because sending a message to an unbounded channel |
| /// never requires any form of waiting. Because of this, the `send` method can be |
| /// used in both synchronous and asynchronous code without problems. |
| /// |
| /// If the receive half of the channel is closed, either due to [`close`] |
| /// being called or the [`UnboundedReceiver`] having been dropped, this |
| /// function returns an error. The error includes the value passed to `send`. |
| /// |
| /// [`close`]: UnboundedReceiver::close |
| /// [`UnboundedReceiver`]: UnboundedReceiver |
| </span><span class="kw">pub fn </span>send(<span class="kw-2">&</span><span class="self">self</span>, message: T) -> <span class="prelude-ty">Result</span><(), SendError<T>> { |
| <span class="kw">if </span>!<span class="self">self</span>.inc_num_messages() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(SendError(message)); |
| } |
| |
| <span class="self">self</span>.chan.send(message); |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="kw">fn </span>inc_num_messages(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="kw">use </span>std::process; |
| <span class="kw">use </span>std::sync::atomic::Ordering::{AcqRel, Acquire}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>curr = <span class="self">self</span>.chan.semaphore().<span class="number">0</span>.load(Acquire); |
| |
| <span class="kw">loop </span>{ |
| <span class="kw">if </span>curr & <span class="number">1 </span>== <span class="number">1 </span>{ |
| <span class="kw">return </span><span class="bool-val">false</span>; |
| } |
| |
| <span class="kw">if </span>curr == usize::MAX ^ <span class="number">1 </span>{ |
| <span class="comment">// Overflowed the ref count. There is no safe way to recover, so |
| // abort the process. In practice, this should never happen. |
| </span>process::abort() |
| } |
| |
| <span class="kw">match </span><span class="self">self |
| </span>.chan |
| .semaphore() |
| .<span class="number">0 |
| </span>.compare_exchange(curr, curr + <span class="number">2</span>, AcqRel, Acquire) |
| { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => <span class="kw">return </span><span class="bool-val">true</span>, |
| <span class="prelude-val">Err</span>(actual) => { |
| curr = actual; |
| } |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Completes when the receiver has dropped. |
| /// |
| /// This allows the producers to get notified when interest in the produced |
| /// values is canceled and immediately stop doing work. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. Once the channel is closed, it stays closed |
| /// forever and all future calls to `closed` will return immediately. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::mpsc; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx1, rx) = mpsc::unbounded_channel::<()>(); |
| /// let tx2 = tx1.clone(); |
| /// let tx3 = tx1.clone(); |
| /// let tx4 = tx1.clone(); |
| /// let tx5 = tx1.clone(); |
| /// tokio::spawn(async move { |
| /// drop(rx); |
| /// }); |
| /// |
| /// futures::join!( |
| /// tx1.closed(), |
| /// tx2.closed(), |
| /// tx3.closed(), |
| /// tx4.closed(), |
| /// tx5.closed() |
| /// ); |
| </span><span class="comment">//// println!("Receiver dropped"); |
| </span><span class="doccomment">/// } |
| /// ``` |
| </span><span class="kw">pub async fn </span>closed(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="self">self</span>.chan.closed().<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Checks if the channel has been closed. This happens when the |
| /// [`UnboundedReceiver`] is dropped, or when the |
| /// [`UnboundedReceiver::close`] method is called. |
| /// |
| /// [`UnboundedReceiver`]: crate::sync::mpsc::UnboundedReceiver |
| /// [`UnboundedReceiver::close`]: crate::sync::mpsc::UnboundedReceiver::close |
| /// |
| /// ``` |
| /// let (tx, rx) = tokio::sync::mpsc::unbounded_channel::<()>(); |
| /// assert!(!tx.is_closed()); |
| /// |
| /// let tx2 = tx.clone(); |
| /// assert!(!tx2.is_closed()); |
| /// |
| /// drop(rx); |
| /// assert!(tx.is_closed()); |
| /// assert!(tx2.is_closed()); |
| /// ``` |
| </span><span class="kw">pub fn </span>is_closed(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.chan.is_closed() |
| } |
| |
| <span class="doccomment">/// Returns `true` if senders belong to the same channel. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// let (tx, rx) = tokio::sync::mpsc::unbounded_channel::<()>(); |
| /// let tx2 = tx.clone(); |
| /// assert!(tx.same_channel(&tx2)); |
| /// |
| /// let (tx3, rx3) = tokio::sync::mpsc::unbounded_channel::<()>(); |
| /// assert!(!tx3.same_channel(&tx2)); |
| /// ``` |
| </span><span class="kw">pub fn </span>same_channel(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> bool { |
| <span class="self">self</span>.chan.same_channel(<span class="kw-2">&</span>other.chan) |
| } |
| |
| <span class="doccomment">/// Converts the `UnboundedSender` to a [`WeakUnboundedSender`] that does not count |
| /// towards RAII semantics, i.e. if all `UnboundedSender` instances of the |
| /// channel were dropped and only `WeakUnboundedSender` instances remain, |
| /// the channel is closed. |
| </span><span class="kw">pub fn </span>downgrade(<span class="kw-2">&</span><span class="self">self</span>) -> WeakUnboundedSender<T> { |
| WeakUnboundedSender { |
| chan: <span class="self">self</span>.chan.downgrade(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> Clone <span class="kw">for </span>WeakUnboundedSender<T> { |
| <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| WeakUnboundedSender { |
| chan: <span class="self">self</span>.chan.clone(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> WeakUnboundedSender<T> { |
| <span class="doccomment">/// Tries to convert a WeakUnboundedSender into an [`UnboundedSender`]. |
| /// This will return `Some` if there are other `Sender` instances alive and |
| /// the channel wasn't previously dropped, otherwise `None` is returned. |
| </span><span class="kw">pub fn </span>upgrade(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><UnboundedSender<T>> { |
| chan::Tx::upgrade(<span class="self">self</span>.chan.clone()).map(UnboundedSender::new) |
| } |
| } |
| |
| <span class="kw">impl</span><T> fmt::Debug <span class="kw">for </span>WeakUnboundedSender<T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| fmt.debug_struct(<span class="string">"WeakUnboundedSender"</span>).finish() |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |