| <!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/tokio-1.28.2/src/io/async_fd.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>async_fd.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> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| <span id="634">634</span> |
| <span id="635">635</span> |
| <span id="636">636</span> |
| <span id="637">637</span> |
| <span id="638">638</span> |
| <span id="639">639</span> |
| <span id="640">640</span> |
| <span id="641">641</span> |
| <span id="642">642</span> |
| <span id="643">643</span> |
| <span id="644">644</span> |
| <span id="645">645</span> |
| <span id="646">646</span> |
| <span id="647">647</span> |
| <span id="648">648</span> |
| <span id="649">649</span> |
| <span id="650">650</span> |
| <span id="651">651</span> |
| <span id="652">652</span> |
| <span id="653">653</span> |
| <span id="654">654</span> |
| <span id="655">655</span> |
| <span id="656">656</span> |
| <span id="657">657</span> |
| <span id="658">658</span> |
| <span id="659">659</span> |
| <span id="660">660</span> |
| <span id="661">661</span> |
| <span id="662">662</span> |
| <span id="663">663</span> |
| <span id="664">664</span> |
| <span id="665">665</span> |
| <span id="666">666</span> |
| <span id="667">667</span> |
| <span id="668">668</span> |
| <span id="669">669</span> |
| <span id="670">670</span> |
| <span id="671">671</span> |
| <span id="672">672</span> |
| <span id="673">673</span> |
| <span id="674">674</span> |
| <span id="675">675</span> |
| <span id="676">676</span> |
| <span id="677">677</span> |
| <span id="678">678</span> |
| <span id="679">679</span> |
| <span id="680">680</span> |
| <span id="681">681</span> |
| <span id="682">682</span> |
| <span id="683">683</span> |
| <span id="684">684</span> |
| <span id="685">685</span> |
| <span id="686">686</span> |
| <span id="687">687</span> |
| <span id="688">688</span> |
| <span id="689">689</span> |
| <span id="690">690</span> |
| <span id="691">691</span> |
| <span id="692">692</span> |
| <span id="693">693</span> |
| <span id="694">694</span> |
| <span id="695">695</span> |
| <span id="696">696</span> |
| <span id="697">697</span> |
| <span id="698">698</span> |
| <span id="699">699</span> |
| <span id="700">700</span> |
| <span id="701">701</span> |
| <span id="702">702</span> |
| <span id="703">703</span> |
| <span id="704">704</span> |
| <span id="705">705</span> |
| <span id="706">706</span> |
| <span id="707">707</span> |
| <span id="708">708</span> |
| <span id="709">709</span> |
| <span id="710">710</span> |
| <span id="711">711</span> |
| <span id="712">712</span> |
| <span id="713">713</span> |
| <span id="714">714</span> |
| <span id="715">715</span> |
| <span id="716">716</span> |
| <span id="717">717</span> |
| <span id="718">718</span> |
| <span id="719">719</span> |
| <span id="720">720</span> |
| <span id="721">721</span> |
| <span id="722">722</span> |
| <span id="723">723</span> |
| <span id="724">724</span> |
| <span id="725">725</span> |
| <span id="726">726</span> |
| <span id="727">727</span> |
| <span id="728">728</span> |
| <span id="729">729</span> |
| <span id="730">730</span> |
| <span id="731">731</span> |
| <span id="732">732</span> |
| <span id="733">733</span> |
| <span id="734">734</span> |
| <span id="735">735</span> |
| <span id="736">736</span> |
| <span id="737">737</span> |
| <span id="738">738</span> |
| <span id="739">739</span> |
| <span id="740">740</span> |
| <span id="741">741</span> |
| <span id="742">742</span> |
| <span id="743">743</span> |
| <span id="744">744</span> |
| <span id="745">745</span> |
| <span id="746">746</span> |
| <span id="747">747</span> |
| <span id="748">748</span> |
| <span id="749">749</span> |
| <span id="750">750</span> |
| <span id="751">751</span> |
| <span id="752">752</span> |
| <span id="753">753</span> |
| <span id="754">754</span> |
| <span id="755">755</span> |
| <span id="756">756</span> |
| <span id="757">757</span> |
| <span id="758">758</span> |
| <span id="759">759</span> |
| <span id="760">760</span> |
| <span id="761">761</span> |
| <span id="762">762</span> |
| <span id="763">763</span> |
| <span id="764">764</span> |
| <span id="765">765</span> |
| <span id="766">766</span> |
| <span id="767">767</span> |
| <span id="768">768</span> |
| <span id="769">769</span> |
| <span id="770">770</span> |
| <span id="771">771</span> |
| <span id="772">772</span> |
| <span id="773">773</span> |
| <span id="774">774</span> |
| <span id="775">775</span> |
| <span id="776">776</span> |
| <span id="777">777</span> |
| <span id="778">778</span> |
| <span id="779">779</span> |
| <span id="780">780</span> |
| <span id="781">781</span> |
| <span id="782">782</span> |
| <span id="783">783</span> |
| <span id="784">784</span> |
| <span id="785">785</span> |
| <span id="786">786</span> |
| <span id="787">787</span> |
| <span id="788">788</span> |
| <span id="789">789</span> |
| <span id="790">790</span> |
| <span id="791">791</span> |
| <span id="792">792</span> |
| <span id="793">793</span> |
| <span id="794">794</span> |
| <span id="795">795</span> |
| <span id="796">796</span> |
| <span id="797">797</span> |
| <span id="798">798</span> |
| <span id="799">799</span> |
| <span id="800">800</span> |
| <span id="801">801</span> |
| <span id="802">802</span> |
| <span id="803">803</span> |
| <span id="804">804</span> |
| <span id="805">805</span> |
| <span id="806">806</span> |
| <span id="807">807</span> |
| <span id="808">808</span> |
| <span id="809">809</span> |
| <span id="810">810</span> |
| <span id="811">811</span> |
| <span id="812">812</span> |
| <span id="813">813</span> |
| <span id="814">814</span> |
| <span id="815">815</span> |
| <span id="816">816</span> |
| <span id="817">817</span> |
| <span id="818">818</span> |
| <span id="819">819</span> |
| <span id="820">820</span> |
| <span id="821">821</span> |
| <span id="822">822</span> |
| <span id="823">823</span> |
| <span id="824">824</span> |
| <span id="825">825</span> |
| <span id="826">826</span> |
| <span id="827">827</span> |
| <span id="828">828</span> |
| <span id="829">829</span> |
| <span id="830">830</span> |
| <span id="831">831</span> |
| <span id="832">832</span> |
| <span id="833">833</span> |
| <span id="834">834</span> |
| <span id="835">835</span> |
| <span id="836">836</span> |
| <span id="837">837</span> |
| <span id="838">838</span> |
| <span id="839">839</span> |
| <span id="840">840</span> |
| <span id="841">841</span> |
| <span id="842">842</span> |
| <span id="843">843</span> |
| <span id="844">844</span> |
| <span id="845">845</span> |
| <span id="846">846</span> |
| <span id="847">847</span> |
| <span id="848">848</span> |
| <span id="849">849</span> |
| <span id="850">850</span> |
| <span id="851">851</span> |
| <span id="852">852</span> |
| <span id="853">853</span> |
| <span id="854">854</span> |
| <span id="855">855</span> |
| <span id="856">856</span> |
| <span id="857">857</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::io::Interest; |
| <span class="kw">use </span><span class="kw">crate</span>::runtime::io::{ReadyEvent, Registration}; |
| <span class="kw">use </span><span class="kw">crate</span>::runtime::scheduler; |
| |
| <span class="kw">use </span>mio::unix::SourceFd; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::os::unix::io::{AsRawFd, RawFd}; |
| <span class="kw">use </span>std::{task::Context, task::Poll}; |
| |
| <span class="doccomment">/// Associates an IO object backed by a Unix file descriptor with the tokio |
| /// reactor, allowing for readiness to be polled. The file descriptor must be of |
| /// a type that can be used with the OS polling facilities (ie, `poll`, `epoll`, |
| /// `kqueue`, etc), such as a network socket or pipe, and the file descriptor |
| /// must have the nonblocking mode set to true. |
| /// |
| /// Creating an AsyncFd registers the file descriptor with the current tokio |
| /// Reactor, allowing you to directly await the file descriptor being readable |
| /// or writable. Once registered, the file descriptor remains registered until |
| /// the AsyncFd is dropped. |
| /// |
| /// The AsyncFd takes ownership of an arbitrary object to represent the IO |
| /// object. It is intended that this object will handle closing the file |
| /// descriptor when it is dropped, avoiding resource leaks and ensuring that the |
| /// AsyncFd can clean up the registration before closing the file descriptor. |
| /// The [`AsyncFd::into_inner`] function can be used to extract the inner object |
| /// to retake control from the tokio IO reactor. |
| /// |
| /// The inner object is required to implement [`AsRawFd`]. This file descriptor |
| /// must not change while [`AsyncFd`] owns the inner object, i.e. the |
| /// [`AsRawFd::as_raw_fd`] method on the inner type must always return the same |
| /// file descriptor when called multiple times. Failure to uphold this results |
| /// in unspecified behavior in the IO driver, which may include breaking |
| /// notifications for other sockets/etc. |
| /// |
| /// Polling for readiness is done by calling the async functions [`readable`] |
| /// and [`writable`]. These functions complete when the associated readiness |
| /// condition is observed. Any number of tasks can query the same `AsyncFd` in |
| /// parallel, on the same or different conditions. |
| /// |
| /// On some platforms, the readiness detecting mechanism relies on |
| /// edge-triggered notifications. This means that the OS will only notify Tokio |
| /// when the file descriptor transitions from not-ready to ready. For this to |
| /// work you should first try to read or write and only poll for readiness |
| /// if that fails with an error of [`std::io::ErrorKind::WouldBlock`]. |
| /// |
| /// Tokio internally tracks when it has received a ready notification, and when |
| /// readiness checking functions like [`readable`] and [`writable`] are called, |
| /// if the readiness flag is set, these async functions will complete |
| /// immediately. This however does mean that it is critical to ensure that this |
| /// ready flag is cleared when (and only when) the file descriptor ceases to be |
| /// ready. The [`AsyncFdReadyGuard`] returned from readiness checking functions |
| /// serves this function; after calling a readiness-checking async function, |
| /// you must use this [`AsyncFdReadyGuard`] to signal to tokio whether the file |
| /// descriptor is no longer in a ready state. |
| /// |
| /// ## Use with to a poll-based API |
| /// |
| /// In some cases it may be desirable to use `AsyncFd` from APIs similar to |
| /// [`TcpStream::poll_read_ready`]. The [`AsyncFd::poll_read_ready`] and |
| /// [`AsyncFd::poll_write_ready`] functions are provided for this purpose. |
| /// Because these functions don't create a future to hold their state, they have |
| /// the limitation that only one task can wait on each direction (read or write) |
| /// at a time. |
| /// |
| /// # Examples |
| /// |
| /// This example shows how to turn [`std::net::TcpStream`] asynchronous using |
| /// `AsyncFd`. It implements the read/write operations both as an `async fn` |
| /// and using the IO traits [`AsyncRead`] and [`AsyncWrite`]. |
| /// |
| /// ```no_run |
| /// use futures::ready; |
| /// use std::io::{self, Read, Write}; |
| /// use std::net::TcpStream; |
| /// use std::pin::Pin; |
| /// use std::task::{Context, Poll}; |
| /// use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; |
| /// use tokio::io::unix::AsyncFd; |
| /// |
| /// pub struct AsyncTcpStream { |
| /// inner: AsyncFd<TcpStream>, |
| /// } |
| /// |
| /// impl AsyncTcpStream { |
| /// pub fn new(tcp: TcpStream) -> io::Result<Self> { |
| /// tcp.set_nonblocking(true)?; |
| /// Ok(Self { |
| /// inner: AsyncFd::new(tcp)?, |
| /// }) |
| /// } |
| /// |
| /// pub async fn read(&self, out: &mut [u8]) -> io::Result<usize> { |
| /// loop { |
| /// let mut guard = self.inner.readable().await?; |
| /// |
| /// match guard.try_io(|inner| inner.get_ref().read(out)) { |
| /// Ok(result) => return result, |
| /// Err(_would_block) => continue, |
| /// } |
| /// } |
| /// } |
| /// |
| /// pub async fn write(&self, buf: &[u8]) -> io::Result<usize> { |
| /// loop { |
| /// let mut guard = self.inner.writable().await?; |
| /// |
| /// match guard.try_io(|inner| inner.get_ref().write(buf)) { |
| /// Ok(result) => return result, |
| /// Err(_would_block) => continue, |
| /// } |
| /// } |
| /// } |
| /// } |
| /// |
| /// impl AsyncRead for AsyncTcpStream { |
| /// fn poll_read( |
| /// self: Pin<&mut Self>, |
| /// cx: &mut Context<'_>, |
| /// buf: &mut ReadBuf<'_> |
| /// ) -> Poll<io::Result<()>> { |
| /// loop { |
| /// let mut guard = ready!(self.inner.poll_read_ready(cx))?; |
| /// |
| /// let unfilled = buf.initialize_unfilled(); |
| /// match guard.try_io(|inner| inner.get_ref().read(unfilled)) { |
| /// Ok(Ok(len)) => { |
| /// buf.advance(len); |
| /// return Poll::Ready(Ok(())); |
| /// }, |
| /// Ok(Err(err)) => return Poll::Ready(Err(err)), |
| /// Err(_would_block) => continue, |
| /// } |
| /// } |
| /// } |
| /// } |
| /// |
| /// impl AsyncWrite for AsyncTcpStream { |
| /// fn poll_write( |
| /// self: Pin<&mut Self>, |
| /// cx: &mut Context<'_>, |
| /// buf: &[u8] |
| /// ) -> Poll<io::Result<usize>> { |
| /// loop { |
| /// let mut guard = ready!(self.inner.poll_write_ready(cx))?; |
| /// |
| /// match guard.try_io(|inner| inner.get_ref().write(buf)) { |
| /// Ok(result) => return Poll::Ready(result), |
| /// Err(_would_block) => continue, |
| /// } |
| /// } |
| /// } |
| /// |
| /// fn poll_flush( |
| /// self: Pin<&mut Self>, |
| /// cx: &mut Context<'_>, |
| /// ) -> Poll<io::Result<()>> { |
| /// // tcp flush is a no-op |
| /// Poll::Ready(Ok(())) |
| /// } |
| /// |
| /// fn poll_shutdown( |
| /// self: Pin<&mut Self>, |
| /// cx: &mut Context<'_>, |
| /// ) -> Poll<io::Result<()>> { |
| /// self.inner.get_ref().shutdown(std::net::Shutdown::Write)?; |
| /// Poll::Ready(Ok(())) |
| /// } |
| /// } |
| /// ``` |
| /// |
| /// [`readable`]: method@Self::readable |
| /// [`writable`]: method@Self::writable |
| /// [`AsyncFdReadyGuard`]: struct@self::AsyncFdReadyGuard |
| /// [`TcpStream::poll_read_ready`]: struct@crate::net::TcpStream |
| /// [`AsyncRead`]: trait@crate::io::AsyncRead |
| /// [`AsyncWrite`]: trait@crate::io::AsyncWrite |
| </span><span class="kw">pub struct </span>AsyncFd<T: AsRawFd> { |
| registration: Registration, |
| inner: <span class="prelude-ty">Option</span><T>, |
| } |
| |
| <span class="doccomment">/// Represents an IO-ready event detected on a particular file descriptor that |
| /// has not yet been acknowledged. This is a `must_use` structure to help ensure |
| /// that you do not forget to explicitly clear (or not clear) the event. |
| /// |
| /// This type exposes an immutable reference to the underlying IO object. |
| </span><span class="attribute">#[must_use = <span class="string">"You must explicitly choose whether to clear the readiness state by calling a method on ReadyGuard"</span>] |
| </span><span class="kw">pub struct </span>AsyncFdReadyGuard<<span class="lifetime">'a</span>, T: AsRawFd> { |
| async_fd: <span class="kw-2">&</span><span class="lifetime">'a </span>AsyncFd<T>, |
| event: <span class="prelude-ty">Option</span><ReadyEvent>, |
| } |
| |
| <span class="doccomment">/// Represents an IO-ready event detected on a particular file descriptor that |
| /// has not yet been acknowledged. This is a `must_use` structure to help ensure |
| /// that you do not forget to explicitly clear (or not clear) the event. |
| /// |
| /// This type exposes a mutable reference to the underlying IO object. |
| </span><span class="attribute">#[must_use = <span class="string">"You must explicitly choose whether to clear the readiness state by calling a method on ReadyGuard"</span>] |
| </span><span class="kw">pub struct </span>AsyncFdReadyMutGuard<<span class="lifetime">'a</span>, T: AsRawFd> { |
| async_fd: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>AsyncFd<T>, |
| event: <span class="prelude-ty">Option</span><ReadyEvent>, |
| } |
| |
| <span class="kw">const </span>ALL_INTEREST: Interest = Interest::READABLE.add(Interest::WRITABLE); |
| |
| <span class="kw">impl</span><T: AsRawFd> AsyncFd<T> { |
| <span class="doccomment">/// Creates an AsyncFd backed by (and taking ownership of) an object |
| /// implementing [`AsRawFd`]. The backing file descriptor is cached at the |
| /// time of creation. |
| /// |
| /// This method must be called in the context of a tokio runtime. |
| /// |
| /// # Panics |
| /// |
| /// This function panics if there is no current reactor set, or if the `rt` |
| /// feature flag is not enabled. |
| </span><span class="attribute">#[inline] |
| #[track_caller] |
| </span><span class="kw">pub fn </span>new(inner: T) -> io::Result<<span class="self">Self</span>> |
| <span class="kw">where |
| </span>T: AsRawFd, |
| { |
| <span class="self">Self</span>::with_interest(inner, ALL_INTEREST) |
| } |
| |
| <span class="doccomment">/// Creates new instance as `new` with additional ability to customize interest, |
| /// allowing to specify whether file descriptor will be polled for read, write or both. |
| /// |
| /// # Panics |
| /// |
| /// This function panics if there is no current reactor set, or if the `rt` |
| /// feature flag is not enabled. |
| </span><span class="attribute">#[inline] |
| #[track_caller] |
| </span><span class="kw">pub fn </span>with_interest(inner: T, interest: Interest) -> io::Result<<span class="self">Self</span>> |
| <span class="kw">where |
| </span>T: AsRawFd, |
| { |
| <span class="self">Self</span>::new_with_handle_and_interest(inner, scheduler::Handle::current(), interest) |
| } |
| |
| <span class="attribute">#[track_caller] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_with_handle_and_interest( |
| inner: T, |
| handle: scheduler::Handle, |
| interest: Interest, |
| ) -> io::Result<<span class="self">Self</span>> { |
| <span class="kw">let </span>fd = inner.as_raw_fd(); |
| |
| <span class="kw">let </span>registration = |
| Registration::new_with_interest_and_handle(<span class="kw-2">&mut </span>SourceFd(<span class="kw-2">&</span>fd), interest, handle)<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(AsyncFd { |
| registration, |
| inner: <span class="prelude-val">Some</span>(inner), |
| }) |
| } |
| |
| <span class="doccomment">/// Returns a shared reference to the backing object of this [`AsyncFd`]. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>T { |
| <span class="self">self</span>.inner.as_ref().unwrap() |
| } |
| |
| <span class="doccomment">/// Returns a mutable reference to the backing object of this [`AsyncFd`]. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>T { |
| <span class="self">self</span>.inner.as_mut().unwrap() |
| } |
| |
| <span class="kw">fn </span>take_inner(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><T> { |
| <span class="kw">let </span>fd = <span class="self">self</span>.inner.as_ref().map(AsRawFd::as_raw_fd); |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(fd) = fd { |
| <span class="kw">let _ </span>= <span class="self">self</span>.registration.deregister(<span class="kw-2">&mut </span>SourceFd(<span class="kw-2">&</span>fd)); |
| } |
| |
| <span class="self">self</span>.inner.take() |
| } |
| |
| <span class="doccomment">/// Deregisters this file descriptor and returns ownership of the backing |
| /// object. |
| </span><span class="kw">pub fn </span>into_inner(<span class="kw-2">mut </span><span class="self">self</span>) -> T { |
| <span class="self">self</span>.take_inner().unwrap() |
| } |
| |
| <span class="doccomment">/// Polls for read readiness. |
| /// |
| /// If the file descriptor is not currently ready for reading, this method |
| /// will store a clone of the [`Waker`] from the provided [`Context`]. When the |
| /// file descriptor becomes ready for reading, [`Waker::wake`] will be called. |
| /// |
| /// Note that on multiple calls to [`poll_read_ready`] or |
| /// [`poll_read_ready_mut`], only the `Waker` from the `Context` passed to the |
| /// most recent call is scheduled to receive a wakeup. (However, |
| /// [`poll_write_ready`] retains a second, independent waker). |
| /// |
| /// This method is intended for cases where creating and pinning a future |
| /// via [`readable`] is not feasible. Where possible, using [`readable`] is |
| /// preferred, as this supports polling from multiple tasks at once. |
| /// |
| /// This method takes `&self`, so it is possible to call this method |
| /// concurrently with other methods on this struct. This method only |
| /// provides shared access to the inner IO resource when handling the |
| /// [`AsyncFdReadyGuard`]. |
| /// |
| /// [`poll_read_ready`]: method@Self::poll_read_ready |
| /// [`poll_read_ready_mut`]: method@Self::poll_read_ready_mut |
| /// [`poll_write_ready`]: method@Self::poll_write_ready |
| /// [`readable`]: method@Self::readable |
| /// [`Context`]: struct@std::task::Context |
| /// [`Waker`]: struct@std::task::Waker |
| /// [`Waker::wake`]: method@std::task::Waker::wake |
| </span><span class="kw">pub fn </span>poll_read_ready<<span class="lifetime">'a</span>>( |
| <span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<AsyncFdReadyGuard<<span class="lifetime">'a</span>, T>>> { |
| <span class="kw">let </span>event = <span class="macro">ready!</span>(<span class="self">self</span>.registration.poll_read_ready(cx))<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(AsyncFdReadyGuard { |
| async_fd: <span class="self">self</span>, |
| event: <span class="prelude-val">Some</span>(event), |
| }) |
| .into() |
| } |
| |
| <span class="doccomment">/// Polls for read readiness. |
| /// |
| /// If the file descriptor is not currently ready for reading, this method |
| /// will store a clone of the [`Waker`] from the provided [`Context`]. When the |
| /// file descriptor becomes ready for reading, [`Waker::wake`] will be called. |
| /// |
| /// Note that on multiple calls to [`poll_read_ready`] or |
| /// [`poll_read_ready_mut`], only the `Waker` from the `Context` passed to the |
| /// most recent call is scheduled to receive a wakeup. (However, |
| /// [`poll_write_ready`] retains a second, independent waker). |
| /// |
| /// This method is intended for cases where creating and pinning a future |
| /// via [`readable`] is not feasible. Where possible, using [`readable`] is |
| /// preferred, as this supports polling from multiple tasks at once. |
| /// |
| /// This method takes `&mut self`, so it is possible to access the inner IO |
| /// resource mutably when handling the [`AsyncFdReadyMutGuard`]. |
| /// |
| /// [`poll_read_ready`]: method@Self::poll_read_ready |
| /// [`poll_read_ready_mut`]: method@Self::poll_read_ready_mut |
| /// [`poll_write_ready`]: method@Self::poll_write_ready |
| /// [`readable`]: method@Self::readable |
| /// [`Context`]: struct@std::task::Context |
| /// [`Waker`]: struct@std::task::Waker |
| /// [`Waker::wake`]: method@std::task::Waker::wake |
| </span><span class="kw">pub fn </span>poll_read_ready_mut<<span class="lifetime">'a</span>>( |
| <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<AsyncFdReadyMutGuard<<span class="lifetime">'a</span>, T>>> { |
| <span class="kw">let </span>event = <span class="macro">ready!</span>(<span class="self">self</span>.registration.poll_read_ready(cx))<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(AsyncFdReadyMutGuard { |
| async_fd: <span class="self">self</span>, |
| event: <span class="prelude-val">Some</span>(event), |
| }) |
| .into() |
| } |
| |
| <span class="doccomment">/// Polls for write readiness. |
| /// |
| /// If the file descriptor is not currently ready for writing, this method |
| /// will store a clone of the [`Waker`] from the provided [`Context`]. When the |
| /// file descriptor becomes ready for writing, [`Waker::wake`] will be called. |
| /// |
| /// Note that on multiple calls to [`poll_write_ready`] or |
| /// [`poll_write_ready_mut`], only the `Waker` from the `Context` passed to the |
| /// most recent call is scheduled to receive a wakeup. (However, |
| /// [`poll_read_ready`] retains a second, independent waker). |
| /// |
| /// This method is intended for cases where creating and pinning a future |
| /// via [`writable`] is not feasible. Where possible, using [`writable`] is |
| /// preferred, as this supports polling from multiple tasks at once. |
| /// |
| /// This method takes `&self`, so it is possible to call this method |
| /// concurrently with other methods on this struct. This method only |
| /// provides shared access to the inner IO resource when handling the |
| /// [`AsyncFdReadyGuard`]. |
| /// |
| /// [`poll_read_ready`]: method@Self::poll_read_ready |
| /// [`poll_write_ready`]: method@Self::poll_write_ready |
| /// [`poll_write_ready_mut`]: method@Self::poll_write_ready_mut |
| /// [`writable`]: method@Self::readable |
| /// [`Context`]: struct@std::task::Context |
| /// [`Waker`]: struct@std::task::Waker |
| /// [`Waker::wake`]: method@std::task::Waker::wake |
| </span><span class="kw">pub fn </span>poll_write_ready<<span class="lifetime">'a</span>>( |
| <span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<AsyncFdReadyGuard<<span class="lifetime">'a</span>, T>>> { |
| <span class="kw">let </span>event = <span class="macro">ready!</span>(<span class="self">self</span>.registration.poll_write_ready(cx))<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(AsyncFdReadyGuard { |
| async_fd: <span class="self">self</span>, |
| event: <span class="prelude-val">Some</span>(event), |
| }) |
| .into() |
| } |
| |
| <span class="doccomment">/// Polls for write readiness. |
| /// |
| /// If the file descriptor is not currently ready for writing, this method |
| /// will store a clone of the [`Waker`] from the provided [`Context`]. When the |
| /// file descriptor becomes ready for writing, [`Waker::wake`] will be called. |
| /// |
| /// Note that on multiple calls to [`poll_write_ready`] or |
| /// [`poll_write_ready_mut`], only the `Waker` from the `Context` passed to the |
| /// most recent call is scheduled to receive a wakeup. (However, |
| /// [`poll_read_ready`] retains a second, independent waker). |
| /// |
| /// This method is intended for cases where creating and pinning a future |
| /// via [`writable`] is not feasible. Where possible, using [`writable`] is |
| /// preferred, as this supports polling from multiple tasks at once. |
| /// |
| /// This method takes `&mut self`, so it is possible to access the inner IO |
| /// resource mutably when handling the [`AsyncFdReadyMutGuard`]. |
| /// |
| /// [`poll_read_ready`]: method@Self::poll_read_ready |
| /// [`poll_write_ready`]: method@Self::poll_write_ready |
| /// [`poll_write_ready_mut`]: method@Self::poll_write_ready_mut |
| /// [`writable`]: method@Self::readable |
| /// [`Context`]: struct@std::task::Context |
| /// [`Waker`]: struct@std::task::Waker |
| /// [`Waker::wake`]: method@std::task::Waker::wake |
| </span><span class="kw">pub fn </span>poll_write_ready_mut<<span class="lifetime">'a</span>>( |
| <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<AsyncFdReadyMutGuard<<span class="lifetime">'a</span>, T>>> { |
| <span class="kw">let </span>event = <span class="macro">ready!</span>(<span class="self">self</span>.registration.poll_write_ready(cx))<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(AsyncFdReadyMutGuard { |
| async_fd: <span class="self">self</span>, |
| event: <span class="prelude-val">Some</span>(event), |
| }) |
| .into() |
| } |
| |
| <span class="kw">async fn </span>readiness(<span class="kw-2">&</span><span class="self">self</span>, interest: Interest) -> io::Result<AsyncFdReadyGuard<<span class="lifetime">'_</span>, T>> { |
| <span class="kw">let </span>event = <span class="self">self</span>.registration.readiness(interest).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(AsyncFdReadyGuard { |
| async_fd: <span class="self">self</span>, |
| event: <span class="prelude-val">Some</span>(event), |
| }) |
| } |
| |
| <span class="kw">async fn </span>readiness_mut( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| interest: Interest, |
| ) -> io::Result<AsyncFdReadyMutGuard<<span class="lifetime">'_</span>, T>> { |
| <span class="kw">let </span>event = <span class="self">self</span>.registration.readiness(interest).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(AsyncFdReadyMutGuard { |
| async_fd: <span class="self">self</span>, |
| event: <span class="prelude-val">Some</span>(event), |
| }) |
| } |
| |
| <span class="doccomment">/// Waits for the file descriptor to become readable, returning a |
| /// [`AsyncFdReadyGuard`] that must be dropped to resume read-readiness |
| /// polling. |
| /// |
| /// This method takes `&self`, so it is possible to call this method |
| /// concurrently with other methods on this struct. This method only |
| /// provides shared access to the inner IO resource when handling the |
| /// [`AsyncFdReadyGuard`]. |
| </span><span class="attribute">#[allow(clippy::needless_lifetimes)] </span><span class="comment">// The lifetime improves rustdoc rendering. |
| </span><span class="kw">pub async fn </span>readable<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>) -> io::Result<AsyncFdReadyGuard<<span class="lifetime">'a</span>, T>> { |
| <span class="self">self</span>.readiness(Interest::READABLE).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Waits for the file descriptor to become readable, returning a |
| /// [`AsyncFdReadyMutGuard`] that must be dropped to resume read-readiness |
| /// polling. |
| /// |
| /// This method takes `&mut self`, so it is possible to access the inner IO |
| /// resource mutably when handling the [`AsyncFdReadyMutGuard`]. |
| </span><span class="attribute">#[allow(clippy::needless_lifetimes)] </span><span class="comment">// The lifetime improves rustdoc rendering. |
| </span><span class="kw">pub async fn </span>readable_mut<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> io::Result<AsyncFdReadyMutGuard<<span class="lifetime">'a</span>, T>> { |
| <span class="self">self</span>.readiness_mut(Interest::READABLE).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Waits for the file descriptor to become writable, returning a |
| /// [`AsyncFdReadyGuard`] that must be dropped to resume write-readiness |
| /// polling. |
| /// |
| /// This method takes `&self`, so it is possible to call this method |
| /// concurrently with other methods on this struct. This method only |
| /// provides shared access to the inner IO resource when handling the |
| /// [`AsyncFdReadyGuard`]. |
| </span><span class="attribute">#[allow(clippy::needless_lifetimes)] </span><span class="comment">// The lifetime improves rustdoc rendering. |
| </span><span class="kw">pub async fn </span>writable<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>) -> io::Result<AsyncFdReadyGuard<<span class="lifetime">'a</span>, T>> { |
| <span class="self">self</span>.readiness(Interest::WRITABLE).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Waits for the file descriptor to become writable, returning a |
| /// [`AsyncFdReadyMutGuard`] that must be dropped to resume write-readiness |
| /// polling. |
| /// |
| /// This method takes `&mut self`, so it is possible to access the inner IO |
| /// resource mutably when handling the [`AsyncFdReadyMutGuard`]. |
| </span><span class="attribute">#[allow(clippy::needless_lifetimes)] </span><span class="comment">// The lifetime improves rustdoc rendering. |
| </span><span class="kw">pub async fn </span>writable_mut<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> io::Result<AsyncFdReadyMutGuard<<span class="lifetime">'a</span>, T>> { |
| <span class="self">self</span>.readiness_mut(Interest::WRITABLE).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Reads or writes from the file descriptor using a user-provided IO operation. |
| /// |
| /// The `async_io` method is a convenience utility that waits for the file |
| /// descriptor to become ready, and then executes the provided IO operation. |
| /// Since file descriptors may be marked ready spuriously, the closure will |
| /// be called repeatedly until it returns something other than a |
| /// [`WouldBlock`] error. This is done using the following loop: |
| /// |
| /// ```no_run |
| /// # use std::io::{self, Result}; |
| /// # struct Dox<T> { inner: T } |
| /// # impl<T> Dox<T> { |
| /// # async fn writable(&self) -> Result<&Self> { |
| /// # Ok(self) |
| /// # } |
| /// # fn try_io<R>(&self, _: impl FnMut(&T) -> Result<R>) -> Result<Result<R>> { |
| /// # panic!() |
| /// # } |
| /// async fn async_io<R>(&self, mut f: impl FnMut(&T) -> io::Result<R>) -> io::Result<R> { |
| /// loop { |
| /// // or `readable` if called with the read interest. |
| /// let guard = self.writable().await?; |
| /// |
| /// match guard.try_io(&mut f) { |
| /// Ok(result) => return result, |
| /// Err(_would_block) => continue, |
| /// } |
| /// } |
| /// } |
| /// # } |
| /// ``` |
| /// |
| /// The closure should only return a [`WouldBlock`] error if it has performed |
| /// an IO operation on the file descriptor that failed due to the file descriptor not being |
| /// ready. Returning a [`WouldBlock`] error in any other situation will |
| /// incorrectly clear the readiness flag, which can cause the file descriptor to |
| /// behave incorrectly. |
| /// |
| /// The closure should not perform the IO operation using any of the methods |
| /// defined on the Tokio [`AsyncFd`] type, as this will mess with the |
| /// readiness flag and can cause the file descriptor to behave incorrectly. |
| /// |
| /// This method is not intended to be used with combined interests. |
| /// The closure should perform only one type of IO operation, so it should not |
| /// require more than one ready state. This method may panic or sleep forever |
| /// if it is called with a combined interest. |
| /// |
| /// # Examples |
| /// |
| /// This example sends some bytes on the inner [`std::net::UdpSocket`]. The `async_io` |
| /// method waits for readiness, and retries if the send operation does block. This example |
| /// is equivalent to the one given for [`try_io`]. |
| /// |
| /// ```no_run |
| /// use tokio::io::{Interest, unix::AsyncFd}; |
| /// |
| /// use std::io; |
| /// use std::net::UdpSocket; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let socket = UdpSocket::bind("0.0.0.0:8080")?; |
| /// socket.set_nonblocking(true)?; |
| /// let async_fd = AsyncFd::new(socket)?; |
| /// |
| /// let written = async_fd |
| /// .async_io(Interest::WRITABLE, |inner| inner.send(&[1, 2])) |
| /// .await?; |
| /// |
| /// println!("wrote {written} bytes"); |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| /// |
| /// [`try_io`]: AsyncFdReadyGuard::try_io |
| /// [`WouldBlock`]: std::io::ErrorKind::WouldBlock |
| </span><span class="kw">pub async fn </span>async_io<R>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| interest: Interest, |
| <span class="kw-2">mut </span>f: <span class="kw">impl </span>FnMut(<span class="kw-2">&</span>T) -> io::Result<R>, |
| ) -> io::Result<R> { |
| <span class="self">self</span>.registration |
| .async_io(interest, || f(<span class="self">self</span>.get_ref())) |
| .<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Reads or writes from the file descriptor using a user-provided IO operation. |
| /// |
| /// The behavior is the same as [`async_io`], except that the closure can mutate the inner |
| /// value of the [`AsyncFd`]. |
| /// |
| /// [`async_io`]: AsyncFd::async_io |
| </span><span class="kw">pub async fn </span>async_io_mut<R>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| interest: Interest, |
| <span class="kw-2">mut </span>f: <span class="kw">impl </span>FnMut(<span class="kw-2">&mut </span>T) -> io::Result<R>, |
| ) -> io::Result<R> { |
| <span class="self">self</span>.registration |
| .async_io(interest, || f(<span class="self">self</span>.inner.as_mut().unwrap())) |
| .<span class="kw">await |
| </span>} |
| } |
| |
| <span class="kw">impl</span><T: AsRawFd> AsRawFd <span class="kw">for </span>AsyncFd<T> { |
| <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&</span><span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.inner.as_ref().unwrap().as_raw_fd() |
| } |
| } |
| |
| <span class="attribute">#[cfg(not(tokio_no_as_fd))] |
| </span><span class="kw">impl</span><T: AsRawFd> std::os::unix::io::AsFd <span class="kw">for </span>AsyncFd<T> { |
| <span class="kw">fn </span>as_fd(<span class="kw-2">&</span><span class="self">self</span>) -> std::os::unix::io::BorrowedFd<<span class="lifetime">'_</span>> { |
| <span class="kw">unsafe </span>{ std::os::unix::io::BorrowedFd::borrow_raw(<span class="self">self</span>.as_raw_fd()) } |
| } |
| } |
| |
| <span class="kw">impl</span><T: std::fmt::Debug + AsRawFd> std::fmt::Debug <span class="kw">for </span>AsyncFd<T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>std::fmt::Formatter<<span class="lifetime">'_</span>>) -> std::fmt::Result { |
| f.debug_struct(<span class="string">"AsyncFd"</span>) |
| .field(<span class="string">"inner"</span>, <span class="kw-2">&</span><span class="self">self</span>.inner) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl</span><T: AsRawFd> Drop <span class="kw">for </span>AsyncFd<T> { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">let _ </span>= <span class="self">self</span>.take_inner(); |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, Inner: AsRawFd> AsyncFdReadyGuard<<span class="lifetime">'a</span>, Inner> { |
| <span class="doccomment">/// Indicates to tokio that the file descriptor is no longer ready. The |
| /// internal readiness flag will be cleared, and tokio will wait for the |
| /// next edge-triggered readiness notification from the OS. |
| /// |
| /// It is critical that this function not be called unless your code |
| /// _actually observes_ that the file descriptor is _not_ ready. Do not call |
| /// it simply because, for example, a read succeeded; it should be called |
| /// when a read is observed to block. |
| /// |
| /// [`drop`]: method@std::mem::drop |
| </span><span class="kw">pub fn </span>clear_ready(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(event) = <span class="self">self</span>.event.take() { |
| <span class="self">self</span>.async_fd.registration.clear_readiness(event); |
| } |
| } |
| |
| <span class="doccomment">/// This method should be invoked when you intentionally want to keep the |
| /// ready flag asserted. |
| /// |
| /// While this function is itself a no-op, it satisfies the `#[must_use]` |
| /// constraint on the [`AsyncFdReadyGuard`] type. |
| </span><span class="kw">pub fn </span>retain_ready(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="comment">// no-op |
| </span>} |
| |
| <span class="doccomment">/// Performs the provided IO operation. |
| /// |
| /// If `f` returns a [`WouldBlock`] error, the readiness state associated |
| /// with this file descriptor is cleared, and the method returns |
| /// `Err(TryIoError::WouldBlock)`. You will typically need to poll the |
| /// `AsyncFd` again when this happens. |
| /// |
| /// This method helps ensure that the readiness state of the underlying file |
| /// descriptor remains in sync with the tokio-side readiness state, by |
| /// clearing the tokio-side state only when a [`WouldBlock`] condition |
| /// occurs. It is the responsibility of the caller to ensure that `f` |
| /// returns [`WouldBlock`] only if the file descriptor that originated this |
| /// `AsyncFdReadyGuard` no longer expresses the readiness state that was queried to |
| /// create this `AsyncFdReadyGuard`. |
| /// |
| /// # Examples |
| /// |
| /// This example sends some bytes to the inner [`std::net::UdpSocket`]. Waiting |
| /// for write-readiness and retrying when the send operation does block are explicit. |
| /// This example can be written more succinctly using [`AsyncFd::async_io`]. |
| /// |
| /// ```no_run |
| /// use tokio::io::unix::AsyncFd; |
| /// |
| /// use std::io; |
| /// use std::net::UdpSocket; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let socket = UdpSocket::bind("0.0.0.0:8080")?; |
| /// socket.set_nonblocking(true)?; |
| /// let async_fd = AsyncFd::new(socket)?; |
| /// |
| /// let written = loop { |
| /// let mut guard = async_fd.writable().await?; |
| /// match guard.try_io(|inner| inner.get_ref().send(&[1, 2])) { |
| /// Ok(result) => { |
| /// break result?; |
| /// } |
| /// Err(_would_block) => { |
| /// // try_io already cleared the file descriptor's readiness state |
| /// continue; |
| /// } |
| /// } |
| /// }; |
| /// |
| /// println!("wrote {written} bytes"); |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| /// |
| /// [`WouldBlock`]: std::io::ErrorKind::WouldBlock |
| </span><span class="comment">// Alias for old name in 0.x |
| </span><span class="attribute">#[cfg_attr(docsrs, doc(alias = <span class="string">"with_io"</span>))] |
| </span><span class="kw">pub fn </span>try_io<R>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| f: <span class="kw">impl </span>FnOnce(<span class="kw-2">&</span><span class="lifetime">'a </span>AsyncFd<Inner>) -> io::Result<R>, |
| ) -> <span class="prelude-ty">Result</span><io::Result<R>, TryIoError> { |
| <span class="kw">let </span>result = f(<span class="self">self</span>.async_fd); |
| |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(e) = result.as_ref() { |
| <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock { |
| <span class="self">self</span>.clear_ready(); |
| } |
| } |
| |
| <span class="kw">match </span>result { |
| <span class="prelude-val">Err</span>(err) <span class="kw">if </span>err.kind() == io::ErrorKind::WouldBlock => <span class="prelude-val">Err</span>(TryIoError(())), |
| result => <span class="prelude-val">Ok</span>(result), |
| } |
| } |
| |
| <span class="doccomment">/// Returns a shared reference to the inner [`AsyncFd`]. |
| </span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'a </span>AsyncFd<Inner> { |
| <span class="self">self</span>.async_fd |
| } |
| |
| <span class="doccomment">/// Returns a shared reference to the backing object of the inner [`AsyncFd`]. |
| </span><span class="kw">pub fn </span>get_inner(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'a </span>Inner { |
| <span class="self">self</span>.get_ref().get_ref() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, Inner: AsRawFd> AsyncFdReadyMutGuard<<span class="lifetime">'a</span>, Inner> { |
| <span class="doccomment">/// Indicates to tokio that the file descriptor is no longer ready. The |
| /// internal readiness flag will be cleared, and tokio will wait for the |
| /// next edge-triggered readiness notification from the OS. |
| /// |
| /// It is critical that this function not be called unless your code |
| /// _actually observes_ that the file descriptor is _not_ ready. Do not call |
| /// it simply because, for example, a read succeeded; it should be called |
| /// when a read is observed to block. |
| /// |
| /// [`drop`]: method@std::mem::drop |
| </span><span class="kw">pub fn </span>clear_ready(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(event) = <span class="self">self</span>.event.take() { |
| <span class="self">self</span>.async_fd.registration.clear_readiness(event); |
| } |
| } |
| |
| <span class="doccomment">/// This method should be invoked when you intentionally want to keep the |
| /// ready flag asserted. |
| /// |
| /// While this function is itself a no-op, it satisfies the `#[must_use]` |
| /// constraint on the [`AsyncFdReadyGuard`] type. |
| </span><span class="kw">pub fn </span>retain_ready(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="comment">// no-op |
| </span>} |
| |
| <span class="doccomment">/// Performs the provided IO operation. |
| /// |
| /// If `f` returns a [`WouldBlock`] error, the readiness state associated |
| /// with this file descriptor is cleared, and the method returns |
| /// `Err(TryIoError::WouldBlock)`. You will typically need to poll the |
| /// `AsyncFd` again when this happens. |
| /// |
| /// This method helps ensure that the readiness state of the underlying file |
| /// descriptor remains in sync with the tokio-side readiness state, by |
| /// clearing the tokio-side state only when a [`WouldBlock`] condition |
| /// occurs. It is the responsibility of the caller to ensure that `f` |
| /// returns [`WouldBlock`] only if the file descriptor that originated this |
| /// `AsyncFdReadyGuard` no longer expresses the readiness state that was queried to |
| /// create this `AsyncFdReadyGuard`. |
| /// |
| /// [`WouldBlock`]: std::io::ErrorKind::WouldBlock |
| </span><span class="kw">pub fn </span>try_io<R>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| f: <span class="kw">impl </span>FnOnce(<span class="kw-2">&mut </span>AsyncFd<Inner>) -> io::Result<R>, |
| ) -> <span class="prelude-ty">Result</span><io::Result<R>, TryIoError> { |
| <span class="kw">let </span>result = f(<span class="self">self</span>.async_fd); |
| |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(e) = result.as_ref() { |
| <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock { |
| <span class="self">self</span>.clear_ready(); |
| } |
| } |
| |
| <span class="kw">match </span>result { |
| <span class="prelude-val">Err</span>(err) <span class="kw">if </span>err.kind() == io::ErrorKind::WouldBlock => <span class="prelude-val">Err</span>(TryIoError(())), |
| result => <span class="prelude-val">Ok</span>(result), |
| } |
| } |
| |
| <span class="doccomment">/// Returns a shared reference to the inner [`AsyncFd`]. |
| </span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>AsyncFd<Inner> { |
| <span class="self">self</span>.async_fd |
| } |
| |
| <span class="doccomment">/// Returns a mutable reference to the inner [`AsyncFd`]. |
| </span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>AsyncFd<Inner> { |
| <span class="self">self</span>.async_fd |
| } |
| |
| <span class="doccomment">/// Returns a shared reference to the backing object of the inner [`AsyncFd`]. |
| </span><span class="kw">pub fn </span>get_inner(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Inner { |
| <span class="self">self</span>.get_ref().get_ref() |
| } |
| |
| <span class="doccomment">/// Returns a mutable reference to the backing object of the inner [`AsyncFd`]. |
| </span><span class="kw">pub fn </span>get_inner_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>Inner { |
| <span class="self">self</span>.get_mut().get_mut() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, T: std::fmt::Debug + AsRawFd> std::fmt::Debug <span class="kw">for </span>AsyncFdReadyGuard<<span class="lifetime">'a</span>, T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>std::fmt::Formatter<<span class="lifetime">'_</span>>) -> std::fmt::Result { |
| f.debug_struct(<span class="string">"ReadyGuard"</span>) |
| .field(<span class="string">"async_fd"</span>, <span class="kw-2">&</span><span class="self">self</span>.async_fd) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, T: std::fmt::Debug + AsRawFd> std::fmt::Debug <span class="kw">for </span>AsyncFdReadyMutGuard<<span class="lifetime">'a</span>, T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>std::fmt::Formatter<<span class="lifetime">'_</span>>) -> std::fmt::Result { |
| f.debug_struct(<span class="string">"MutReadyGuard"</span>) |
| .field(<span class="string">"async_fd"</span>, <span class="kw-2">&</span><span class="self">self</span>.async_fd) |
| .finish() |
| } |
| } |
| |
| <span class="doccomment">/// The error type returned by [`try_io`]. |
| /// |
| /// This error indicates that the IO resource returned a [`WouldBlock`] error. |
| /// |
| /// [`WouldBlock`]: std::io::ErrorKind::WouldBlock |
| /// [`try_io`]: method@AsyncFdReadyGuard::try_io |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>TryIoError(()); |
| </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> |
