| <!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 `src/reactor/poll_evented.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>poll_evented.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> |
| </pre><pre class="rust "> |
| <span class="doccomment">//! Readiness tracking streams, backing I/O objects.</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! This module contains the core type which is used to back all I/O on object</span> |
| <span class="doccomment">//! in `tokio-core`. The `PollEvented` type is the implementation detail of</span> |
| <span class="doccomment">//! all I/O. Each `PollEvented` manages registration with a reactor,</span> |
| <span class="doccomment">//! acquisition of a token, and tracking of the readiness state on the</span> |
| <span class="doccomment">//! underlying I/O primitive.</span> |
| |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::{<span class="self">self</span>, <span class="ident">Read</span>, <span class="ident">Write</span>}; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicUsize</span>, <span class="ident">Ordering</span>}; |
| |
| <span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Async</span>, <span class="ident">Poll</span>}; |
| <span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">event</span>::<span class="ident">Evented</span>; |
| <span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>; |
| <span class="kw">use</span> <span class="ident">tokio_io</span>::{<span class="ident">AsyncRead</span>, <span class="ident">AsyncWrite</span>}; |
| |
| <span class="kw">use</span> <span class="ident">reactor</span>::{<span class="ident">Handle</span>, <span class="ident">Remote</span>}; |
| <span class="kw">use</span> <span class="ident">reactor</span>::<span class="ident">io_token</span>::<span class="ident">IoToken</span>; |
| |
| <span class="doccomment">/// A concrete implementation of a stream of readiness notifications for I/O</span> |
| <span class="doccomment">/// objects that originates from an event loop.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Created by the `PollEvented::new` method, each `PollEvented` is</span> |
| <span class="doccomment">/// associated with a specific event loop and source of events that will be</span> |
| <span class="doccomment">/// registered with an event loop.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// An instance of `PollEvented` is essentially the bridge between the `mio`</span> |
| <span class="doccomment">/// world and the `tokio-core` world, providing abstractions to receive</span> |
| <span class="doccomment">/// notifications about changes to an object's `mio::Ready` state.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Each readiness stream has a number of methods to test whether the underlying</span> |
| <span class="doccomment">/// object is readable or writable. Once the methods return that an object is</span> |
| <span class="doccomment">/// readable/writable, then it will continue to do so until the `need_read` or</span> |
| <span class="doccomment">/// `need_write` methods are called.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// That is, this object is typically wrapped in another form of I/O object.</span> |
| <span class="doccomment">/// It's the responsibility of the wrapper to inform the readiness stream when a</span> |
| <span class="doccomment">/// "would block" I/O event is seen. The readiness stream will then take care of</span> |
| <span class="doccomment">/// any scheduling necessary to get notified when the event is ready again.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// You can find more information about creating a custom I/O object [online].</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [online]: https://tokio.rs/docs/going-deeper-tokio/core-low-level/#custom-io</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// ## Readiness to read/write</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// A `PollEvented` allows listening and waiting for an arbitrary `mio::Ready`</span> |
| <span class="doccomment">/// instance, including the platform-specific contents of `mio::Ready`. At most</span> |
| <span class="doccomment">/// two future tasks, however, can be waiting on a `PollEvented`. The</span> |
| <span class="doccomment">/// `need_read` and `need_write` methods can block two separate tasks, one on</span> |
| <span class="doccomment">/// reading and one on writing. Not all I/O events correspond to read/write,</span> |
| <span class="doccomment">/// however!</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// To account for this a `PollEvented` gets a little interesting when working</span> |
| <span class="doccomment">/// with an arbitrary instance of `mio::Ready` that may not map precisely to</span> |
| <span class="doccomment">/// "write" and "read" tasks. Currently it is defined that instances of</span> |
| <span class="doccomment">/// `mio::Ready` that do *not* return true from `is_writable` are all notified</span> |
| <span class="doccomment">/// through `need_read`, or the read task.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// In other words, `poll_ready` with the `mio::UnixReady::hup` event will block</span> |
| <span class="doccomment">/// the read task of this `PollEvented` if the `hup` event isn't available.</span> |
| <span class="doccomment">/// Essentially a good rule of thumb is that if you're using the `poll_ready`</span> |
| <span class="doccomment">/// method you want to also use `need_read` to signal blocking and you should</span> |
| <span class="doccomment">/// otherwise probably avoid using two tasks on the same `PollEvented`.</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> { |
| <span class="ident">token</span>: <span class="ident">IoToken</span>, |
| <span class="ident">handle</span>: <span class="ident">Remote</span>, |
| <span class="ident">readiness</span>: <span class="ident">AtomicUsize</span>, |
| <span class="ident">io</span>: <span class="ident">E</span>, |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">E</span>: <span class="ident">Evented</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">PollEvented</span><span class="op"><</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">"PollEvented"</span>) |
| .<span class="ident">field</span>(<span class="string">"io"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">io</span>) |
| .<span class="ident">finish</span>() |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">E</span>: <span class="ident">Evented</span><span class="op">></span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> { |
| <span class="doccomment">/// Creates a new readiness stream associated with the provided</span> |
| <span class="doccomment">/// `loop_handle` and for the given `source`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method returns a future which will resolve to the readiness stream</span> |
| <span class="doccomment">/// when it's ready.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">io</span>: <span class="ident">E</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Handle</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">>></span> { |
| <span class="prelude-val">Ok</span>(<span class="ident">PollEvented</span> { |
| <span class="ident">token</span>: <span class="macro">try</span><span class="macro">!</span>(<span class="ident">IoToken</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="ident">io</span>, <span class="ident">handle</span>)), |
| <span class="ident">handle</span>: <span class="ident">handle</span>.<span class="ident">remote</span>().<span class="ident">clone</span>(), |
| <span class="ident">readiness</span>: <span class="ident">AtomicUsize</span>::<span class="ident">new</span>(<span class="number">0</span>), |
| <span class="ident">io</span>: <span class="ident">io</span>, |
| }) |
| } |
| |
| <span class="doccomment">/// Deregisters this source of events from the reactor core specified.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method can optionally be called to unregister the underlying I/O</span> |
| <span class="doccomment">/// object with the event loop that the `handle` provided points to.</span> |
| <span class="doccomment">/// Typically this method is not required as this automatically happens when</span> |
| <span class="doccomment">/// `E` is dropped, but for some use cases the `E` object doesn't represent</span> |
| <span class="doccomment">/// an owned reference, so dropping it won't automatically unregister with</span> |
| <span class="doccomment">/// the event loop.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This consumes `self` as it will no longer provide events after the</span> |
| <span class="doccomment">/// method is called, and will likely return an error if this `PollEvented`</span> |
| <span class="doccomment">/// was created on a separate event loop from the `handle` specified.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">deregister</span>(<span class="self">self</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Handle</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="kw">let</span> <span class="ident">inner</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">handle</span>.<span class="ident">inner</span>.<span class="ident">upgrade</span>() { |
| <span class="prelude-val">Some</span>(<span class="ident">inner</span>) <span class="op">=></span> <span class="ident">inner</span>, |
| <span class="prelude-val">None</span> <span class="op">=></span> <span class="kw">return</span> <span class="prelude-val">Ok</span>(()), |
| }; |
| <span class="kw">let</span> <span class="ident">ret</span> <span class="op">=</span> <span class="ident">inner</span>.<span class="ident">borrow_mut</span>().<span class="ident">deregister_source</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">io</span>); |
| <span class="kw">return</span> <span class="ident">ret</span> |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> { |
| <span class="doccomment">/// Tests to see if this source is ready to be read from or not.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If this stream is not ready for a read then `NotReady` will be returned</span> |
| <span class="doccomment">/// and the current task will be scheduled to receive a notification when</span> |
| <span class="doccomment">/// the stream is readable again. In other words, this method is only safe</span> |
| <span class="doccomment">/// to call from within the context of a future's task, typically done in a</span> |
| <span class="doccomment">/// `Future::poll` method.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This is mostly equivalent to `self.poll_ready(Ready::readable())`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will panic if called outside the context of a future's</span> |
| <span class="doccomment">/// task.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">poll_read</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="self">self</span>.<span class="ident">poll_ready</span>(<span class="kw">super</span>::<span class="ident">read_ready</span>()) |
| .<span class="ident">map</span>(<span class="op">|</span>_<span class="op">|</span> ()) |
| } |
| |
| <span class="doccomment">/// Tests to see if this source is ready to be written to or not.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If this stream is not ready for a write then `NotReady` will be returned</span> |
| <span class="doccomment">/// and the current task will be scheduled to receive a notification when</span> |
| <span class="doccomment">/// the stream is writable again. In other words, this method is only safe</span> |
| <span class="doccomment">/// to call from within the context of a future's task, typically done in a</span> |
| <span class="doccomment">/// `Future::poll` method.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This is mostly equivalent to `self.poll_ready(Ready::writable())`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will panic if called outside the context of a future's</span> |
| <span class="doccomment">/// task.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">poll_write</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="self">self</span>.<span class="ident">poll_ready</span>(<span class="ident">Ready</span>::<span class="ident">writable</span>()) |
| .<span class="ident">map</span>(<span class="op">|</span>_<span class="op">|</span> ()) |
| } |
| |
| <span class="doccomment">/// Test to see whether this source fulfills any condition listed in `mask`</span> |
| <span class="doccomment">/// provided.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The `mask` given here is a mio `Ready` set of possible events. This can</span> |
| <span class="doccomment">/// contain any events like read/write but also platform-specific events</span> |
| <span class="doccomment">/// such as hup and error. The `mask` indicates events that are interested</span> |
| <span class="doccomment">/// in being ready.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If any event in `mask` is ready then it is returned through</span> |
| <span class="doccomment">/// `Async::Ready`. The `Ready` set returned is guaranteed to not be empty</span> |
| <span class="doccomment">/// and contains all events that are currently ready in the `mask` provided.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If no events are ready in the `mask` provided then the current task is</span> |
| <span class="doccomment">/// scheduled to receive a notification when any of them become ready. If</span> |
| <span class="doccomment">/// the `writable` event is contained within `mask` then this</span> |
| <span class="doccomment">/// `PollEvented`'s `write` task will be blocked and otherwise the `read`</span> |
| <span class="doccomment">/// task will be blocked. This is generally only relevant if you're working</span> |
| <span class="doccomment">/// with this `PollEvented` object on multiple tasks.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will panic if called outside the context of a future's</span> |
| <span class="doccomment">/// task.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">poll_ready</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">mask</span>: <span class="ident">Ready</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span><span class="ident">Ready</span><span class="op">></span> { |
| <span class="kw">let</span> <span class="ident">bits</span> <span class="op">=</span> <span class="kw">super</span>::<span class="ident">ready2usize</span>(<span class="ident">mask</span>); |
| <span class="kw">match</span> <span class="self">self</span>.<span class="ident">readiness</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>) <span class="op">&</span> <span class="ident">bits</span> { |
| <span class="number">0</span> <span class="op">=></span> {} |
| <span class="ident">n</span> <span class="op">=></span> <span class="kw">return</span> <span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="kw">super</span>::<span class="ident">usize2ready</span>(<span class="ident">n</span>)), |
| } |
| <span class="self">self</span>.<span class="ident">readiness</span>.<span class="ident">fetch_or</span>(<span class="self">self</span>.<span class="ident">token</span>.<span class="ident">take_readiness</span>(), <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>); |
| <span class="kw">match</span> <span class="self">self</span>.<span class="ident">readiness</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>) <span class="op">&</span> <span class="ident">bits</span> { |
| <span class="number">0</span> <span class="op">=></span> { |
| <span class="kw">if</span> <span class="ident">mask</span>.<span class="ident">is_writable</span>() { |
| <span class="self">self</span>.<span class="ident">need_write</span>(); |
| } <span class="kw">else</span> { |
| <span class="self">self</span>.<span class="ident">need_read</span>(); |
| } |
| <span class="ident">Async</span>::<span class="ident">NotReady</span> |
| } |
| <span class="ident">n</span> <span class="op">=></span> <span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="kw">super</span>::<span class="ident">usize2ready</span>(<span class="ident">n</span>)), |
| } |
| } |
| |
| <span class="doccomment">/// Indicates to this source of events that the corresponding I/O object is</span> |
| <span class="doccomment">/// no longer readable, but it needs to be.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function, like `poll_read`, is only safe to call from the context</span> |
| <span class="doccomment">/// of a future's task (typically in a `Future::poll` implementation). It</span> |
| <span class="doccomment">/// informs this readiness stream that the underlying object is no longer</span> |
| <span class="doccomment">/// readable, typically because a "would block" error was seen.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// *All* readiness bits associated with this stream except the writable bit</span> |
| <span class="doccomment">/// will be reset when this method is called. The current task is then</span> |
| <span class="doccomment">/// scheduled to receive a notification whenever anything changes other than</span> |
| <span class="doccomment">/// the writable bit. Note that this typically just means the readable bit</span> |
| <span class="doccomment">/// is used here, but if you're using a custom I/O object for events like</span> |
| <span class="doccomment">/// hup/error this may also be relevant.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Note that it is also only valid to call this method if `poll_read`</span> |
| <span class="doccomment">/// previously indicated that the object is readable. That is, this function</span> |
| <span class="doccomment">/// must always be paired with calls to `poll_read` previously.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will panic if called outside the context of a future's</span> |
| <span class="doccomment">/// task.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">need_read</span>(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">let</span> <span class="ident">bits</span> <span class="op">=</span> <span class="kw">super</span>::<span class="ident">ready2usize</span>(<span class="kw">super</span>::<span class="ident">read_ready</span>()); |
| <span class="self">self</span>.<span class="ident">readiness</span>.<span class="ident">fetch_and</span>(<span class="op">!</span><span class="ident">bits</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>); |
| <span class="self">self</span>.<span class="ident">token</span>.<span class="ident">schedule_read</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">handle</span>) |
| } |
| |
| <span class="doccomment">/// Indicates to this source of events that the corresponding I/O object is</span> |
| <span class="doccomment">/// no longer writable, but it needs to be.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function, like `poll_write`, is only safe to call from the context</span> |
| <span class="doccomment">/// of a future's task (typically in a `Future::poll` implementation). It</span> |
| <span class="doccomment">/// informs this readiness stream that the underlying object is no longer</span> |
| <span class="doccomment">/// writable, typically because a "would block" error was seen.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The flag indicating that this stream is writable is unset and the</span> |
| <span class="doccomment">/// current task is scheduled to receive a notification when the stream is</span> |
| <span class="doccomment">/// then again writable.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Note that it is also only valid to call this method if `poll_write`</span> |
| <span class="doccomment">/// previously indicated that the object is writable. That is, this function</span> |
| <span class="doccomment">/// must always be paired with calls to `poll_write` previously.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will panic if called outside the context of a future's</span> |
| <span class="doccomment">/// task.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">need_write</span>(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">let</span> <span class="ident">bits</span> <span class="op">=</span> <span class="kw">super</span>::<span class="ident">ready2usize</span>(<span class="ident">Ready</span>::<span class="ident">writable</span>()); |
| <span class="self">self</span>.<span class="ident">readiness</span>.<span class="ident">fetch_and</span>(<span class="op">!</span><span class="ident">bits</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>); |
| <span class="self">self</span>.<span class="ident">token</span>.<span class="ident">schedule_write</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">handle</span>) |
| } |
| |
| <span class="doccomment">/// Returns a reference to the event loop handle that this readiness stream</span> |
| <span class="doccomment">/// is associated with.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">remote</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">Remote</span> { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">handle</span> |
| } |
| |
| <span class="doccomment">/// Returns a shared reference to the underlying I/O object this readiness</span> |
| <span class="doccomment">/// stream is wrapping.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">E</span> { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">io</span> |
| } |
| |
| <span class="doccomment">/// Returns a mutable reference to the underlying I/O object this readiness</span> |
| <span class="doccomment">/// stream is wrapping.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">E</span> { |
| <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">io</span> |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">E</span>: <span class="ident">Read</span><span class="op">></span> <span class="ident">Read</span> <span class="kw">for</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> { |
| <span class="kw">fn</span> <span class="ident">read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">u8</span>]) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> { |
| <span class="kw">if</span> <span class="kw">let</span> <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">poll_read</span>() { |
| <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>.<span class="ident">into</span>()) |
| } |
| <span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">get_mut</span>().<span class="ident">read</span>(<span class="ident">buf</span>); |
| <span class="kw">if</span> <span class="ident">is_wouldblock</span>(<span class="kw-2">&</span><span class="ident">r</span>) { |
| <span class="self">self</span>.<span class="ident">need_read</span>(); |
| } |
| <span class="kw">return</span> <span class="ident">r</span> |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">E</span>: <span class="ident">Write</span><span class="op">></span> <span class="ident">Write</span> <span class="kw">for</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> { |
| <span class="kw">fn</span> <span class="ident">write</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> { |
| <span class="kw">if</span> <span class="kw">let</span> <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">poll_write</span>() { |
| <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>.<span class="ident">into</span>()) |
| } |
| <span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">get_mut</span>().<span class="ident">write</span>(<span class="ident">buf</span>); |
| <span class="kw">if</span> <span class="ident">is_wouldblock</span>(<span class="kw-2">&</span><span class="ident">r</span>) { |
| <span class="self">self</span>.<span class="ident">need_write</span>(); |
| } |
| <span class="kw">return</span> <span class="ident">r</span> |
| } |
| |
| <span class="kw">fn</span> <span class="ident">flush</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="kw">if</span> <span class="kw">let</span> <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">poll_write</span>() { |
| <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>.<span class="ident">into</span>()) |
| } |
| <span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">get_mut</span>().<span class="ident">flush</span>(); |
| <span class="kw">if</span> <span class="ident">is_wouldblock</span>(<span class="kw-2">&</span><span class="ident">r</span>) { |
| <span class="self">self</span>.<span class="ident">need_write</span>(); |
| } |
| <span class="kw">return</span> <span class="ident">r</span> |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">E</span>: <span class="ident">Read</span><span class="op">></span> <span class="ident">AsyncRead</span> <span class="kw">for</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> { |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">E</span>: <span class="ident">Write</span><span class="op">></span> <span class="ident">AsyncWrite</span> <span class="kw">for</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> { |
| <span class="kw">fn</span> <span class="ident">shutdown</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">io</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="prelude-val">Ok</span>(().<span class="ident">into</span>()) |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">allow</span>(<span class="ident">deprecated</span>)]</span> |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">E</span>: <span class="ident">Read</span> <span class="op">+</span> <span class="ident">Write</span><span class="op">></span> ::<span class="ident">io</span>::<span class="ident">Io</span> <span class="kw">for</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> { |
| <span class="kw">fn</span> <span class="ident">poll_read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="op"><</span><span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">>></span>::<span class="ident">poll_read</span>(<span class="self">self</span>) |
| } |
| |
| <span class="kw">fn</span> <span class="ident">poll_write</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="op"><</span><span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">>></span>::<span class="ident">poll_write</span>(<span class="self">self</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">E</span><span class="op">></span> <span class="ident">Read</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> |
| <span class="kw">where</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">E</span>: <span class="ident">Read</span>, |
| { |
| <span class="kw">fn</span> <span class="ident">read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">u8</span>]) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> { |
| <span class="kw">if</span> <span class="kw">let</span> <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">poll_read</span>() { |
| <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>.<span class="ident">into</span>()) |
| } |
| <span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">get_ref</span>().<span class="ident">read</span>(<span class="ident">buf</span>); |
| <span class="kw">if</span> <span class="ident">is_wouldblock</span>(<span class="kw-2">&</span><span class="ident">r</span>) { |
| <span class="self">self</span>.<span class="ident">need_read</span>(); |
| } |
| <span class="kw">return</span> <span class="ident">r</span> |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">E</span><span class="op">></span> <span class="ident">Write</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> |
| <span class="kw">where</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">E</span>: <span class="ident">Write</span>, |
| { |
| <span class="kw">fn</span> <span class="ident">write</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> { |
| <span class="kw">if</span> <span class="kw">let</span> <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">poll_write</span>() { |
| <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>.<span class="ident">into</span>()) |
| } |
| <span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">get_ref</span>().<span class="ident">write</span>(<span class="ident">buf</span>); |
| <span class="kw">if</span> <span class="ident">is_wouldblock</span>(<span class="kw-2">&</span><span class="ident">r</span>) { |
| <span class="self">self</span>.<span class="ident">need_write</span>(); |
| } |
| <span class="kw">return</span> <span class="ident">r</span> |
| } |
| |
| <span class="kw">fn</span> <span class="ident">flush</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="kw">if</span> <span class="kw">let</span> <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">poll_write</span>() { |
| <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>.<span class="ident">into</span>()) |
| } |
| <span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">get_ref</span>().<span class="ident">flush</span>(); |
| <span class="kw">if</span> <span class="ident">is_wouldblock</span>(<span class="kw-2">&</span><span class="ident">r</span>) { |
| <span class="self">self</span>.<span class="ident">need_write</span>(); |
| } |
| <span class="kw">return</span> <span class="ident">r</span> |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">E</span><span class="op">></span> <span class="ident">AsyncRead</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> |
| <span class="kw">where</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">E</span>: <span class="ident">Read</span>, |
| { |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">E</span><span class="op">></span> <span class="ident">AsyncWrite</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> |
| <span class="kw">where</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">E</span>: <span class="ident">Write</span>, |
| { |
| <span class="kw">fn</span> <span class="ident">shutdown</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">io</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="prelude-val">Ok</span>(().<span class="ident">into</span>()) |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">allow</span>(<span class="ident">deprecated</span>)]</span> |
| <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">E</span><span class="op">></span> ::<span class="ident">io</span>::<span class="ident">Io</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> |
| <span class="kw">where</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">E</span>: <span class="ident">Read</span> <span class="op">+</span> <span class="ident">Write</span>, |
| { |
| <span class="kw">fn</span> <span class="ident">poll_read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="op"><</span><span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">>></span>::<span class="ident">poll_read</span>(<span class="self">self</span>) |
| } |
| |
| <span class="kw">fn</span> <span class="ident">poll_write</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="op"><</span><span class="ident">PollEvented</span><span class="op"><</span><span class="ident">E</span><span class="op">>></span>::<span class="ident">poll_write</span>(<span class="self">self</span>) |
| } |
| } |
| |
| <span class="kw">fn</span> <span class="ident">is_wouldblock</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">r</span>: <span class="kw-2">&</span><span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>) <span class="op">-></span> <span class="ident">bool</span> { |
| <span class="kw">match</span> <span class="kw-2">*</span><span class="ident">r</span> { |
| <span class="prelude-val">Ok</span>(_) <span class="op">=></span> <span class="bool-val">false</span>, |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="op">=></span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">==</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>, |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">PollEvented</span><span class="op"><</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">token</span>.<span class="ident">drop_source</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">handle</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 = "tokio_core"; |
| </script> |
| <script src="../../../main.js"></script> |
| <script defer src="../../../search-index.js"></script> |
| </body> |
| </html> |
