| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/mio/src/net/udp.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>udp.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="../../../mio/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="../../../mio/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> |
| </pre><pre class="rust"><code><span class="doccomment">//! Primitives for working with UDP. |
| //! |
| //! The types provided in this module are non-blocking by default and are |
| //! designed to be portable across all supported Mio platforms. As long as the |
| //! [portability guidelines] are followed, the behavior should be identical no |
| //! matter the target platform. |
| //! |
| //! [portability guidelines]: ../struct.Poll.html#portability |
| |
| </span><span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource; |
| <span class="kw">use crate</span>::{event, sys, Interest, Registry, Token}; |
| |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::net; |
| <span class="kw">use </span>std::net::{Ipv4Addr, Ipv6Addr, SocketAddr}; |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">use </span>std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd}; |
| <span class="attribute">#[cfg(windows)] |
| </span><span class="kw">use </span>std::os::windows::io::{AsRawSocket, FromRawSocket, IntoRawSocket, RawSocket}; |
| |
| <span class="doccomment">/// A User Datagram Protocol socket. |
| /// |
| /// This is an implementation of a bound UDP socket. This supports both IPv4 and |
| /// IPv6 addresses, and there is no corresponding notion of a server because UDP |
| /// is a datagram protocol. |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)] |
| #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// // An Echo program: |
| /// // SENDER -> sends a message. |
| /// // ECHOER -> listens and prints the message received. |
| /// |
| /// use mio::net::UdpSocket; |
| /// use mio::{Events, Interest, Poll, Token}; |
| /// use std::time::Duration; |
| /// |
| /// const SENDER: Token = Token(0); |
| /// const ECHOER: Token = Token(1); |
| /// |
| /// // This operation will fail if the address is in use, so we select different ports for each |
| /// // socket. |
| /// let mut sender_socket = UdpSocket::bind("127.0.0.1:0".parse()?)?; |
| /// let mut echoer_socket = UdpSocket::bind("127.0.0.1:0".parse()?)?; |
| /// |
| /// // If we do not use connect here, SENDER and ECHOER would need to call send_to and recv_from |
| /// // respectively. |
| /// sender_socket.connect(echoer_socket.local_addr()?)?; |
| /// |
| /// // We need a Poll to check if SENDER is ready to be written into, and if ECHOER is ready to be |
| /// // read from. |
| /// let mut poll = Poll::new()?; |
| /// |
| /// // We register our sockets here so that we can check if they are ready to be written/read. |
| /// poll.registry().register(&mut sender_socket, SENDER, Interest::WRITABLE)?; |
| /// poll.registry().register(&mut echoer_socket, ECHOER, Interest::READABLE)?; |
| /// |
| /// let msg_to_send = [9; 9]; |
| /// let mut buffer = [0; 9]; |
| /// |
| /// let mut events = Events::with_capacity(128); |
| /// loop { |
| /// poll.poll(&mut events, Some(Duration::from_millis(100)))?; |
| /// for event in events.iter() { |
| /// match event.token() { |
| /// // Our SENDER is ready to be written into. |
| /// SENDER => { |
| /// let bytes_sent = sender_socket.send(&msg_to_send)?; |
| /// assert_eq!(bytes_sent, 9); |
| /// println!("sent {:?} -> {:?} bytes", msg_to_send, bytes_sent); |
| /// }, |
| /// // Our ECHOER is ready to be read from. |
| /// ECHOER => { |
| /// let num_recv = echoer_socket.recv(&mut buffer)?; |
| /// println!("echo {:?} -> {:?}", buffer, num_recv); |
| /// buffer = [0; 9]; |
| /// # drop(buffer); // Silence unused assignment warning. |
| /// # return Ok(()); |
| /// } |
| /// _ => unreachable!() |
| /// } |
| /// } |
| /// } |
| /// # } |
| /// ``` |
| </span><span class="kw">pub struct </span>UdpSocket { |
| inner: IoSource<net::UdpSocket>, |
| } |
| |
| <span class="kw">impl </span>UdpSocket { |
| <span class="doccomment">/// Creates a UDP socket from the given address. |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)] |
| #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use mio::net::UdpSocket; |
| /// |
| /// // We must bind it to an open address. |
| /// let socket = match UdpSocket::bind("127.0.0.1:0".parse()?) { |
| /// Ok(new_socket) => new_socket, |
| /// Err(fail) => { |
| /// // We panic! here, but you could try to bind it again on another address. |
| /// panic!("Failed to bind socket. {:?}", fail); |
| /// } |
| /// }; |
| /// |
| /// // Our socket was created, but we should not use it before checking it's readiness. |
| /// # drop(socket); // Silence unused variable warning. |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>bind(addr: SocketAddr) -> io::Result<UdpSocket> { |
| sys::udp::bind(addr).map(UdpSocket::from_std) |
| } |
| |
| <span class="doccomment">/// Creates a new `UdpSocket` from a standard `net::UdpSocket`. |
| /// |
| /// This function is intended to be used to wrap a UDP socket from the |
| /// standard library in the Mio equivalent. The conversion assumes nothing |
| /// about the underlying socket; it is left up to the user to set it in |
| /// non-blocking mode. |
| </span><span class="kw">pub fn </span>from_std(socket: net::UdpSocket) -> UdpSocket { |
| UdpSocket { |
| inner: IoSource::new(socket), |
| } |
| } |
| |
| <span class="doccomment">/// Returns the socket address that this socket was created from. |
| /// |
| /// # Examples |
| /// |
| </span><span class="comment">// This assertion is almost, but not quite, universal. It fails on |
| // shared-IP FreeBSD jails. It's hard for mio to know whether we're jailed, |
| // so simply disable the test on FreeBSD. |
| </span><span class="attribute">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, not(target_os = <span class="string">"freebsd"</span>)), doc = <span class="string">"```"</span>)] |
| #[cfg_attr( |
| any(not(feature = <span class="string">"os-poll"</span>), target_os = <span class="string">"freebsd"</span>), |
| doc = <span class="string">"```ignore" |
| </span>)] |
| </span><span class="doccomment">/// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use mio::net::UdpSocket; |
| /// |
| /// let addr = "127.0.0.1:0".parse()?; |
| /// let socket = UdpSocket::bind(addr)?; |
| /// assert_eq!(socket.local_addr()?.ip(), addr.ip()); |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<SocketAddr> { |
| <span class="self">self</span>.inner.local_addr() |
| } |
| |
| <span class="doccomment">/// Returns the socket address of the remote peer this socket was connected to. |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)] |
| #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use mio::net::UdpSocket; |
| /// |
| /// let addr = "127.0.0.1:0".parse()?; |
| /// let peer_addr = "127.0.0.1:11100".parse()?; |
| /// let socket = UdpSocket::bind(addr)?; |
| /// socket.connect(peer_addr)?; |
| /// assert_eq!(socket.peer_addr()?.ip(), peer_addr.ip()); |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>peer_addr(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<SocketAddr> { |
| <span class="self">self</span>.inner.peer_addr() |
| } |
| |
| <span class="doccomment">/// Sends data on the socket to the given address. On success, returns the |
| /// number of bytes written. |
| /// |
| /// Address type can be any implementor of `ToSocketAddrs` trait. See its |
| /// documentation for concrete examples. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use std::error::Error; |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use mio::net::UdpSocket; |
| /// |
| /// let socket = UdpSocket::bind("127.0.0.1:0".parse()?)?; |
| /// |
| /// // We must check if the socket is writable before calling send_to, |
| /// // or we could run into a WouldBlock error. |
| /// |
| /// let bytes_sent = socket.send_to(&[9; 9], "127.0.0.1:11100".parse()?)?; |
| /// assert_eq!(bytes_sent, 9); |
| /// # |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>send_to(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8], target: SocketAddr) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|inner| inner.send_to(buf, target)) |
| } |
| |
| <span class="doccomment">/// Receives data from the socket. On success, returns the number of bytes |
| /// read and the address from whence the data came. |
| /// |
| /// # Notes |
| /// |
| /// On Windows, if the data is larger than the buffer specified, the buffer |
| /// is filled with the first part of the data, and recv_from returns the error |
| /// WSAEMSGSIZE(10040). The excess data is lost. |
| /// Make sure to always use a sufficiently large buffer to hold the |
| /// maximum UDP packet size, which can be up to 65536 bytes in size. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use mio::net::UdpSocket; |
| /// |
| /// let socket = UdpSocket::bind("127.0.0.1:0".parse()?)?; |
| /// |
| /// // We must check if the socket is readable before calling recv_from, |
| /// // or we could run into a WouldBlock error. |
| /// |
| /// let mut buf = [0; 9]; |
| /// let (num_recv, from_addr) = socket.recv_from(&mut buf)?; |
| /// println!("Received {:?} -> {:?} bytes from {:?}", buf, num_recv, from_addr); |
| /// # |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>recv_from(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<(usize, SocketAddr)> { |
| <span class="self">self</span>.inner.do_io(|inner| inner.recv_from(buf)) |
| } |
| |
| <span class="doccomment">/// Receives data from the socket, without removing it from the input queue. |
| /// On success, returns the number of bytes read and the address from whence |
| /// the data came. |
| /// |
| /// # Notes |
| /// |
| /// On Windows, if the data is larger than the buffer specified, the buffer |
| /// is filled with the first part of the data, and peek_from returns the error |
| /// WSAEMSGSIZE(10040). The excess data is lost. |
| /// Make sure to always use a sufficiently large buffer to hold the |
| /// maximum UDP packet size, which can be up to 65536 bytes in size. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use mio::net::UdpSocket; |
| /// |
| /// let socket = UdpSocket::bind("127.0.0.1:0".parse()?)?; |
| /// |
| /// // We must check if the socket is readable before calling recv_from, |
| /// // or we could run into a WouldBlock error. |
| /// |
| /// let mut buf = [0; 9]; |
| /// let (num_recv, from_addr) = socket.peek_from(&mut buf)?; |
| /// println!("Received {:?} -> {:?} bytes from {:?}", buf, num_recv, from_addr); |
| /// # |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>peek_from(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<(usize, SocketAddr)> { |
| <span class="self">self</span>.inner.do_io(|inner| inner.peek_from(buf)) |
| } |
| |
| <span class="doccomment">/// Sends data on the socket to the address previously bound via connect(). On success, |
| /// returns the number of bytes written. |
| </span><span class="kw">pub fn </span>send(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|inner| inner.send(buf)) |
| } |
| |
| <span class="doccomment">/// Receives data from the socket previously bound with connect(). On success, returns |
| /// the number of bytes read. |
| /// |
| /// # Notes |
| /// |
| /// On Windows, if the data is larger than the buffer specified, the buffer |
| /// is filled with the first part of the data, and recv returns the error |
| /// WSAEMSGSIZE(10040). The excess data is lost. |
| /// Make sure to always use a sufficiently large buffer to hold the |
| /// maximum UDP packet size, which can be up to 65536 bytes in size. |
| </span><span class="kw">pub fn </span>recv(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|inner| inner.recv(buf)) |
| } |
| |
| <span class="doccomment">/// Receives data from the socket, without removing it from the input queue. |
| /// On success, returns the number of bytes read. |
| /// |
| /// # Notes |
| /// |
| /// On Windows, if the data is larger than the buffer specified, the buffer |
| /// is filled with the first part of the data, and peek returns the error |
| /// WSAEMSGSIZE(10040). The excess data is lost. |
| /// Make sure to always use a sufficiently large buffer to hold the |
| /// maximum UDP packet size, which can be up to 65536 bytes in size. |
| </span><span class="kw">pub fn </span>peek(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|inner| inner.peek(buf)) |
| } |
| |
| <span class="doccomment">/// Connects the UDP socket setting the default destination for `send()` |
| /// and limiting packets that are read via `recv` from the address specified |
| /// in `addr`. |
| /// |
| /// This may return a `WouldBlock` in which case the socket connection |
| /// cannot be completed immediately, it usually means there are insufficient |
| /// entries in the routing cache. |
| </span><span class="kw">pub fn </span>connect(<span class="kw-2">&</span><span class="self">self</span>, addr: SocketAddr) -> io::Result<()> { |
| <span class="self">self</span>.inner.connect(addr) |
| } |
| |
| <span class="doccomment">/// Sets the value of the `SO_BROADCAST` option for this socket. |
| /// |
| /// When enabled, this socket is allowed to send packets to a broadcast |
| /// address. |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)] |
| #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use mio::net::UdpSocket; |
| /// |
| /// let broadcast_socket = UdpSocket::bind("127.0.0.1:0".parse()?)?; |
| /// if broadcast_socket.broadcast()? == false { |
| /// broadcast_socket.set_broadcast(true)?; |
| /// } |
| /// |
| /// assert_eq!(broadcast_socket.broadcast()?, true); |
| /// # |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>set_broadcast(<span class="kw-2">&</span><span class="self">self</span>, on: bool) -> io::Result<()> { |
| <span class="self">self</span>.inner.set_broadcast(on) |
| } |
| |
| <span class="doccomment">/// Gets the value of the `SO_BROADCAST` option for this socket. |
| /// |
| /// For more information about this option, see |
| /// [`set_broadcast`][link]. |
| /// |
| /// [link]: #method.set_broadcast |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)] |
| #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use mio::net::UdpSocket; |
| /// |
| /// let broadcast_socket = UdpSocket::bind("127.0.0.1:0".parse()?)?; |
| /// assert_eq!(broadcast_socket.broadcast()?, false); |
| /// # |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>broadcast(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<bool> { |
| <span class="self">self</span>.inner.broadcast() |
| } |
| |
| <span class="doccomment">/// Sets the value of the `IP_MULTICAST_LOOP` option for this socket. |
| /// |
| /// If enabled, multicast packets will be looped back to the local socket. |
| /// Note that this may not have any affect on IPv6 sockets. |
| </span><span class="kw">pub fn </span>set_multicast_loop_v4(<span class="kw-2">&</span><span class="self">self</span>, on: bool) -> io::Result<()> { |
| <span class="self">self</span>.inner.set_multicast_loop_v4(on) |
| } |
| |
| <span class="doccomment">/// Gets the value of the `IP_MULTICAST_LOOP` option for this socket. |
| /// |
| /// For more information about this option, see |
| /// [`set_multicast_loop_v4`][link]. |
| /// |
| /// [link]: #method.set_multicast_loop_v4 |
| </span><span class="kw">pub fn </span>multicast_loop_v4(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<bool> { |
| <span class="self">self</span>.inner.multicast_loop_v4() |
| } |
| |
| <span class="doccomment">/// Sets the value of the `IP_MULTICAST_TTL` option for this socket. |
| /// |
| /// Indicates the time-to-live value of outgoing multicast packets for |
| /// this socket. The default value is 1 which means that multicast packets |
| /// don't leave the local network unless explicitly requested. |
| /// |
| /// Note that this may not have any affect on IPv6 sockets. |
| </span><span class="kw">pub fn </span>set_multicast_ttl_v4(<span class="kw-2">&</span><span class="self">self</span>, ttl: u32) -> io::Result<()> { |
| <span class="self">self</span>.inner.set_multicast_ttl_v4(ttl) |
| } |
| |
| <span class="doccomment">/// Gets the value of the `IP_MULTICAST_TTL` option for this socket. |
| /// |
| /// For more information about this option, see |
| /// [`set_multicast_ttl_v4`][link]. |
| /// |
| /// [link]: #method.set_multicast_ttl_v4 |
| </span><span class="kw">pub fn </span>multicast_ttl_v4(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<u32> { |
| <span class="self">self</span>.inner.multicast_ttl_v4() |
| } |
| |
| <span class="doccomment">/// Sets the value of the `IPV6_MULTICAST_LOOP` option for this socket. |
| /// |
| /// Controls whether this socket sees the multicast packets it sends itself. |
| /// Note that this may not have any affect on IPv4 sockets. |
| </span><span class="kw">pub fn </span>set_multicast_loop_v6(<span class="kw-2">&</span><span class="self">self</span>, on: bool) -> io::Result<()> { |
| <span class="self">self</span>.inner.set_multicast_loop_v6(on) |
| } |
| |
| <span class="doccomment">/// Gets the value of the `IPV6_MULTICAST_LOOP` option for this socket. |
| /// |
| /// For more information about this option, see |
| /// [`set_multicast_loop_v6`][link]. |
| /// |
| /// [link]: #method.set_multicast_loop_v6 |
| </span><span class="kw">pub fn </span>multicast_loop_v6(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<bool> { |
| <span class="self">self</span>.inner.multicast_loop_v6() |
| } |
| |
| <span class="doccomment">/// Sets the value for the `IP_TTL` option on this socket. |
| /// |
| /// This value sets the time-to-live field that is used in every packet sent |
| /// from this socket. |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)] |
| #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use mio::net::UdpSocket; |
| /// |
| /// let socket = UdpSocket::bind("127.0.0.1:0".parse()?)?; |
| /// if socket.ttl()? < 255 { |
| /// socket.set_ttl(255)?; |
| /// } |
| /// |
| /// assert_eq!(socket.ttl()?, 255); |
| /// # |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>set_ttl(<span class="kw-2">&</span><span class="self">self</span>, ttl: u32) -> io::Result<()> { |
| <span class="self">self</span>.inner.set_ttl(ttl) |
| } |
| |
| <span class="doccomment">/// Gets the value of the `IP_TTL` option for this socket. |
| /// |
| /// For more information about this option, see [`set_ttl`][link]. |
| /// |
| /// [link]: #method.set_ttl |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)] |
| #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use mio::net::UdpSocket; |
| /// |
| /// let socket = UdpSocket::bind("127.0.0.1:0".parse()?)?; |
| /// socket.set_ttl(255)?; |
| /// |
| /// assert_eq!(socket.ttl()?, 255); |
| /// # |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>ttl(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<u32> { |
| <span class="self">self</span>.inner.ttl() |
| } |
| |
| <span class="doccomment">/// Executes an operation of the `IP_ADD_MEMBERSHIP` type. |
| /// |
| /// This function specifies a new multicast group for this socket to join. |
| /// The address must be a valid multicast address, and `interface` is the |
| /// address of the local interface with which the system should join the |
| /// multicast group. If it's equal to `INADDR_ANY` then an appropriate |
| /// interface is chosen by the system. |
| </span><span class="attribute">#[allow(clippy::trivially_copy_pass_by_ref)] |
| </span><span class="kw">pub fn </span>join_multicast_v4(<span class="kw-2">&</span><span class="self">self</span>, multiaddr: <span class="kw-2">&</span>Ipv4Addr, interface: <span class="kw-2">&</span>Ipv4Addr) -> io::Result<()> { |
| <span class="self">self</span>.inner.join_multicast_v4(multiaddr, interface) |
| } |
| |
| <span class="doccomment">/// Executes an operation of the `IPV6_ADD_MEMBERSHIP` type. |
| /// |
| /// This function specifies a new multicast group for this socket to join. |
| /// The address must be a valid multicast address, and `interface` is the |
| /// index of the interface to join/leave (or 0 to indicate any interface). |
| </span><span class="attribute">#[allow(clippy::trivially_copy_pass_by_ref)] |
| </span><span class="kw">pub fn </span>join_multicast_v6(<span class="kw-2">&</span><span class="self">self</span>, multiaddr: <span class="kw-2">&</span>Ipv6Addr, interface: u32) -> io::Result<()> { |
| <span class="self">self</span>.inner.join_multicast_v6(multiaddr, interface) |
| } |
| |
| <span class="doccomment">/// Executes an operation of the `IP_DROP_MEMBERSHIP` type. |
| /// |
| /// For more information about this option, see |
| /// [`join_multicast_v4`][link]. |
| /// |
| /// [link]: #method.join_multicast_v4 |
| </span><span class="attribute">#[allow(clippy::trivially_copy_pass_by_ref)] |
| </span><span class="kw">pub fn </span>leave_multicast_v4(<span class="kw-2">&</span><span class="self">self</span>, multiaddr: <span class="kw-2">&</span>Ipv4Addr, interface: <span class="kw-2">&</span>Ipv4Addr) -> io::Result<()> { |
| <span class="self">self</span>.inner.leave_multicast_v4(multiaddr, interface) |
| } |
| |
| <span class="doccomment">/// Executes an operation of the `IPV6_DROP_MEMBERSHIP` type. |
| /// |
| /// For more information about this option, see |
| /// [`join_multicast_v6`][link]. |
| /// |
| /// [link]: #method.join_multicast_v6 |
| </span><span class="attribute">#[allow(clippy::trivially_copy_pass_by_ref)] |
| </span><span class="kw">pub fn </span>leave_multicast_v6(<span class="kw-2">&</span><span class="self">self</span>, multiaddr: <span class="kw-2">&</span>Ipv6Addr, interface: u32) -> io::Result<()> { |
| <span class="self">self</span>.inner.leave_multicast_v6(multiaddr, interface) |
| } |
| |
| <span class="doccomment">/// Get the value of the `IPV6_V6ONLY` option on this socket. |
| </span><span class="attribute">#[allow(clippy::trivially_copy_pass_by_ref)] |
| </span><span class="kw">pub fn </span>only_v6(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<bool> { |
| sys::udp::only_v6(<span class="kw-2">&</span><span class="self">self</span>.inner) |
| } |
| |
| <span class="doccomment">/// Get the value of the `SO_ERROR` option on this socket. |
| /// |
| /// This will retrieve the stored error in the underlying socket, clearing |
| /// the field in the process. This can be useful for checking errors between |
| /// calls. |
| </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<<span class="prelude-ty">Option</span><io::Error>> { |
| <span class="self">self</span>.inner.take_error() |
| } |
| |
| <span class="doccomment">/// Execute an I/O operation ensuring that the socket receives more events |
| /// if it hits a [`WouldBlock`] error. |
| /// |
| /// # Notes |
| /// |
| /// This method is required to be called for **all** I/O operations to |
| /// ensure the user will receive events once the socket is ready again after |
| /// returning a [`WouldBlock`] error. |
| /// |
| /// [`WouldBlock`]: io::ErrorKind::WouldBlock |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(unix, doc = <span class="string">"```no_run"</span>)] |
| #[cfg_attr(windows, doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use std::io; |
| /// #[cfg(unix)] |
| /// use std::os::unix::io::AsRawFd; |
| /// #[cfg(windows)] |
| /// use std::os::windows::io::AsRawSocket; |
| /// use mio::net::UdpSocket; |
| /// |
| /// let address = "127.0.0.1:8080".parse().unwrap(); |
| /// let dgram = UdpSocket::bind(address)?; |
| /// |
| /// // Wait until the dgram is readable... |
| /// |
| /// // Read from the dgram using a direct libc call, of course the |
| /// // `io::Read` implementation would be easier to use. |
| /// let mut buf = [0; 512]; |
| /// let n = dgram.try_io(|| { |
| /// let buf_ptr = &mut buf as *mut _ as *mut _; |
| /// #[cfg(unix)] |
| /// let res = unsafe { libc::recv(dgram.as_raw_fd(), buf_ptr, buf.len(), 0) }; |
| /// #[cfg(windows)] |
| /// let res = unsafe { libc::recvfrom(dgram.as_raw_socket() as usize, buf_ptr, buf.len() as i32, 0, std::ptr::null_mut(), std::ptr::null_mut()) }; |
| /// if res != -1 { |
| /// Ok(res as usize) |
| /// } else { |
| /// // If EAGAIN or EWOULDBLOCK is set by libc::recv, the closure |
| /// // should return `WouldBlock` error. |
| /// Err(io::Error::last_os_error()) |
| /// } |
| /// })?; |
| /// eprintln!("read {} bytes", n); |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>try_io<F, T>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> io::Result<T> |
| <span class="kw">where |
| </span>F: FnOnce() -> io::Result<T>, |
| { |
| <span class="self">self</span>.inner.do_io(|<span class="kw">_</span>| f()) |
| } |
| } |
| |
| <span class="kw">impl </span>event::Source <span class="kw">for </span>UdpSocket { |
| <span class="kw">fn </span>register( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| registry: <span class="kw-2">&</span>Registry, |
| token: Token, |
| interests: Interest, |
| ) -> io::Result<()> { |
| <span class="self">self</span>.inner.register(registry, token, interests) |
| } |
| |
| <span class="kw">fn </span>reregister( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| registry: <span class="kw-2">&</span>Registry, |
| token: Token, |
| interests: Interest, |
| ) -> io::Result<()> { |
| <span class="self">self</span>.inner.reregister(registry, token, interests) |
| } |
| |
| <span class="kw">fn </span>deregister(<span class="kw-2">&mut </span><span class="self">self</span>, registry: <span class="kw-2">&</span>Registry) -> io::Result<()> { |
| <span class="self">self</span>.inner.deregister(registry) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>UdpSocket { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="self">self</span>.inner.fmt(f) |
| } |
| } |
| |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>UdpSocket { |
| <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.inner.into_inner().into_raw_fd() |
| } |
| } |
| |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>UdpSocket { |
| <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_raw_fd() |
| } |
| } |
| |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">impl </span>FromRawFd <span class="kw">for </span>UdpSocket { |
| <span class="doccomment">/// Converts a `RawFd` to a `UdpSocket`. |
| /// |
| /// # Notes |
| /// |
| /// The caller is responsible for ensuring that the socket is in |
| /// non-blocking mode. |
| </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -> UdpSocket { |
| UdpSocket::from_std(FromRawFd::from_raw_fd(fd)) |
| } |
| } |
| |
| <span class="attribute">#[cfg(windows)] |
| </span><span class="kw">impl </span>IntoRawSocket <span class="kw">for </span>UdpSocket { |
| <span class="kw">fn </span>into_raw_socket(<span class="self">self</span>) -> RawSocket { |
| <span class="self">self</span>.inner.into_inner().into_raw_socket() |
| } |
| } |
| |
| <span class="attribute">#[cfg(windows)] |
| </span><span class="kw">impl </span>AsRawSocket <span class="kw">for </span>UdpSocket { |
| <span class="kw">fn </span>as_raw_socket(<span class="kw-2">&</span><span class="self">self</span>) -> RawSocket { |
| <span class="self">self</span>.inner.as_raw_socket() |
| } |
| } |
| |
| <span class="attribute">#[cfg(windows)] |
| </span><span class="kw">impl </span>FromRawSocket <span class="kw">for </span>UdpSocket { |
| <span class="doccomment">/// Converts a `RawSocket` to a `UdpSocket`. |
| /// |
| /// # Notes |
| /// |
| /// The caller is responsible for ensuring that the socket is in |
| /// non-blocking mode. |
| </span><span class="kw">unsafe fn </span>from_raw_socket(socket: RawSocket) -> UdpSocket { |
| UdpSocket::from_std(FromRawSocket::from_raw_socket(socket)) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="mio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
