| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-channel-0.5.8/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../crossbeam_channel/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="../../crossbeam_channel/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> |
| </pre><pre class="rust"><code><span class="doccomment">//! Multi-producer multi-consumer channels for message passing. |
| //! |
| //! This crate is an alternative to [`std::sync::mpsc`] with more features and better performance. |
| //! |
| //! # Hello, world! |
| //! |
| //! ``` |
| //! use crossbeam_channel::unbounded; |
| //! |
| //! // Create a channel of unbounded capacity. |
| //! let (s, r) = unbounded(); |
| //! |
| //! // Send a message into the channel. |
| //! s.send("Hello, world!").unwrap(); |
| //! |
| //! // Receive the message from the channel. |
| //! assert_eq!(r.recv(), Ok("Hello, world!")); |
| //! ``` |
| //! |
| //! # Channel types |
| //! |
| //! Channels can be created using two functions: |
| //! |
| //! * [`bounded`] creates a channel of bounded capacity, i.e. there is a limit to how many messages |
| //! it can hold at a time. |
| //! |
| //! * [`unbounded`] creates a channel of unbounded capacity, i.e. it can hold any number of |
| //! messages at a time. |
| //! |
| //! Both functions return a [`Sender`] and a [`Receiver`], which represent the two opposite sides |
| //! of a channel. |
| //! |
| //! Creating a bounded channel: |
| //! |
| //! ``` |
| //! use crossbeam_channel::bounded; |
| //! |
| //! // Create a channel that can hold at most 5 messages at a time. |
| //! let (s, r) = bounded(5); |
| //! |
| //! // Can send only 5 messages without blocking. |
| //! for i in 0..5 { |
| //! s.send(i).unwrap(); |
| //! } |
| //! |
| //! // Another call to `send` would block because the channel is full. |
| //! // s.send(5).unwrap(); |
| //! ``` |
| //! |
| //! Creating an unbounded channel: |
| //! |
| //! ``` |
| //! use crossbeam_channel::unbounded; |
| //! |
| //! // Create an unbounded channel. |
| //! let (s, r) = unbounded(); |
| //! |
| //! // Can send any number of messages into the channel without blocking. |
| //! for i in 0..1000 { |
| //! s.send(i).unwrap(); |
| //! } |
| //! ``` |
| //! |
| //! A special case is zero-capacity channel, which cannot hold any messages. Instead, send and |
| //! receive operations must appear at the same time in order to pair up and pass the message over: |
| //! |
| //! ``` |
| //! use std::thread; |
| //! use crossbeam_channel::bounded; |
| //! |
| //! // Create a zero-capacity channel. |
| //! let (s, r) = bounded(0); |
| //! |
| //! // Sending blocks until a receive operation appears on the other side. |
| //! thread::spawn(move || s.send("Hi!").unwrap()); |
| //! |
| //! // Receiving blocks until a send operation appears on the other side. |
| //! assert_eq!(r.recv(), Ok("Hi!")); |
| //! ``` |
| //! |
| //! # Sharing channels |
| //! |
| //! Senders and receivers can be cloned and sent to other threads: |
| //! |
| //! ``` |
| //! use std::thread; |
| //! use crossbeam_channel::bounded; |
| //! |
| //! let (s1, r1) = bounded(0); |
| //! let (s2, r2) = (s1.clone(), r1.clone()); |
| //! |
| //! // Spawn a thread that receives a message and then sends one. |
| //! thread::spawn(move || { |
| //! r2.recv().unwrap(); |
| //! s2.send(2).unwrap(); |
| //! }); |
| //! |
| //! // Send a message and then receive one. |
| //! s1.send(1).unwrap(); |
| //! r1.recv().unwrap(); |
| //! ``` |
| //! |
| //! Note that cloning only creates a new handle to the same sending or receiving side. It does not |
| //! create a separate stream of messages in any way: |
| //! |
| //! ``` |
| //! use crossbeam_channel::unbounded; |
| //! |
| //! let (s1, r1) = unbounded(); |
| //! let (s2, r2) = (s1.clone(), r1.clone()); |
| //! let (s3, r3) = (s2.clone(), r2.clone()); |
| //! |
| //! s1.send(10).unwrap(); |
| //! s2.send(20).unwrap(); |
| //! s3.send(30).unwrap(); |
| //! |
| //! assert_eq!(r3.recv(), Ok(10)); |
| //! assert_eq!(r1.recv(), Ok(20)); |
| //! assert_eq!(r2.recv(), Ok(30)); |
| //! ``` |
| //! |
| //! It's also possible to share senders and receivers by reference: |
| //! |
| //! ``` |
| //! use crossbeam_channel::bounded; |
| //! use crossbeam_utils::thread::scope; |
| //! |
| //! let (s, r) = bounded(0); |
| //! |
| //! scope(|scope| { |
| //! // Spawn a thread that receives a message and then sends one. |
| //! scope.spawn(|_| { |
| //! r.recv().unwrap(); |
| //! s.send(2).unwrap(); |
| //! }); |
| //! |
| //! // Send a message and then receive one. |
| //! s.send(1).unwrap(); |
| //! r.recv().unwrap(); |
| //! }).unwrap(); |
| //! ``` |
| //! |
| //! # Disconnection |
| //! |
| //! When all senders or all receivers associated with a channel get dropped, the channel becomes |
| //! disconnected. No more messages can be sent, but any remaining messages can still be received. |
| //! Send and receive operations on a disconnected channel never block. |
| //! |
| //! ``` |
| //! use crossbeam_channel::{unbounded, RecvError}; |
| //! |
| //! let (s, r) = unbounded(); |
| //! s.send(1).unwrap(); |
| //! s.send(2).unwrap(); |
| //! s.send(3).unwrap(); |
| //! |
| //! // The only sender is dropped, disconnecting the channel. |
| //! drop(s); |
| //! |
| //! // The remaining messages can be received. |
| //! assert_eq!(r.recv(), Ok(1)); |
| //! assert_eq!(r.recv(), Ok(2)); |
| //! assert_eq!(r.recv(), Ok(3)); |
| //! |
| //! // There are no more messages in the channel. |
| //! assert!(r.is_empty()); |
| //! |
| //! // Note that calling `r.recv()` does not block. |
| //! // Instead, `Err(RecvError)` is returned immediately. |
| //! assert_eq!(r.recv(), Err(RecvError)); |
| //! ``` |
| //! |
| //! # Blocking operations |
| //! |
| //! Send and receive operations come in three flavors: |
| //! |
| //! * Non-blocking (returns immediately with success or failure). |
| //! * Blocking (waits until the operation succeeds or the channel becomes disconnected). |
| //! * Blocking with a timeout (blocks only for a certain duration of time). |
| //! |
| //! A simple example showing the difference between non-blocking and blocking operations: |
| //! |
| //! ``` |
| //! use crossbeam_channel::{bounded, RecvError, TryRecvError}; |
| //! |
| //! let (s, r) = bounded(1); |
| //! |
| //! // Send a message into the channel. |
| //! s.send("foo").unwrap(); |
| //! |
| //! // This call would block because the channel is full. |
| //! // s.send("bar").unwrap(); |
| //! |
| //! // Receive the message. |
| //! assert_eq!(r.recv(), Ok("foo")); |
| //! |
| //! // This call would block because the channel is empty. |
| //! // r.recv(); |
| //! |
| //! // Try receiving a message without blocking. |
| //! assert_eq!(r.try_recv(), Err(TryRecvError::Empty)); |
| //! |
| //! // Disconnect the channel. |
| //! drop(s); |
| //! |
| //! // This call doesn't block because the channel is now disconnected. |
| //! assert_eq!(r.recv(), Err(RecvError)); |
| //! ``` |
| //! |
| //! # Iteration |
| //! |
| //! Receivers can be used as iterators. For example, method [`iter`] creates an iterator that |
| //! receives messages until the channel becomes empty and disconnected. Note that iteration may |
| //! block waiting for next message to arrive. |
| //! |
| //! ``` |
| //! use std::thread; |
| //! use crossbeam_channel::unbounded; |
| //! |
| //! let (s, r) = unbounded(); |
| //! |
| //! thread::spawn(move || { |
| //! s.send(1).unwrap(); |
| //! s.send(2).unwrap(); |
| //! s.send(3).unwrap(); |
| //! drop(s); // Disconnect the channel. |
| //! }); |
| //! |
| //! // Collect all messages from the channel. |
| //! // Note that the call to `collect` blocks until the sender is dropped. |
| //! let v: Vec<_> = r.iter().collect(); |
| //! |
| //! assert_eq!(v, [1, 2, 3]); |
| //! ``` |
| //! |
| //! A non-blocking iterator can be created using [`try_iter`], which receives all available |
| //! messages without blocking: |
| //! |
| //! ``` |
| //! use crossbeam_channel::unbounded; |
| //! |
| //! let (s, r) = unbounded(); |
| //! s.send(1).unwrap(); |
| //! s.send(2).unwrap(); |
| //! s.send(3).unwrap(); |
| //! // No need to drop the sender. |
| //! |
| //! // Receive all messages currently in the channel. |
| //! let v: Vec<_> = r.try_iter().collect(); |
| //! |
| //! assert_eq!(v, [1, 2, 3]); |
| //! ``` |
| //! |
| //! # Selection |
| //! |
| //! The [`select!`] macro allows you to define a set of channel operations, wait until any one of |
| //! them becomes ready, and finally execute it. If multiple operations are ready at the same time, |
| //! a random one among them is selected. |
| //! |
| //! It is also possible to define a `default` case that gets executed if none of the operations are |
| //! ready, either right away or for a certain duration of time. |
| //! |
| //! An operation is considered to be ready if it doesn't have to block. Note that it is ready even |
| //! when it will simply return an error because the channel is disconnected. |
| //! |
| //! An example of receiving a message from two channels: |
| //! |
| //! ``` |
| //! use std::thread; |
| //! use std::time::Duration; |
| //! use crossbeam_channel::{select, unbounded}; |
| //! |
| //! let (s1, r1) = unbounded(); |
| //! let (s2, r2) = unbounded(); |
| //! |
| //! thread::spawn(move || s1.send(10).unwrap()); |
| //! thread::spawn(move || s2.send(20).unwrap()); |
| //! |
| //! // At most one of these two receive operations will be executed. |
| //! select! { |
| //! recv(r1) -> msg => assert_eq!(msg, Ok(10)), |
| //! recv(r2) -> msg => assert_eq!(msg, Ok(20)), |
| //! default(Duration::from_secs(1)) => println!("timed out"), |
| //! } |
| //! ``` |
| //! |
| //! If you need to select over a dynamically created list of channel operations, use [`Select`] |
| //! instead. The [`select!`] macro is just a convenience wrapper around [`Select`]. |
| //! |
| //! # Extra channels |
| //! |
| //! Three functions can create special kinds of channels, all of which return just a [`Receiver`] |
| //! handle: |
| //! |
| //! * [`after`] creates a channel that delivers a single message after a certain duration of time. |
| //! * [`tick`] creates a channel that delivers messages periodically. |
| //! * [`never`](never()) creates a channel that never delivers messages. |
| //! |
| //! These channels are very efficient because messages get lazily generated on receive operations. |
| //! |
| //! An example that prints elapsed time every 50 milliseconds for the duration of 1 second: |
| //! |
| //! ``` |
| //! use std::time::{Duration, Instant}; |
| //! use crossbeam_channel::{after, select, tick}; |
| //! |
| //! let start = Instant::now(); |
| //! let ticker = tick(Duration::from_millis(50)); |
| //! let timeout = after(Duration::from_secs(1)); |
| //! |
| //! loop { |
| //! select! { |
| //! recv(ticker) -> _ => println!("elapsed: {:?}", start.elapsed()), |
| //! recv(timeout) -> _ => break, |
| //! } |
| //! } |
| //! ``` |
| //! |
| //! [`send`]: Sender::send |
| //! [`recv`]: Receiver::recv |
| //! [`iter`]: Receiver::iter |
| //! [`try_iter`]: Receiver::try_iter |
| |
| </span><span class="attribute">#![doc(test( |
| no_crate_inject, |
| attr( |
| deny(warnings, rust_2018_idioms), |
| allow(dead_code, unused_assignments, unused_variables) |
| ) |
| ))] |
| #![warn( |
| missing_docs, |
| missing_debug_implementations, |
| rust_2018_idioms, |
| unreachable_pub |
| )] |
| #![cfg_attr(not(feature = <span class="string">"std"</span>), no_std)] |
| |
| </span><span class="kw">use </span>cfg_if::cfg_if; |
| |
| <span class="macro">cfg_if! </span>{ |
| <span class="kw">if </span><span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] </span>{ |
| <span class="kw">mod </span>channel; |
| <span class="kw">mod </span>context; |
| <span class="kw">mod </span>counter; |
| <span class="kw">mod </span>err; |
| <span class="kw">mod </span>flavors; |
| <span class="kw">mod </span>select; |
| <span class="kw">mod </span>select_macro; |
| <span class="kw">mod </span>utils; |
| <span class="kw">mod </span>waker; |
| |
| <span class="doccomment">/// Crate internals used by the `select!` macro. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub mod </span>internal { |
| <span class="kw">pub use </span><span class="kw">crate</span>::select::SelectHandle; |
| <span class="kw">pub use </span><span class="kw">crate</span>::select::{select, select_timeout, try_select}; |
| } |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::channel::{after, at, never, tick}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::channel::{bounded, unbounded}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::channel::{IntoIter, Iter, TryIter}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::channel::{Receiver, Sender}; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::select::{Select, SelectedOperation}; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::err::{ReadyTimeoutError, SelectTimeoutError, TryReadyError, TrySelectError}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::err::{RecvError, RecvTimeoutError, TryRecvError}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::err::{SendError, SendTimeoutError, TrySendError}; |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="crossbeam_channel" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |