src/tokio_core/net/udp/frame.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/frame.rs`.">
     <meta name="keywords" content="rust, rustlang, rust-lang">

     <title>frame.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>
 </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="ident">SocketAddr</span>, <span class="ident">Ipv4Addr</span>, <span class="ident">SocketAddrV4</span>};

 <span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Async</span>, <span class="ident">Poll</span>, <span class="ident">Stream</span>, <span class="ident">Sink</span>, <span class="ident">StartSend</span>, <span class="ident">AsyncSink</span>};

 <span class="kw">use</span> <span class="ident">net</span>::<span class="ident">UdpSocket</span>;

 <span class="doccomment">/// Encoding of frames via buffers.</span>
 <span class="doccomment">///</span>
 <span class="doccomment">/// This trait is used when constructing an instance of `UdpFramed` and provides</span>
 <span class="doccomment">/// the `In` and `Out` types which are decoded and encoded from the socket,</span>
 <span class="doccomment">/// respectively.</span>
 <span class="doccomment">///</span>
 <span class="doccomment">/// Because UDP is a connectionless protocol, the `decode` method receives the</span>
 <span class="doccomment">/// address where data came from and the `encode` method is also responsible for</span>
 <span class="doccomment">/// determining the remote host to which the datagram should be sent</span>
 <span class="doccomment">///</span>
 <span class="doccomment">/// The trait itself is implemented on a type that can track state for decoding</span>
 <span class="doccomment">/// or encoding, which is particularly useful for streaming parsers. In many</span>
 <span class="doccomment">/// cases, though, this type will simply be a unit struct (e.g. `struct</span>
 <span class="doccomment">/// HttpCodec`).</span>
 <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">UdpCodec</span> {
     <span class="doccomment">/// The type of decoded frames.</span>
     <span class="kw">type</span> <span class="ident">In</span>;

     <span class="doccomment">/// The type of frames to be encoded.</span>
     <span class="kw">type</span> <span class="ident">Out</span>;

     <span class="doccomment">/// Attempts to decode a frame from the provided buffer of bytes.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// This method is called by `UdpFramed` on a single datagram which has been</span>
     <span class="doccomment">/// read from a socket. The `buf` argument contains the data that was</span>
     <span class="doccomment">/// received from the remote address, and `src` is the address the data came</span>
     <span class="doccomment">/// from. Note that typically this method should require the entire contents</span>
     <span class="doccomment">/// of `buf` to be valid or otherwise return an error with trailing data.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// Finally, if the bytes in the buffer are malformed then an error is</span>
     <span class="doccomment">/// returned indicating why. This informs `Framed` that the stream is now</span>
     <span class="doccomment">/// corrupt and should be terminated.</span>
     <span class="kw">fn</span> <span class="ident">decode</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">src</span>: <span class="kw-2">&amp;</span><span class="ident">SocketAddr</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="self">Self</span>::<span class="ident">In</span><span class="op">&gt;</span>;

     <span class="doccomment">/// Encodes a frame into the buffer provided.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// This method will encode `msg` into the byte buffer provided by `buf`.</span>
     <span class="doccomment">/// The `buf` provided is an internal buffer of the `Framed` instance and</span>
     <span class="doccomment">/// will be written out when possible.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// The encode method also determines the destination to which the buffer</span>
     <span class="doccomment">/// should be directed, which will be returned as a `SocketAddr`.</span>
     <span class="kw">fn</span> <span class="ident">encode</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="self">Self</span>::<span class="ident">Out</span>, <span class="ident">buf</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>) <span class="op">-&gt;</span> <span class="ident">SocketAddr</span>;
 }

 <span class="doccomment">/// A unified `Stream` and `Sink` interface to an underlying `UdpSocket`, using</span>
 <span class="doccomment">/// the `UdpCodec` trait to encode and decode frames.</span>
 <span class="doccomment">///</span>
 <span class="doccomment">/// You can acquire a `UdpFramed` instance by using the `UdpSocket::framed`</span>
 <span class="doccomment">/// adapter.</span>
 <span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">&quot;sinks do nothing unless polled&quot;</span>]</span>
 <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">UdpFramed</span><span class="op">&lt;</span><span class="ident">C</span><span class="op">&gt;</span> {
     <span class="ident">socket</span>: <span class="ident">UdpSocket</span>,
     <span class="ident">codec</span>: <span class="ident">C</span>,
     <span class="ident">rd</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>,
     <span class="ident">wr</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>,
     <span class="ident">out_addr</span>: <span class="ident">SocketAddr</span>,
     <span class="ident">flushed</span>: <span class="ident">bool</span>,
 }

 <span class="kw">impl</span><span class="op">&lt;</span><span class="ident">C</span>: <span class="ident">UdpCodec</span><span class="op">&gt;</span> <span class="ident">Stream</span> <span class="kw">for</span> <span class="ident">UdpFramed</span><span class="op">&lt;</span><span class="ident">C</span><span class="op">&gt;</span> {
     <span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">C</span>::<span class="ident">In</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="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">C</span>::<span class="ident">In</span><span class="op">&gt;</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="macro">try_nb</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">socket</span>.<span class="ident">recv_from</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">rd</span>));
         <span class="macro">trace</span><span class="macro">!</span>(<span class="string">&quot;received {} bytes, decoding&quot;</span>, <span class="ident">n</span>);
         <span class="kw">let</span> <span class="ident">frame</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">codec</span>.<span class="ident">decode</span>(<span class="kw-2">&amp;</span><span class="ident">addr</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">rd</span>[..<span class="ident">n</span>]));
         <span class="macro">trace</span><span class="macro">!</span>(<span class="string">&quot;frame decoded from buffer&quot;</span>);
         <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="prelude-val">Some</span>(<span class="ident">frame</span>)))
     }
 }

 <span class="kw">impl</span><span class="op">&lt;</span><span class="ident">C</span>: <span class="ident">UdpCodec</span><span class="op">&gt;</span> <span class="ident">Sink</span> <span class="kw">for</span> <span class="ident">UdpFramed</span><span class="op">&lt;</span><span class="ident">C</span><span class="op">&gt;</span> {
     <span class="kw">type</span> <span class="ident">SinkItem</span> <span class="op">=</span> <span class="ident">C</span>::<span class="ident">Out</span>;
     <span class="kw">type</span> <span class="ident">SinkError</span> <span class="op">=</span> <span class="ident">io</span>::<span class="ident">Error</span>;

     <span class="kw">fn</span> <span class="ident">start_send</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">item</span>: <span class="ident">C</span>::<span class="ident">Out</span>) <span class="op">-&gt;</span> <span class="ident">StartSend</span><span class="op">&lt;</span><span class="ident">C</span>::<span class="ident">Out</span>, <span class="ident">io</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
         <span class="macro">trace</span><span class="macro">!</span>(<span class="string">&quot;sending frame&quot;</span>);

         <span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">flushed</span> {
             <span class="kw">match</span> <span class="macro">try</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">poll_complete</span>()) {
                 <span class="ident">Async</span>::<span class="ident">Ready</span>(()) <span class="op">=&gt;</span> {},
                 <span class="ident">Async</span>::<span class="ident">NotReady</span> <span class="op">=&gt;</span> <span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">AsyncSink</span>::<span class="ident">NotReady</span>(<span class="ident">item</span>)),
             }
         }

         <span class="self">self</span>.<span class="ident">out_addr</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">codec</span>.<span class="ident">encode</span>(<span class="ident">item</span>, <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">wr</span>);
         <span class="self">self</span>.<span class="ident">flushed</span> <span class="op">=</span> <span class="bool-val">false</span>;
         <span class="macro">trace</span><span class="macro">!</span>(<span class="string">&quot;frame encoded; length={}&quot;</span>, <span class="self">self</span>.<span class="ident">wr</span>.<span class="ident">len</span>());

         <span class="prelude-val">Ok</span>(<span class="ident">AsyncSink</span>::<span class="ident">Ready</span>)
     }

     <span class="kw">fn</span> <span class="ident">poll_complete</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">io</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
         <span class="kw">if</span> <span class="self">self</span>.<span class="ident">flushed</span> {
             <span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(()))
         }

         <span class="macro">trace</span><span class="macro">!</span>(<span class="string">&quot;flushing frame; length={}&quot;</span>, <span class="self">self</span>.<span class="ident">wr</span>.<span class="ident">len</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="self">self</span>.<span class="ident">socket</span>.<span class="ident">send_to</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">wr</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">out_addr</span>));
         <span class="macro">trace</span><span class="macro">!</span>(<span class="string">&quot;written {}&quot;</span>, <span class="ident">n</span>);

         <span class="kw">let</span> <span class="ident">wrote_all</span> <span class="op">=</span> <span class="ident">n</span> <span class="op">==</span> <span class="self">self</span>.<span class="ident">wr</span>.<span class="ident">len</span>();
         <span class="self">self</span>.<span class="ident">wr</span>.<span class="ident">clear</span>();
         <span class="self">self</span>.<span class="ident">flushed</span> <span class="op">=</span> <span class="bool-val">true</span>;

         <span class="kw">if</span> <span class="ident">wrote_all</span> {
             <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(()))
         } <span class="kw">else</span> {
             <span class="prelude-val">Err</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="string">&quot;failed to write entire datagram to socket&quot;</span>))
         }
     }

     <span class="kw">fn</span> <span class="ident">close</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">io</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
         <span class="macro">try_ready</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">poll_complete</span>());
         <span class="prelude-val">Ok</span>(().<span class="ident">into</span>())
     }
 }

 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op">&lt;</span><span class="ident">C</span>: <span class="ident">UdpCodec</span><span class="op">&gt;</span>(<span class="ident">socket</span>: <span class="ident">UdpSocket</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">UdpFramed</span> {
         <span class="ident">socket</span>: <span class="ident">socket</span>,
         <span class="ident">codec</span>: <span class="ident">codec</span>,
         <span class="ident">out_addr</span>: <span class="ident">SocketAddr</span>::<span class="ident">V4</span>(<span class="ident">SocketAddrV4</span>::<span class="ident">new</span>(<span class="ident">Ipv4Addr</span>::<span class="ident">new</span>(<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>), <span class="number">0</span>)),
         <span class="ident">rd</span>: <span class="macro">vec</span><span class="macro">!</span>[<span class="number">0</span>; <span class="number">64</span> <span class="op">*</span> <span class="number">1024</span>],
         <span class="ident">wr</span>: <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">8</span> <span class="op">*</span> <span class="number">1024</span>),
         <span class="ident">flushed</span>: <span class="bool-val">true</span>,
     }
 }

 <span class="kw">impl</span><span class="op">&lt;</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="doccomment">/// Returns a reference to the underlying I/O stream wrapped by `Framed`.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// Note that care should be taken to not tamper with the underlying stream</span>
     <span class="doccomment">/// of data coming in as it may corrupt the stream of frames otherwise being</span>
     <span class="doccomment">/// worked with.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_ref</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">UdpSocket</span> {
         <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">socket</span>
     }

     <span class="doccomment">/// Returns a mutable reference to the underlying I/O stream wrapped by</span>
     <span class="doccomment">/// `Framed`.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// Note that care should be taken to not tamper with the underlying stream</span>
     <span class="doccomment">/// of data coming in as it may corrupt the stream of frames otherwise being</span>
     <span class="doccomment">/// worked with.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_mut</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="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">UdpSocket</span> {
         <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">socket</span>
     }

     <span class="doccomment">/// Consumes the `Framed`, returning its underlying I/O stream.</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// Note that care should be taken to not tamper with the underlying stream</span>
     <span class="doccomment">/// of data coming in as it may corrupt the stream of frames otherwise being</span>
     <span class="doccomment">/// worked with.</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">UdpSocket</span> {
         <span class="self">self</span>.<span class="ident">socket</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>