| <!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/read_exact.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>read_exact.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> |
| </pre><pre class="rust "> |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::{<span class="self">self</span>, <span class="ident">Read</span>}; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>; |
| |
| <span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Poll</span>, <span class="ident">Future</span>}; |
| |
| <span class="doccomment">/// A future which can be used to easily read exactly enough bytes to fill</span> |
| <span class="doccomment">/// a buffer.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Created by the [`read_exact`] function.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`read_exact`]: fn.read_exact.html</span> |
| <span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"futures do nothing unless polled"</span>]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ReadExact</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">T</span><span class="op">></span> { |
| <span class="ident">state</span>: <span class="ident">State</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">T</span><span class="op">></span>, |
| } |
| |
| <span class="kw">enum</span> <span class="ident">State</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">T</span><span class="op">></span> { |
| <span class="ident">Reading</span> { |
| <span class="ident">a</span>: <span class="ident">A</span>, |
| <span class="ident">buf</span>: <span class="ident">T</span>, |
| <span class="ident">pos</span>: <span class="ident">usize</span>, |
| }, |
| <span class="ident">Empty</span>, |
| } |
| |
| <span class="doccomment">/// Creates a future which will read exactly enough bytes to fill `buf`,</span> |
| <span class="doccomment">/// returning an error if EOF is hit sooner.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The returned future will resolve to both the I/O stream as well as the</span> |
| <span class="doccomment">/// buffer once the read operation is completed.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// In the case of an error the buffer and the object will be discarded, with</span> |
| <span class="doccomment">/// the error yielded. In the case of success the object will be destroyed and</span> |
| <span class="doccomment">/// the buffer will be returned, with all data read from the stream appended to</span> |
| <span class="doccomment">/// the buffer.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">read_exact</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">T</span><span class="op">></span>(<span class="ident">a</span>: <span class="ident">A</span>, <span class="ident">buf</span>: <span class="ident">T</span>) <span class="op">-></span> <span class="ident">ReadExact</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">T</span><span class="op">></span> |
| <span class="kw">where</span> <span class="ident">A</span>: <span class="ident">Read</span>, |
| <span class="ident">T</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span>, |
| { |
| <span class="ident">ReadExact</span> { |
| <span class="ident">state</span>: <span class="ident">State</span>::<span class="ident">Reading</span> { |
| <span class="ident">a</span>: <span class="ident">a</span>, |
| <span class="ident">buf</span>: <span class="ident">buf</span>, |
| <span class="ident">pos</span>: <span class="number">0</span>, |
| }, |
| } |
| } |
| |
| <span class="kw">fn</span> <span class="ident">eof</span>() <span class="op">-></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">UnexpectedEof</span>, <span class="string">"early eof"</span>) |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">T</span><span class="op">></span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">ReadExact</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">T</span><span class="op">></span> |
| <span class="kw">where</span> <span class="ident">A</span>: <span class="ident">Read</span>, |
| <span class="ident">T</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span>, |
| { |
| <span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> (<span class="ident">A</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">&</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">A</span>, <span class="ident">T</span>), <span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="kw">match</span> <span class="self">self</span>.<span class="ident">state</span> { |
| <span class="ident">State</span>::<span class="ident">Reading</span> { <span class="kw-2">ref</span> <span class="kw-2">mut</span> <span class="ident">a</span>, <span class="kw-2">ref</span> <span class="kw-2">mut</span> <span class="ident">buf</span>, <span class="kw-2">ref</span> <span class="kw-2">mut</span> <span class="ident">pos</span> } <span class="op">=></span> { |
| <span class="kw">let</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">as_mut</span>(); |
| <span class="kw">while</span> <span class="kw-2">*</span><span class="ident">pos</span> <span class="op"><</span> <span class="ident">buf</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="ident">a</span>.<span class="ident">read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>[<span class="kw-2">*</span><span class="ident">pos</span>..])); |
| <span class="kw-2">*</span><span class="ident">pos</span> <span class="op">+=</span> <span class="ident">n</span>; |
| <span class="kw">if</span> <span class="ident">n</span> <span class="op">==</span> <span class="number">0</span> { |
| <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">eof</span>()) |
| } |
| } |
| } |
| <span class="ident">State</span>::<span class="ident">Empty</span> <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"poll a ReadExact after it's done"</span>), |
| } |
| |
| <span class="kw">match</span> <span class="ident">mem</span>::<span class="ident">replace</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">state</span>, <span class="ident">State</span>::<span class="ident">Empty</span>) { |
| <span class="ident">State</span>::<span class="ident">Reading</span> { <span class="ident">a</span>, <span class="ident">buf</span>, .. } <span class="op">=></span> <span class="prelude-val">Ok</span>((<span class="ident">a</span>, <span class="ident">buf</span>).<span class="ident">into</span>()), |
| <span class="ident">State</span>::<span class="ident">Empty</span> <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</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> |
