src/tokio_core/net/udp/mod.rs.html - third_party/tokio-core - Git at Google

 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="rustdoc">
     <meta name="description" content="Source to the Rust file `src/net/udp/mod.rs`.">
     <meta name="keywords" content="rust, rustlang, rust-lang">

     <title>mod.rs.html -- source</title>

     <link rel="stylesheet" type="text/css" href="../../../../normalize.css">
     <link rel="stylesheet" type="text/css" href="../../../../rustdoc.css" id="mainThemeStyle">

     <link rel="stylesheet" type="text/css" href="../../../../dark.css">
     <link rel="stylesheet" type="text/css" href="../../../../main.css" id="themeStyle">
     <script src="../../../../storage.js"></script>


 </head>
 <body class="rustdoc source">
     <!--[if lte IE 8]>
     <div class="warning">
         This old browser is unsupported and will most likely display funky
         things.
     </div>
     <![endif]-->


     <nav class="sidebar">
         <div class="sidebar-menu">&#9776;</div>


     </nav>

     <div class="theme-picker">
         <button id="theme-picker" aria-label="Pick another theme!">
             <img src="../../../../brush.svg" width="18" alt="Pick another theme!">
         </button>
         <div id="theme-choices"></div>
     </div>
     <script src="../../../../theme.js"></script>
     <nav class="sub">
         <form class="search-form js-only">
             <div class="search-container">
                 <input class="search-input" name="search"
                        autocomplete="off"
                        placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
                        type="search">
             </div>
         </form>
     </nav>

     <section id='main' class="content"><pre class="line-numbers"><span id="1">  1</span>
 <span id="2">  2</span>
 <span id="3">  3</span>
 <span id="4">  4</span>
 <span id="5">  5</span>
 <span id="6">  6</span>
 <span id="7">  7</span>
 <span id="8">  8</span>
 <span id="9">  9</span>
 <span id="10"> 10</span>
 <span id="11"> 11</span>
 <span id="12"> 12</span>
 <span id="13"> 13</span>
 <span id="14"> 14</span>
 <span id="15"> 15</span>
 <span id="16"> 16</span>
 <span id="17"> 17</span>
 <span id="18"> 18</span>
 <span id="19"> 19</span>
 <span id="20"> 20</span>
 <span id="21"> 21</span>
 <span id="22"> 22</span>
 <span id="23"> 23</span>
 <span id="24"> 24</span>
 <span id="25"> 25</span>
 <span id="26"> 26</span>
 <span id="27"> 27</span>
 <span id="28"> 28</span>
 <span id="29"> 29</span>
 <span id="30"> 30</span>
 <span id="31"> 31</span>
 <span id="32"> 32</span>
 <span id="33"> 33</span>
 <span id="34"> 34</span>
 <span id="35"> 35</span>
 <span id="36"> 36</span>
 <span id="37"> 37</span>
 <span id="38"> 38</span>
 <span id="39"> 39</span>
 <span id="40"> 40</span>
 <span id="41"> 41</span>
 <span id="42"> 42</span>
 <span id="43"> 43</span>
 <span id="44"> 44</span>
 <span id="45"> 45</span>
 <span id="46"> 46</span>
 <span id="47"> 47</span>
 <span id="48"> 48</span>
 <span id="49"> 49</span>
 <span id="50"> 50</span>
 <span id="51"> 51</span>
 <span id="52"> 52</span>
 <span id="53"> 53</span>
 <span id="54"> 54</span>
 <span id="55"> 55</span>
 <span id="56"> 56</span>
 <span id="57"> 57</span>
 <span id="58"> 58</span>
 <span id="59"> 59</span>
 <span id="60"> 60</span>
 <span id="61"> 61</span>
 <span id="62"> 62</span>
 <span id="63"> 63</span>
 <span id="64"> 64</span>
 <span id="65"> 65</span>
 <span id="66"> 66</span>
 <span id="67"> 67</span>
 <span id="68"> 68</span>
 <span id="69"> 69</span>
 <span id="70"> 70</span>
 <span id="71"> 71</span>
 <span id="72"> 72</span>
 <span id="73"> 73</span>
 <span id="74"> 74</span>
 <span id="75"> 75</span>
 <span id="76"> 76</span>
 <span id="77"> 77</span>
 <span id="78"> 78</span>
 <span id="79"> 79</span>
 <span id="80"> 80</span>
 <span id="81"> 81</span>
 <span id="82"> 82</span>
 <span id="83"> 83</span>
 <span id="84"> 84</span>
 <span id="85"> 85</span>
 <span id="86"> 86</span>
 <span id="87"> 87</span>
 <span id="88"> 88</span>
 <span id="89"> 89</span>
 <span id="90"> 90</span>
 <span id="91"> 91</span>
 <span id="92"> 92</span>
 <span id="93"> 93</span>
 <span id="94"> 94</span>
 <span id="95"> 95</span>
 <span id="96"> 96</span>
 <span id="97"> 97</span>
 <span id="98"> 98</span>
 <span id="99"> 99</span>
 <span id="100">100</span>
 <span id="101">101</span>
 <span id="102">102</span>
 <span id="103">103</span>
 <span id="104">104</span>
 <span id="105">105</span>
 <span id="106">106</span>
 <span id="107">107</span>
 <span id="108">108</span>
 <span id="109">109</span>
 <span id="110">110</span>
 <span id="111">111</span>
 <span id="112">112</span>
 <span id="113">113</span>
 <span id="114">114</span>
 <span id="115">115</span>
 <span id="116">116</span>
 <span id="117">117</span>
 <span id="118">118</span>
 <span id="119">119</span>
 <span id="120">120</span>
 <span id="121">121</span>
 <span id="122">122</span>
 <span id="123">123</span>
 <span id="124">124</span>
 <span id="125">125</span>
 <span id="126">126</span>
 <span id="127">127</span>
 <span id="128">128</span>
 <span id="129">129</span>
 <span id="130">130</span>
 <span id="131">131</span>
 <span id="132">132</span>
 <span id="133">133</span>
 <span id="134">134</span>
 <span id="135">135</span>
 <span id="136">136</span>
 <span id="137">137</span>
 <span id="138">138</span>
 <span id="139">139</span>
 <span id="140">140</span>
 <span id="141">141</span>
 <span id="142">142</span>
 <span id="143">143</span>
 <span id="144">144</span>
 <span id="145">145</span>
 <span id="146">146</span>
 <span id="147">147</span>
 <span id="148">148</span>
 <span id="149">149</span>
 <span id="150">150</span>
 <span id="151">151</span>
 <span id="152">152</span>
 <span id="153">153</span>
 <span id="154">154</span>
 <span id="155">155</span>
 <span id="156">156</span>
 <span id="157">157</span>
 <span id="158">158</span>
 <span id="159">159</span>
 <span id="160">160</span>
 <span id="161">161</span>
 <span id="162">162</span>
 <span id="163">163</span>
 <span id="164">164</span>
 <span id="165">165</span>
 <span id="166">166</span>
 <span id="167">167</span>
 <span id="168">168</span>
 <span id="169">169</span>
 <span id="170">170</span>
 <span id="171">171</span>
 <span id="172">172</span>
 <span id="173">173</span>
 <span id="174">174</span>
 <span id="175">175</span>
 <span id="176">176</span>
 <span id="177">177</span>
 <span id="178">178</span>
 <span id="179">179</span>
 <span id="180">180</span>
 <span id="181">181</span>
 <span id="182">182</span>
 <span id="183">183</span>
 <span id="184">184</span>
 <span id="185">185</span>
 <span id="186">186</span>
 <span id="187">187</span>
 <span id="188">188</span>
 <span id="189">189</span>
 <span id="190">190</span>
 <span id="191">191</span>
 <span id="192">192</span>
 <span id="193">193</span>
 <span id="194">194</span>
 <span id="195">195</span>
 <span id="196">196</span>
 <span id="197">197</span>
 <span id="198">198</span>
 <span id="199">199</span>
 <span id="200">200</span>
 <span id="201">201</span>
 <span id="202">202</span>
 <span id="203">203</span>
 <span id="204">204</span>
 <span id="205">205</span>
 <span id="206">206</span>
 <span id="207">207</span>
 <span id="208">208</span>
 <span id="209">209</span>
 <span id="210">210</span>
 <span id="211">211</span>
 <span id="212">212</span>
 <span id="213">213</span>
 <span id="214">214</span>
 <span id="215">215</span>
 <span id="216">216</span>
 <span id="217">217</span>
 <span id="218">218</span>
 <span id="219">219</span>
 <span id="220">220</span>
 <span id="221">221</span>
 <span id="222">222</span>
 <span id="223">223</span>
 <span id="224">224</span>
 <span id="225">225</span>
 <span id="226">226</span>
 <span id="227">227</span>
 <span id="228">228</span>
 <span id="229">229</span>
 <span id="230">230</span>
 <span id="231">231</span>
 <span id="232">232</span>
 <span id="233">233</span>
 <span id="234">234</span>
 <span id="235">235</span>
 <span id="236">236</span>
 <span id="237">237</span>
 <span id="238">238</span>
 <span id="239">239</span>
 <span id="240">240</span>
 <span id="241">241</span>
 <span id="242">242</span>
 <span id="243">243</span>
 <span id="244">244</span>
 <span id="245">245</span>
 <span id="246">246</span>
 <span id="247">247</span>
 <span id="248">248</span>
 <span id="249">249</span>
 <span id="250">250</span>
 <span id="251">251</span>
 <span id="252">252</span>
 <span id="253">253</span>
 <span id="254">254</span>
 <span id="255">255</span>
 <span id="256">256</span>
 <span id="257">257</span>
 <span id="258">258</span>
 <span id="259">259</span>
 <span id="260">260</span>
 <span id="261">261</span>
 <span id="262">262</span>
 <span id="263">263</span>
 <span id="264">264</span>
 <span id="265">265</span>
 <span id="266">266</span>
 <span id="267">267</span>
 <span id="268">268</span>
 <span id="269">269</span>
 <span id="270">270</span>
 <span id="271">271</span>
 <span id="272">272</span>
 <span id="273">273</span>
 <span id="274">274</span>
 <span id="275">275</span>
 <span id="276">276</span>
 <span id="277">277</span>
 <span id="278">278</span>
 <span id="279">279</span>
 <span id="280">280</span>
 <span id="281">281</span>
 <span id="282">282</span>
 <span id="283">283</span>
 <span id="284">284</span>
 <span id="285">285</span>
 <span id="286">286</span>
 <span id="287">287</span>
 <span id="288">288</span>
 <span id="289">289</span>
 <span id="290">290</span>
 <span id="291">291</span>
 <span id="292">292</span>
 <span id="293">293</span>
 <span id="294">294</span>
 <span id="295">295</span>
 <span id="296">296</span>
 <span id="297">297</span>
 <span id="298">298</span>
 <span id="299">299</span>
 <span id="300">300</span>
 <span id="301">301</span>
 <span id="302">302</span>
 <span id="303">303</span>
 <span id="304">304</span>
 <span id="305">305</span>
 <span id="306">306</span>
 <span id="307">307</span>
 <span id="308">308</span>
 <span id="309">309</span>
 <span id="310">310</span>
 <span id="311">311</span>
 <span id="312">312</span>
 <span id="313">313</span>
 <span id="314">314</span>
 <span id="315">315</span>
 <span id="316">316</span>
 <span id="317">317</span>
 <span id="318">318</span>
 <span id="319">319</span>
 <span id="320">320</span>
 <span id="321">321</span>
 <span id="322">322</span>
 <span id="323">323</span>
 <span id="324">324</span>
 <span id="325">325</span>
 <span id="326">326</span>
 <span id="327">327</span>
 <span id="328">328</span>
 <span id="329">329</span>
 <span id="330">330</span>
 <span id="331">331</span>
 <span id="332">332</span>
 <span id="333">333</span>
 <span id="334">334</span>
 <span id="335">335</span>
 <span id="336">336</span>
 <span id="337">337</span>
 <span id="338">338</span>
 <span id="339">339</span>
 <span id="340">340</span>
 <span id="341">341</span>
 <span id="342">342</span>
 <span id="343">343</span>
 <span id="344">344</span>
 <span id="345">345</span>
 <span id="346">346</span>
 <span id="347">347</span>
 <span id="348">348</span>
 <span id="349">349</span>
 <span id="350">350</span>
 <span id="351">351</span>
 <span id="352">352</span>
 <span id="353">353</span>
 <span id="354">354</span>
 <span id="355">355</span>
 <span id="356">356</span>
 <span id="357">357</span>
 <span id="358">358</span>
 <span id="359">359</span>
 <span id="360">360</span>
 <span id="361">361</span>
 <span id="362">362</span>
 <span id="363">363</span>
 <span id="364">364</span>
 <span id="365">365</span>
 <span id="366">366</span>
 <span id="367">367</span>
 <span id="368">368</span>
 <span id="369">369</span>
 <span id="370">370</span>
 <span id="371">371</span>
 <span id="372">372</span>
 <span id="373">373</span>
 <span id="374">374</span>
 <span id="375">375</span>
 <span id="376">376</span>
 <span id="377">377</span>
 <span id="378">378</span>
 <span id="379">379</span>
 <span id="380">380</span>
 <span id="381">381</span>
 <span id="382">382</span>
 <span id="383">383</span>
 <span id="384">384</span>
 <span id="385">385</span>
 <span id="386">386</span>
 <span id="387">387</span>
 <span id="388">388</span>
 <span id="389">389</span>
 <span id="390">390</span>
 <span id="391">391</span>
 <span id="392">392</span>
 <span id="393">393</span>
 <span id="394">394</span>
 <span id="395">395</span>
 <span id="396">396</span>
 <span id="397">397</span>
 <span id="398">398</span>
 <span id="399">399</span>
 <span id="400">400</span>
 <span id="401">401</span>
 <span id="402">402</span>
 <span id="403">403</span>
 <span id="404">404</span>
 <span id="405">405</span>
 <span id="406">406</span>
 <span id="407">407</span>
 <span id="408">408</span>
 <span id="409">409</span>
 <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>
 </pre><pre class="rust ">
 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">net</span>::{<span class="self">self</span>, <span class="ident">SocketAddr</span>, <span class="ident">Ipv4Addr</span>, <span class="ident">Ipv6Addr</span>};
 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;

 <span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Async</span>, <span class="ident">Future</span>, <span class="ident">Poll</span>};
 <span class="kw">use</span> <span class="ident">mio</span>;

 <span class="kw">use</span> <span class="ident">reactor</span>::{<span class="ident">Handle</span>, <span class="ident">PollEvented</span>};

 <span class="doccomment">/// An I/O object representing a UDP socket.</span>
 <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">UdpSocket</span> {
     <span class="ident">io</span>: <span class="ident">PollEvented</span><span class="op">&lt;</span><span class="ident">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span><span class="op">&gt;</span>,
 }

 <span class="kw">mod</span> <span class="ident">frame</span>;
 <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">frame</span>::{<span class="ident">UdpFramed</span>, <span class="ident">UdpCodec</span>};

 <span class="kw">impl</span> <span class="ident">UdpSocket</span> {
     <span class="doccomment">/// Create a new UDP socket bound to the specified address.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// This function will create a new UDP socket and attempt to bind it to the</span>
     <span class="doccomment">/// `addr` provided. If the result is `Ok`, the socket has successfully bound.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">bind</span>(<span class="ident">addr</span>: <span class="kw-2">&amp;</span><span class="ident">SocketAddr</span>, <span class="ident">handle</span>: <span class="kw-2">&amp;</span><span class="ident">Handle</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">UdpSocket</span><span class="op">&gt;</span> {
         <span class="kw">let</span> <span class="ident">udp</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="ident">addr</span>));
         <span class="ident">UdpSocket</span>::<span class="ident">new</span>(<span class="ident">udp</span>, <span class="ident">handle</span>)
     }

     <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">socket</span>: <span class="ident">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>, <span class="ident">handle</span>: <span class="kw-2">&amp;</span><span class="ident">Handle</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">UdpSocket</span><span class="op">&gt;</span> {
         <span class="kw">let</span> <span class="ident">io</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">PollEvented</span>::<span class="ident">new</span>(<span class="ident">socket</span>, <span class="ident">handle</span>));
         <span class="prelude-val">Ok</span>(<span class="ident">UdpSocket</span> { <span class="ident">io</span>: <span class="ident">io</span> })
     }

     <span class="doccomment">/// Creates a new `UdpSocket` from the previously bound socket provided.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// The socket given will be registered with the event loop that `handle` is</span>
     <span class="doccomment">/// associated with. This function requires that `socket` has previously</span>
     <span class="doccomment">/// been bound to an address to work correctly.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// This can be used in conjunction with net2&#39;s `UdpBuilder` interface to</span>
     <span class="doccomment">/// configure a socket before it&#39;s handed off, such as setting options like</span>
     <span class="doccomment">/// `reuse_address` or binding to multiple addresses.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_socket</span>(<span class="ident">socket</span>: <span class="ident">net</span>::<span class="ident">UdpSocket</span>,
                        <span class="ident">handle</span>: <span class="kw-2">&amp;</span><span class="ident">Handle</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">UdpSocket</span><span class="op">&gt;</span> {
         <span class="kw">let</span> <span class="ident">udp</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>::<span class="ident">from_socket</span>(<span class="ident">socket</span>));
         <span class="ident">UdpSocket</span>::<span class="ident">new</span>(<span class="ident">udp</span>, <span class="ident">handle</span>)
     }

     <span class="doccomment">/// Provides a `Stream` and `Sink` interface for reading and writing to this</span>
     <span class="doccomment">/// `UdpSocket` object, using the provided `UdpCodec` to read and write the</span>
     <span class="doccomment">/// raw data.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// Raw UDP sockets work with datagrams, but higher-level code usually</span>
     <span class="doccomment">/// wants to batch these into meaningful chunks, called &quot;frames&quot;. This</span>
     <span class="doccomment">/// method layers framing on top of this socket by using the `UdpCodec`</span>
     <span class="doccomment">/// trait to handle encoding and decoding of messages frames. Note that</span>
     <span class="doccomment">/// the incoming and outgoing frame types may be distinct.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// This function returns a *single* object that is both `Stream` and</span>
     <span class="doccomment">/// `Sink`; grouping this into a single object is often useful for layering</span>
     <span class="doccomment">/// things which require both read and write access to the underlying</span>
     <span class="doccomment">/// object.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// If you want to work more directly with the streams and sink, consider</span>
     <span class="doccomment">/// calling `split` on the `UdpFramed` returned by this method, which will</span>
     <span class="doccomment">/// break them into separate objects, allowing them to interact more</span>
     <span class="doccomment">/// easily.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">framed</span><span class="op">&lt;</span><span class="ident">C</span>: <span class="ident">UdpCodec</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">codec</span>: <span class="ident">C</span>) <span class="op">-&gt;</span> <span class="ident">UdpFramed</span><span class="op">&lt;</span><span class="ident">C</span><span class="op">&gt;</span> {
         <span class="ident">frame</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">codec</span>)
     }

     <span class="doccomment">/// Returns the local address that this stream is bound to.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">local_addr</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">SocketAddr</span><span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">local_addr</span>()
     }

     <span class="doccomment">/// Connects the UDP socket setting the default destination for send() and</span>
     <span class="doccomment">/// limiting packets that are read via recv from the address specified in addr.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">connect</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">addr</span>: <span class="kw-2">&amp;</span><span class="ident">SocketAddr</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">connect</span>(<span class="kw-2">*</span><span class="ident">addr</span>)
     }

     <span class="doccomment">/// Sends data on the socket to the address previously bound via connect().</span>
     <span class="doccomment">/// On success, returns the number of bytes written.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">send</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>]) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">usize</span><span class="op">&gt;</span> {
         <span class="kw">if</span> <span class="kw">let</span> <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">poll_write</span>() {
             <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>.<span class="ident">into</span>())
         }
         <span class="kw">match</span> <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">send</span>(<span class="ident">buf</span>) {
             <span class="prelude-val">Ok</span>(<span class="ident">n</span>) <span class="op">=&gt;</span> <span class="prelude-val">Ok</span>(<span class="ident">n</span>),
             <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=&gt;</span> {
                 <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">==</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> {
                     <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">need_write</span>();
                 }
                 <span class="prelude-val">Err</span>(<span class="ident">e</span>)
             }
         }
     }

     <span class="doccomment">/// Receives data from the socket previously bound with connect().</span>
     <span class="doccomment">/// On success, returns the number of bytes read.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">recv</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">u8</span>]) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">usize</span><span class="op">&gt;</span> {
         <span class="kw">if</span> <span class="kw">let</span> <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">poll_read</span>() {
             <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>.<span class="ident">into</span>())
         }
         <span class="kw">match</span> <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">recv</span>(<span class="ident">buf</span>) {
             <span class="prelude-val">Ok</span>(<span class="ident">n</span>) <span class="op">=&gt;</span> <span class="prelude-val">Ok</span>(<span class="ident">n</span>),
             <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=&gt;</span> {
                 <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">==</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> {
                     <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">need_read</span>();
                 }
                 <span class="prelude-val">Err</span>(<span class="ident">e</span>)
             }
         }
     }

     <span class="doccomment">/// Test whether this socket is ready to be read or not.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// If the socket is *not* readable then the current task is scheduled to</span>
     <span class="doccomment">/// get a notification when the socket does become readable. That is, this</span>
     <span class="doccomment">/// is only suitable for calling in a `Future::poll` method and will</span>
     <span class="doccomment">/// automatically handle ensuring a retry once the socket is readable again.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">poll_read</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Async</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">poll_read</span>()
     }

     <span class="doccomment">/// Test whether this socket is ready to be written to or not.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// If the socket is *not* writable then the current task is scheduled to</span>
     <span class="doccomment">/// get a notification when the socket does become writable. That is, this</span>
     <span class="doccomment">/// is only suitable for calling in a `Future::poll` method and will</span>
     <span class="doccomment">/// automatically handle ensuring a retry once the socket is writable again.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">poll_write</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Async</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">poll_write</span>()
     }

     <span class="doccomment">/// Sends data on the socket to the given address. On success, returns the</span>
     <span class="doccomment">/// number of bytes written.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// Address type can be any implementer of `ToSocketAddrs` trait. See its</span>
     <span class="doccomment">/// documentation for concrete examples.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">send_to</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>], <span class="ident">target</span>: <span class="kw-2">&amp;</span><span class="ident">SocketAddr</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">usize</span><span class="op">&gt;</span> {
         <span class="kw">if</span> <span class="kw">let</span> <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">poll_write</span>() {
             <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>.<span class="ident">into</span>())
         }
         <span class="kw">match</span> <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">send_to</span>(<span class="ident">buf</span>, <span class="ident">target</span>) {
             <span class="prelude-val">Ok</span>(<span class="ident">n</span>) <span class="op">=&gt;</span> <span class="prelude-val">Ok</span>(<span class="ident">n</span>),
             <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=&gt;</span> {
                 <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">==</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> {
                     <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">need_write</span>();
                 }
                 <span class="prelude-val">Err</span>(<span class="ident">e</span>)
             }
         }
     }

     <span class="doccomment">/// Creates a future that will write the entire contents of the buffer</span>
     <span class="doccomment">/// `buf` provided as a datagram to this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// The returned future will return after data has been written to the</span>
     <span class="doccomment">/// outbound socket.  The future will resolve to the stream as well as the</span>
     <span class="doccomment">/// buffer (for reuse if needed).</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// Any error which happens during writing will cause both the stream and</span>
     <span class="doccomment">/// the buffer to get destroyed. Note that failure to write the entire</span>
     <span class="doccomment">/// buffer is considered an error for the purposes of sending a datagram.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// The `buf` parameter here only requires the `AsRef&lt;[u8]&gt;` trait, which</span>
     <span class="doccomment">/// should be broadly applicable to accepting data which can be converted</span>
     <span class="doccomment">/// to a slice.  The `Window` struct is also available in this crate to</span>
     <span class="doccomment">/// provide a different window into a slice if necessary.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">send_dgram</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">buf</span>: <span class="ident">T</span>, <span class="ident">addr</span>: <span class="ident">SocketAddr</span>) <span class="op">-&gt;</span> <span class="ident">SendDgram</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>
         <span class="kw">where</span> <span class="ident">T</span>: <span class="ident">AsRef</span><span class="op">&lt;</span>[<span class="ident">u8</span>]<span class="op">&gt;</span>,
     {
         <span class="ident">SendDgram</span>(<span class="prelude-val">Some</span>((<span class="self">self</span>, <span class="ident">buf</span>, <span class="ident">addr</span>)))
     }

     <span class="doccomment">/// Receives data from the socket. On success, returns the number of bytes</span>
     <span class="doccomment">/// read and the address from whence the data came.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">recv_from</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">u8</span>]) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>(<span class="ident">usize</span>, <span class="ident">SocketAddr</span>)<span class="op">&gt;</span> {
         <span class="kw">if</span> <span class="kw">let</span> <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">poll_read</span>() {
             <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span>.<span class="ident">into</span>())
         }
         <span class="kw">match</span> <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">recv_from</span>(<span class="ident">buf</span>) {
             <span class="prelude-val">Ok</span>(<span class="ident">n</span>) <span class="op">=&gt;</span> <span class="prelude-val">Ok</span>(<span class="ident">n</span>),
             <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=&gt;</span> {
                 <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">==</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> {
                     <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">need_read</span>();
                 }
                 <span class="prelude-val">Err</span>(<span class="ident">e</span>)
             }
         }
     }

     <span class="doccomment">/// Creates a future that receive a datagram to be written to the buffer</span>
     <span class="doccomment">/// provided.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// The returned future will return after a datagram has been received on</span>
     <span class="doccomment">/// this socket. The future will resolve to the socket, the buffer, the</span>
     <span class="doccomment">/// amount of data read, and the address the data was received from.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// An error during reading will cause the socket and buffer to get</span>
     <span class="doccomment">/// destroyed and the socket will be returned.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// The `buf` parameter here only requires the `AsMut&lt;[u8]&gt;` trait, which</span>
     <span class="doccomment">/// should be broadly applicable to accepting data which can be converted</span>
     <span class="doccomment">/// to a slice.  The `Window` struct is also available in this crate to</span>
     <span class="doccomment">/// provide a different window into a slice if necessary.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">recv_dgram</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">buf</span>: <span class="ident">T</span>) <span class="op">-&gt;</span> <span class="ident">RecvDgram</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>
         <span class="kw">where</span> <span class="ident">T</span>: <span class="ident">AsMut</span><span class="op">&lt;</span>[<span class="ident">u8</span>]<span class="op">&gt;</span>,
     {
         <span class="ident">RecvDgram</span>(<span class="prelude-val">Some</span>((<span class="self">self</span>, <span class="ident">buf</span>)))
     }

     <span class="doccomment">/// Gets the value of the `SO_BROADCAST` option for this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// For more information about this option, see</span>
     <span class="doccomment">/// [`set_broadcast`][link].</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// [link]: #method.set_broadcast</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">broadcast</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">bool</span><span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">broadcast</span>()
     }

     <span class="doccomment">/// Sets the value of the `SO_BROADCAST` option for this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// When enabled, this socket is allowed to send packets to a broadcast</span>
     <span class="doccomment">/// address.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_broadcast</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">on</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">set_broadcast</span>(<span class="ident">on</span>)
     }

     <span class="doccomment">/// Gets the value of the `IP_MULTICAST_LOOP` option for this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// For more information about this option, see</span>
     <span class="doccomment">/// [`set_multicast_loop_v4`][link].</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// [link]: #method.set_multicast_loop_v4</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">multicast_loop_v4</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">bool</span><span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">multicast_loop_v4</span>()
     }

     <span class="doccomment">/// Sets the value of the `IP_MULTICAST_LOOP` option for this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// If enabled, multicast packets will be looped back to the local socket.</span>
     <span class="doccomment">/// Note that this may not have any affect on IPv6 sockets.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_multicast_loop_v4</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">on</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">set_multicast_loop_v4</span>(<span class="ident">on</span>)
     }

     <span class="doccomment">/// Gets the value of the `IP_MULTICAST_TTL` option for this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// For more information about this option, see</span>
     <span class="doccomment">/// [`set_multicast_ttl_v4`][link].</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// [link]: #method.set_multicast_ttl_v4</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">multicast_ttl_v4</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">multicast_ttl_v4</span>()
     }

     <span class="doccomment">/// Sets the value of the `IP_MULTICAST_TTL` option for this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// Indicates the time-to-live value of outgoing multicast packets for</span>
     <span class="doccomment">/// this socket. The default value is 1 which means that multicast packets</span>
     <span class="doccomment">/// don&#39;t leave the local network unless explicitly requested.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// Note that this may not have any affect on IPv6 sockets.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_multicast_ttl_v4</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">ttl</span>: <span class="ident">u32</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">set_multicast_ttl_v4</span>(<span class="ident">ttl</span>)
     }

     <span class="doccomment">/// Gets the value of the `IPV6_MULTICAST_LOOP` option for this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// For more information about this option, see</span>
     <span class="doccomment">/// [`set_multicast_loop_v6`][link].</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// [link]: #method.set_multicast_loop_v6</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">multicast_loop_v6</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">bool</span><span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">multicast_loop_v6</span>()
     }

     <span class="doccomment">/// Sets the value of the `IPV6_MULTICAST_LOOP` option for this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// Controls whether this socket sees the multicast packets it sends itself.</span>
     <span class="doccomment">/// Note that this may not have any affect on IPv4 sockets.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_multicast_loop_v6</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">on</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">set_multicast_loop_v6</span>(<span class="ident">on</span>)
     }

     <span class="doccomment">/// Gets the value of the `IP_TTL` option for this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// For more information about this option, see [`set_ttl`][link].</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// [link]: #method.set_ttl</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ttl</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">ttl</span>()
     }

     <span class="doccomment">/// Sets the value for the `IP_TTL` option on this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// This value sets the time-to-live field that is used in every packet sent</span>
     <span class="doccomment">/// from this socket.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_ttl</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">ttl</span>: <span class="ident">u32</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">set_ttl</span>(<span class="ident">ttl</span>)
     }

     <span class="doccomment">/// Executes an operation of the `IP_ADD_MEMBERSHIP` type.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// This function specifies a new multicast group for this socket to join.</span>
     <span class="doccomment">/// The address must be a valid multicast address, and `interface` is the</span>
     <span class="doccomment">/// address of the local interface with which the system should join the</span>
     <span class="doccomment">/// multicast group. If it&#39;s equal to `INADDR_ANY` then an appropriate</span>
     <span class="doccomment">/// interface is chosen by the system.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">join_multicast_v4</span>(<span class="kw-2">&amp;</span><span class="self">self</span>,
                              <span class="ident">multiaddr</span>: <span class="kw-2">&amp;</span><span class="ident">Ipv4Addr</span>,
                              <span class="ident">interface</span>: <span class="kw-2">&amp;</span><span class="ident">Ipv4Addr</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">join_multicast_v4</span>(<span class="ident">multiaddr</span>, <span class="ident">interface</span>)
     }

     <span class="doccomment">/// Executes an operation of the `IPV6_ADD_MEMBERSHIP` type.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// This function specifies a new multicast group for this socket to join.</span>
     <span class="doccomment">/// The address must be a valid multicast address, and `interface` is the</span>
     <span class="doccomment">/// index of the interface to join/leave (or 0 to indicate any interface).</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">join_multicast_v6</span>(<span class="kw-2">&amp;</span><span class="self">self</span>,
                              <span class="ident">multiaddr</span>: <span class="kw-2">&amp;</span><span class="ident">Ipv6Addr</span>,
                              <span class="ident">interface</span>: <span class="ident">u32</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">join_multicast_v6</span>(<span class="ident">multiaddr</span>, <span class="ident">interface</span>)
     }

     <span class="doccomment">/// Executes an operation of the `IP_DROP_MEMBERSHIP` type.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// For more information about this option, see</span>
     <span class="doccomment">/// [`join_multicast_v4`][link].</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// [link]: #method.join_multicast_v4</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">leave_multicast_v4</span>(<span class="kw-2">&amp;</span><span class="self">self</span>,
                               <span class="ident">multiaddr</span>: <span class="kw-2">&amp;</span><span class="ident">Ipv4Addr</span>,
                               <span class="ident">interface</span>: <span class="kw-2">&amp;</span><span class="ident">Ipv4Addr</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">leave_multicast_v4</span>(<span class="ident">multiaddr</span>, <span class="ident">interface</span>)
     }

     <span class="doccomment">/// Executes an operation of the `IPV6_DROP_MEMBERSHIP` type.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// For more information about this option, see</span>
     <span class="doccomment">/// [`join_multicast_v6`][link].</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// [link]: #method.join_multicast_v6</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">leave_multicast_v6</span>(<span class="kw-2">&amp;</span><span class="self">self</span>,
                               <span class="ident">multiaddr</span>: <span class="kw-2">&amp;</span><span class="ident">Ipv6Addr</span>,
                               <span class="ident">interface</span>: <span class="ident">u32</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">leave_multicast_v6</span>(<span class="ident">multiaddr</span>, <span class="ident">interface</span>)
     }

     <span class="doccomment">/// Sets the value for the `IPV6_V6ONLY` option on this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// If this is set to `true` then the socket is restricted to sending and</span>
     <span class="doccomment">/// receiving IPv6 packets only. In this case two IPv4 and IPv6 applications</span>
     <span class="doccomment">/// can bind the same port at the same time.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// If this is set to `false` then the socket can be used to send and</span>
     <span class="doccomment">/// receive packets from an IPv4-mapped IPv6 address.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_only_v6</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">only_v6</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">set_only_v6</span>(<span class="ident">only_v6</span>)
     }

     <span class="doccomment">/// Gets the value of the `IPV6_V6ONLY` option for this socket.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// For more information about this option, see [`set_only_v6`][link].</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// [link]: #method.set_only_v6</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">only_v6</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">bool</span><span class="op">&gt;</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">only_v6</span>()
     }
 }

 <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">UdpSocket</span> {
     <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-&gt;</span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
         <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">fmt</span>(<span class="ident">f</span>)
     }
 }

 <span class="doccomment">/// A future used to write the entire contents of some data to a UDP socket.</span>
 <span class="doccomment">///</span>
 <span class="doccomment">/// This is created by the `UdpSocket::send_dgram` method.</span>
 <span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">&quot;futures do nothing unless polled&quot;</span>]</span>
 <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">SendDgram</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="prelude-ty">Option</span><span class="op">&lt;</span>(<span class="ident">UdpSocket</span>, <span class="ident">T</span>, <span class="ident">SocketAddr</span>)<span class="op">&gt;</span>);

 <span class="kw">fn</span> <span class="ident">incomplete_write</span>(<span class="ident">reason</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="ident">Error</span> {
     <span class="ident">io</span>::<span class="ident">Error</span>::<span class="ident">new</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">Other</span>, <span class="ident">reason</span>)
 }

 <span class="kw">impl</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">SendDgram</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>
     <span class="kw">where</span> <span class="ident">T</span>: <span class="ident">AsRef</span><span class="op">&lt;</span>[<span class="ident">u8</span>]<span class="op">&gt;</span>,
 {
     <span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> (<span class="ident">UdpSocket</span>, <span class="ident">T</span>);
     <span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">io</span>::<span class="ident">Error</span>;

     <span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Poll</span><span class="op">&lt;</span>(<span class="ident">UdpSocket</span>, <span class="ident">T</span>), <span class="ident">io</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
         {
             <span class="kw">let</span> (<span class="kw-2">ref</span> <span class="ident">sock</span>, <span class="kw-2">ref</span> <span class="ident">buf</span>, <span class="kw-2">ref</span> <span class="ident">addr</span>) <span class="op">=</span>
                 <span class="kw-2">*</span><span class="self">self</span>.<span class="number">0</span>.<span class="ident">as_ref</span>().<span class="ident">expect</span>(<span class="string">&quot;SendDgram polled after completion&quot;</span>);
             <span class="kw">let</span> <span class="ident">n</span> <span class="op">=</span> <span class="macro">try_nb</span><span class="macro">!</span>(<span class="ident">sock</span>.<span class="ident">send_to</span>(<span class="ident">buf</span>.<span class="ident">as_ref</span>(), <span class="ident">addr</span>));
             <span class="kw">if</span> <span class="ident">n</span> <span class="op">!=</span> <span class="ident">buf</span>.<span class="ident">as_ref</span>().<span class="ident">len</span>() {
                 <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">incomplete_write</span>(<span class="string">&quot;failed to send entire message \
                                              in datagram&quot;</span>))
             }
         }

         <span class="kw">let</span> (<span class="ident">sock</span>, <span class="ident">buf</span>, <span class="ident">_addr</span>) <span class="op">=</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">take</span>().<span class="ident">unwrap</span>();
         <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>((<span class="ident">sock</span>, <span class="ident">buf</span>)))
     }
 }

 <span class="doccomment">/// A future used to receive a datagram from a UDP socket.</span>
 <span class="doccomment">///</span>
 <span class="doccomment">/// This is created by the `UdpSocket::recv_dgram` method.</span>
 <span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">&quot;futures do nothing unless polled&quot;</span>]</span>
 <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">RecvDgram</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="prelude-ty">Option</span><span class="op">&lt;</span>(<span class="ident">UdpSocket</span>, <span class="ident">T</span>)<span class="op">&gt;</span>);

 <span class="kw">impl</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">RecvDgram</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>
     <span class="kw">where</span> <span class="ident">T</span>: <span class="ident">AsMut</span><span class="op">&lt;</span>[<span class="ident">u8</span>]<span class="op">&gt;</span>,
 {
     <span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> (<span class="ident">UdpSocket</span>, <span class="ident">T</span>, <span class="ident">usize</span>, <span class="ident">SocketAddr</span>);
     <span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">io</span>::<span class="ident">Error</span>;

     <span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Poll</span><span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="ident">io</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
         <span class="kw">let</span> (<span class="ident">n</span>, <span class="ident">addr</span>) <span class="op">=</span> {
             <span class="kw">let</span> (<span class="kw-2">ref</span> <span class="ident">socket</span>, <span class="kw-2">ref</span> <span class="kw-2">mut</span> <span class="ident">buf</span>) <span class="op">=</span>
                 <span class="kw-2">*</span><span class="self">self</span>.<span class="number">0</span>.<span class="ident">as_mut</span>().<span class="ident">expect</span>(<span class="string">&quot;RecvDgram polled after completion&quot;</span>);

             <span class="macro">try_nb</span><span class="macro">!</span>(<span class="ident">socket</span>.<span class="ident">recv_from</span>(<span class="ident">buf</span>.<span class="ident">as_mut</span>()))
         };

         <span class="kw">let</span> (<span class="ident">socket</span>, <span class="ident">buf</span>) <span class="op">=</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">take</span>().<span class="ident">unwrap</span>();
         <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>((<span class="ident">socket</span>, <span class="ident">buf</span>, <span class="ident">n</span>, <span class="ident">addr</span>)))
     }
 }

 <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">unix</span>, <span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;fuchsia&quot;</span>)))]</span>
 <span class="kw">mod</span> <span class="ident">sys</span> {
     <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
     <span class="kw">use</span> <span class="kw">super</span>::<span class="ident">UdpSocket</span>;

     <span class="kw">impl</span> <span class="ident">AsRawFd</span> <span class="kw">for</span> <span class="ident">UdpSocket</span> {
         <span class="kw">fn</span> <span class="ident">as_raw_fd</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">RawFd</span> {
             <span class="self">self</span>.<span class="ident">io</span>.<span class="ident">get_ref</span>().<span class="ident">as_raw_fd</span>()
         }
     }
 }

 <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
 <span class="kw">mod</span> <span class="ident">sys</span> {
     <span class="comment">// TODO: let&#39;s land these upstream with mio and then we can add them here.</span>
     <span class="comment">//</span>
     <span class="comment">// use std::os::windows::prelude::*;</span>
     <span class="comment">// use super::UdpSocket;</span>
     <span class="comment">//</span>
     <span class="comment">// impl AsRawHandle for UdpSocket {</span>
     <span class="comment">//     fn as_raw_handle(&amp;self) -&gt; RawHandle {</span>
     <span class="comment">//         self.io.get_ref().as_raw_handle()</span>
     <span class="comment">//     }</span>
     <span class="comment">// }</span>
 }
 </pre>
 </section>
     <section id='search' class="content hidden"></section>

     <section class="footer"></section>

     <aside id="help" class="hidden">
         <div>
             <h1 class="hidden">Help</h1>

             <div class="shortcuts">
                 <h2>Keyboard Shortcuts</h2>

                 <dl>
                     <dt><kbd>?</kbd></dt>
                     <dd>Show this help dialog</dd>
                     <dt><kbd>S</kbd></dt>
                     <dd>Focus the search field</dd>
                     <dt><kbd>↑</kbd></dt>
                     <dd>Move up in search results</dd>
                     <dt><kbd>↓</kbd></dt>
                     <dd>Move down in search results</dd>
                     <dt><kbd>↹</kbd></dt>
                     <dd>Switch tab</dd>
                     <dt><kbd>&#9166;</kbd></dt>
                     <dd>Go to active search result</dd>
                     <dt><kbd>+</kbd></dt>
                     <dd>Expand all sections</dd>
                     <dt><kbd>-</kbd></dt>
                     <dd>Collapse all sections</dd>
                 </dl>
             </div>

             <div class="infos">
                 <h2>Search Tricks</h2>

                 <p>
                     Prefix searches with a type followed by a colon (e.g.
                     <code>fn:</code>) to restrict the search to a given type.
                 </p>

                 <p>
                     Accepted types are: <code>fn</code>, <code>mod</code>,
                     <code>struct</code>, <code>enum</code>,
                     <code>trait</code>, <code>type</code>, <code>macro</code>,
                     and <code>const</code>.
                 </p>

                 <p>
                     Search functions by type signature (e.g.
                     <code>vec -> usize</code> or <code>* -> vec</code>)
                 </p>
             </div>
         </div>
     </aside>


     <script>
         window.rootPath = "../../../../";
         window.currentCrate = "tokio_core";
     </script>
     <script src="../../../../main.js"></script>
     <script defer src="../../../../search-index.js"></script>
 </body>
 </html>