| <!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/io/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">☰</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> |
| </pre><pre class="rust "> |
| <span class="doccomment">//! I/O conveniences when working with primitives in `tokio-core`</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! Contains various combinators to work with I/O objects and type definitions</span> |
| <span class="doccomment">//! as well.</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! A description of the high-level I/O combinators can be [found online] in</span> |
| <span class="doccomment">//! addition to a description of the [low level details].</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! [found online]: https://tokio.rs/docs/getting-started/core/</span> |
| <span class="doccomment">//! [low level details]: https://tokio.rs/docs/going-deeper-tokio/core-low-level/</span> |
| |
| <span class="attribute">#![<span class="ident">deprecated</span>(<span class="ident">note</span> <span class="op">=</span> <span class="string">"moved to the `tokio-io` crate"</span>)]</span> |
| <span class="attribute">#![<span class="ident">allow</span>(<span class="ident">deprecated</span>)]</span> |
| |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; |
| |
| <span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Async</span>, <span class="ident">Poll</span>}; |
| <span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">BoxFuture</span>; |
| <span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">stream</span>::<span class="ident">BoxStream</span>; |
| <span class="kw">use</span> <span class="ident">iovec</span>::<span class="ident">IoVec</span>; |
| |
| <span class="doccomment">/// A convenience typedef around a `Future` whose error component is `io::Error`</span> |
| <span class="kw">pub</span> <span class="kw">type</span> <span class="ident">IoFuture</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="ident">BoxFuture</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span>; |
| |
| <span class="doccomment">/// A convenience typedef around a `Stream` whose error component is `io::Error`</span> |
| <span class="kw">pub</span> <span class="kw">type</span> <span class="ident">IoStream</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="ident">BoxStream</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span>; |
| |
| <span class="doccomment">/// A convenience macro for working with `io::Result<T>` from the `Read` and</span> |
| <span class="doccomment">/// `Write` traits.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This macro takes `io::Result<T>` as input, and returns `T` as the output. If</span> |
| <span class="doccomment">/// the input type is of the `Err` variant, then `Poll::NotReady` is returned if</span> |
| <span class="doccomment">/// it indicates `WouldBlock` or otherwise `Err` is returned.</span> |
| <span class="attribute">#[<span class="ident">macro_export</span>]</span> |
| <span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">try_nb</span> { |
| (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">expr</span>) <span class="op">=></span> (<span class="kw">match</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span> { |
| <span class="prelude-val">Ok</span>(<span class="ident">t</span>) <span class="op">=></span> <span class="ident">t</span>, |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">==</span> ::<span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=></span> { |
| <span class="kw">return</span> <span class="prelude-val">Ok</span>(::<span class="ident">futures</span>::<span class="ident">Async</span>::<span class="ident">NotReady</span>) |
| } |
| <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=></span> <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>.<span class="ident">into</span>()), |
| }) |
| } |
| |
| <span class="kw">mod</span> <span class="ident">copy</span>; |
| <span class="kw">mod</span> <span class="ident">frame</span>; |
| <span class="kw">mod</span> <span class="ident">flush</span>; |
| <span class="kw">mod</span> <span class="ident">read_exact</span>; |
| <span class="kw">mod</span> <span class="ident">read_to_end</span>; |
| <span class="kw">mod</span> <span class="ident">read</span>; |
| <span class="kw">mod</span> <span class="ident">read_until</span>; |
| <span class="kw">mod</span> <span class="ident">split</span>; |
| <span class="kw">mod</span> <span class="ident">window</span>; |
| <span class="kw">mod</span> <span class="ident">write_all</span>; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">copy</span>::{<span class="ident">copy</span>, <span class="ident">Copy</span>}; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">frame</span>::{<span class="ident">EasyBuf</span>, <span class="ident">EasyBufMut</span>, <span class="ident">Framed</span>, <span class="ident">Codec</span>}; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">flush</span>::{<span class="ident">flush</span>, <span class="ident">Flush</span>}; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">read_exact</span>::{<span class="ident">read_exact</span>, <span class="ident">ReadExact</span>}; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">read_to_end</span>::{<span class="ident">read_to_end</span>, <span class="ident">ReadToEnd</span>}; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">read</span>::{<span class="ident">read</span>, <span class="ident">Read</span>}; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">read_until</span>::{<span class="ident">read_until</span>, <span class="ident">ReadUntil</span>}; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">split</span>::{<span class="ident">ReadHalf</span>, <span class="ident">WriteHalf</span>}; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">window</span>::<span class="ident">Window</span>; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">write_all</span>::{<span class="ident">write_all</span>, <span class="ident">WriteAll</span>}; |
| |
| <span class="doccomment">/// A trait for read/write I/O objects</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This trait represents I/O objects which are readable and writable.</span> |
| <span class="doccomment">/// Additionally, they're associated with the ability to test whether they're</span> |
| <span class="doccomment">/// readable or writable.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Importantly, the methods of this trait are intended to be used in conjunction</span> |
| <span class="doccomment">/// with the current task of a future. Namely whenever any of them return a</span> |
| <span class="doccomment">/// value that indicates "would block" the current future's task is arranged to</span> |
| <span class="doccomment">/// receive a notification when the method would otherwise not indicate that it</span> |
| <span class="doccomment">/// would block.</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Io</span>: <span class="ident">io</span>::<span class="ident">Read</span> <span class="op">+</span> <span class="ident">io</span>::<span class="ident">Write</span> { |
| <span class="doccomment">/// Tests to see if this I/O object may be readable.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method returns an `Async<()>` indicating whether the object</span> |
| <span class="doccomment">/// **might** be readable. It is possible that even if this method returns</span> |
| <span class="doccomment">/// `Async::Ready` that a call to `read` would return a `WouldBlock` error.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// There is a default implementation for this function which always</span> |
| <span class="doccomment">/// indicates that an I/O object is readable, but objects which can</span> |
| <span class="doccomment">/// implement a finer grained version of this are recommended to do so.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If this function returns `Async::NotReady` then the current future's</span> |
| <span class="doccomment">/// task is arranged to receive a notification when it might not return</span> |
| <span class="doccomment">/// `NotReady`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method is likely to panic if called from outside the context of a</span> |
| <span class="doccomment">/// future's task.</span> |
| <span class="kw">fn</span> <span class="ident">poll_read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="ident">Async</span>::<span class="ident">Ready</span>(()) |
| } |
| |
| <span class="doccomment">/// Tests to see if this I/O object may be writable.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method returns an `Async<()>` indicating whether the object</span> |
| <span class="doccomment">/// **might** be writable. It is possible that even if this method returns</span> |
| <span class="doccomment">/// `Async::Ready` that a call to `write` would return a `WouldBlock` error.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// There is a default implementation for this function which always</span> |
| <span class="doccomment">/// indicates that an I/O object is writable, but objects which can</span> |
| <span class="doccomment">/// implement a finer grained version of this are recommended to do so.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If this function returns `Async::NotReady` then the current future's</span> |
| <span class="doccomment">/// task is arranged to receive a notification when it might not return</span> |
| <span class="doccomment">/// `NotReady`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method is likely to panic if called from outside the context of a</span> |
| <span class="doccomment">/// future's task.</span> |
| <span class="kw">fn</span> <span class="ident">poll_write</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="ident">Async</span>::<span class="ident">Ready</span>(()) |
| } |
| |
| <span class="doccomment">/// Read in a list of buffers all at once.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This operation will attempt to read bytes from this socket and place</span> |
| <span class="doccomment">/// them into the list of buffers provided. Note that each buffer is an</span> |
| <span class="doccomment">/// `IoVec` which can be created from a byte slice.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The buffers provided will be filled in sequentially. A buffer will be</span> |
| <span class="doccomment">/// entirely filled up before the next is written to.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The number of bytes read is returned, if successful, or an error is</span> |
| <span class="doccomment">/// returned otherwise. If no bytes are available to be read yet then</span> |
| <span class="doccomment">/// a "would block" error is returned. This operation should not block.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// There is a default implementation for this function which treats this</span> |
| <span class="doccomment">/// as a single read using the first buffer in the list, but objects which</span> |
| <span class="doccomment">/// can implement this as an atomic read using all the buffers are</span> |
| <span class="doccomment">/// recommended to do so. For example, `TcpStream` can implement this</span> |
| <span class="doccomment">/// using the `readv` syscall.</span> |
| <span class="kw">fn</span> <span class="ident">read_vec</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">bufs</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">IoVec</span>]) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> { |
| <span class="kw">if</span> <span class="ident">bufs</span>.<span class="ident">is_empty</span>() { |
| <span class="prelude-val">Ok</span>(<span class="number">0</span>) |
| } <span class="kw">else</span> { |
| <span class="self">self</span>.<span class="ident">read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">bufs</span>[<span class="number">0</span>]) |
| } |
| } |
| |
| <span class="doccomment">/// Write a list of buffers all at once.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This operation will attempt to write a list of byte buffers to this</span> |
| <span class="doccomment">/// socket. Note that each buffer is an `IoVec` which can be created from a</span> |
| <span class="doccomment">/// byte slice.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The buffers provided will be written sequentially. A buffer will be</span> |
| <span class="doccomment">/// entirely written before the next is written.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The number of bytes written is returned, if successful, or an error is</span> |
| <span class="doccomment">/// returned otherwise. If the socket is not currently writable then a</span> |
| <span class="doccomment">/// "would block" error is returned. This operation should not block.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// There is a default implementation for this function which writes the</span> |
| <span class="doccomment">/// first buffer only, but objects which can implement this as an atomic</span> |
| <span class="doccomment">/// write using all the buffers are recommended to do so. For example,</span> |
| <span class="doccomment">/// `TcpStream` can implement this using the `writev` syscall.</span> |
| <span class="kw">fn</span> <span class="ident">write_vec</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">bufs</span>: <span class="kw-2">&</span>[<span class="kw-2">&</span><span class="ident">IoVec</span>]) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> { |
| <span class="kw">if</span> <span class="ident">bufs</span>.<span class="ident">is_empty</span>() { |
| <span class="prelude-val">Ok</span>(<span class="number">0</span>) |
| } <span class="kw">else</span> { |
| <span class="self">self</span>.<span class="ident">write</span>(<span class="kw-2">&</span><span class="ident">bufs</span>[<span class="number">0</span>]) |
| } |
| } |
| |
| <span class="doccomment">/// Provides a `Stream` and `Sink` interface for reading and writing to this</span> |
| <span class="doccomment">/// `Io` object, using `Decode` and `Encode` to read and write the raw data.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Raw I/O objects work with byte sequences, but higher-level code usually</span> |
| <span class="doccomment">/// wants to batch these into meaningful chunks, called "frames". This</span> |
| <span class="doccomment">/// method layers framing on top of an I/O object, by using the `Codec`</span> |
| <span class="doccomment">/// traits 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 like gzip or TLS, which require both read and write access to the</span> |
| <span class="doccomment">/// underlying 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 `Framed` returned by this method, which will</span> |
| <span class="doccomment">/// break them into separate objects, allowing them to interact more easily.</span> |
| <span class="kw">fn</span> <span class="ident">framed</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Codec</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">codec</span>: <span class="ident">C</span>) <span class="op">-></span> <span class="ident">Framed</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">C</span><span class="op">></span> |
| <span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>, |
| { |
| <span class="ident">frame</span>::<span class="ident">framed</span>(<span class="self">self</span>, <span class="ident">codec</span>) |
| } |
| |
| <span class="doccomment">/// Helper method for splitting this read/write object into two halves.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The two halves returned implement the `Read` and `Write` traits,</span> |
| <span class="doccomment">/// respectively.</span> |
| <span class="kw">fn</span> <span class="ident">split</span>(<span class="self">self</span>) <span class="op">-></span> (<span class="ident">ReadHalf</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>, <span class="ident">WriteHalf</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>) |
| <span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span> |
| { |
| <span class="ident">split</span>::<span class="ident">split</span>(<span class="self">self</span>) |
| } |
| } |
| |
| <span class="doccomment">/// A trait for framed reading and writing.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Most implementations of `FramedIo` are for doing protocol level</span> |
| <span class="doccomment">/// serialization and deserialization.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Importantly, the methods of this trait are intended to be used in conjunction</span> |
| <span class="doccomment">/// with the current task of a future. Namely whenever any of them return a</span> |
| <span class="doccomment">/// value that indicates "would block" the current future's task is arranged to</span> |
| <span class="doccomment">/// receive a notification when the method would otherwise not indicate that it</span> |
| <span class="doccomment">/// would block.</span> |
| <span class="comment">//</span> |
| <span class="doccomment">/// For a sample implementation of `FramedIo` you can take a look at the</span> |
| <span class="doccomment">/// `Framed` type in the `frame` module of this crate.</span> |
| <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span> |
| <span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">since</span> <span class="op">=</span> <span class="string">"0.1.1"</span>, <span class="ident">note</span> <span class="op">=</span> <span class="string">"replaced by Sink + Stream"</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">FramedIo</span> { |
| <span class="doccomment">/// Messages written</span> |
| <span class="kw">type</span> <span class="ident">In</span>; |
| |
| <span class="doccomment">/// Messages read</span> |
| <span class="kw">type</span> <span class="ident">Out</span>; |
| |
| <span class="doccomment">/// Tests to see if this `FramedIo` may be readable.</span> |
| <span class="kw">fn</span> <span class="ident">poll_read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span>()<span class="op">></span>; |
| |
| <span class="doccomment">/// Read a message frame from the `FramedIo`</span> |
| <span class="kw">fn</span> <span class="ident">read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Out</span>, <span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span>; |
| |
| <span class="doccomment">/// Tests to see if this `FramedIo` may be writable.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Unlike most other calls to poll readiness, it is important that when</span> |
| <span class="doccomment">/// `FramedIo::poll_write` returns `Async::Ready` that a write will</span> |
| <span class="doccomment">/// succeed.</span> |
| <span class="kw">fn</span> <span class="ident">poll_write</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Async</span><span class="op"><</span>()<span class="op">></span>; |
| |
| <span class="doccomment">/// Write a message frame to the `FramedIo`</span> |
| <span class="kw">fn</span> <span class="ident">write</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">req</span>: <span class="self">Self</span>::<span class="ident">In</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span>(), <span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span>; |
| |
| <span class="doccomment">/// Flush pending writes or do any other work not driven by reading /</span> |
| <span class="doccomment">/// writing.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Since the backing source is non-blocking, there is no guarantee that a</span> |
| <span class="doccomment">/// call to `FramedIo::write` is able to write the full message to the</span> |
| <span class="doccomment">/// backing source immediately. In this case, the `FramedIo` will need to</span> |
| <span class="doccomment">/// buffer the remaining data to write. Calls to `FramedIo:flush` attempt</span> |
| <span class="doccomment">/// to write any remaining data in the write buffer to the underlying</span> |
| <span class="doccomment">/// source.</span> |
| <span class="kw">fn</span> <span class="ident">flush</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span>(), <span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span>; |
| } |
| </pre> |
| </section> |
| <section id='search' class="content hidden"></section> |
| |
| <section class="footer"></section> |
| |
| <aside id="help" class="hidden"> |
| <div> |
| <h1 class="hidden">Help</h1> |
| |
| <div class="shortcuts"> |
| <h2>Keyboard Shortcuts</h2> |
| |
| <dl> |
| <dt><kbd>?</kbd></dt> |
| <dd>Show this help dialog</dd> |
| <dt><kbd>S</kbd></dt> |
| <dd>Focus the search field</dd> |
| <dt><kbd>↑</kbd></dt> |
| <dd>Move up in search results</dd> |
| <dt><kbd>↓</kbd></dt> |
| <dd>Move down in search results</dd> |
| <dt><kbd>↹</kbd></dt> |
| <dd>Switch tab</dd> |
| <dt><kbd>⏎</kbd></dt> |
| <dd>Go to active search result</dd> |
| <dt><kbd>+</kbd></dt> |
| <dd>Expand all sections</dd> |
| <dt><kbd>-</kbd></dt> |
| <dd>Collapse all sections</dd> |
| </dl> |
| </div> |
| |
| <div class="infos"> |
| <h2>Search Tricks</h2> |
| |
| <p> |
| Prefix searches with a type followed by a colon (e.g. |
| <code>fn:</code>) to restrict the search to a given type. |
| </p> |
| |
| <p> |
| Accepted types are: <code>fn</code>, <code>mod</code>, |
| <code>struct</code>, <code>enum</code>, |
| <code>trait</code>, <code>type</code>, <code>macro</code>, |
| and <code>const</code>. |
| </p> |
| |
| <p> |
| Search functions by type signature (e.g. |
| <code>vec -> usize</code> or <code>* -> vec</code>) |
| </p> |
| </div> |
| </div> |
| </aside> |
| |
| |
| |
| <script> |
| window.rootPath = "../../../"; |
| window.currentCrate = "tokio_core"; |
| </script> |
| <script src="../../../main.js"></script> |
| <script defer src="../../../search-index.js"></script> |
| </body> |
| </html> |
