| <!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/window.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>window.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> |
| </pre><pre class="rust "> |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>; |
| |
| <span class="doccomment">/// A owned window around an underlying buffer.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Normally slices work great for considering sub-portions of a buffer, but</span> |
| <span class="doccomment">/// unfortunately a slice is a *borrowed* type in Rust which has an associated</span> |
| <span class="doccomment">/// lifetime. When working with future and async I/O these lifetimes are not</span> |
| <span class="doccomment">/// always appropriate, and are sometimes difficult to store in tasks. This</span> |
| <span class="doccomment">/// type strives to fill this gap by providing an "owned slice" around an</span> |
| <span class="doccomment">/// underlying buffer of bytes.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// A `Window<T>` wraps an underlying buffer, `T`, and has configurable</span> |
| <span class="doccomment">/// start/end indexes to alter the behavior of the `AsRef<[u8]>` implementation</span> |
| <span class="doccomment">/// that this type carries.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This type can be particularly useful when working with the `write_all`</span> |
| <span class="doccomment">/// combinator in this crate. Data can be sliced via `Window`, consumed by</span> |
| <span class="doccomment">/// `write_all`, and then earned back once the write operation finishes through</span> |
| <span class="doccomment">/// the `into_inner` method on this type.</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Window</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { |
| <span class="ident">inner</span>: <span class="ident">T</span>, |
| <span class="ident">range</span>: <span class="ident">ops</span>::<span class="ident">Range</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>, |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">>></span> <span class="ident">Window</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { |
| <span class="doccomment">/// Creates a new window around the buffer `t` defaulting to the entire</span> |
| <span class="doccomment">/// slice.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Further methods can be called on the returned `Window<T>` to alter the</span> |
| <span class="doccomment">/// window into the data provided.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">t</span>: <span class="ident">T</span>) <span class="op">-></span> <span class="ident">Window</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { |
| <span class="ident">Window</span> { |
| <span class="ident">range</span>: <span class="number">0</span>..<span class="ident">t</span>.<span class="ident">as_ref</span>().<span class="ident">len</span>(), |
| <span class="ident">inner</span>: <span class="ident">t</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Gets a shared reference to the underlying buffer inside of this</span> |
| <span class="doccomment">/// `Window`.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">T</span> { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span> |
| } |
| |
| <span class="doccomment">/// Gets a mutable reference to the underlying buffer inside of this</span> |
| <span class="doccomment">/// `Window`.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">T</span> { |
| <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">inner</span> |
| } |
| |
| <span class="doccomment">/// Consumes this `Window`, returning the underlying buffer.</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">-></span> <span class="ident">T</span> { |
| <span class="self">self</span>.<span class="ident">inner</span> |
| } |
| |
| <span class="doccomment">/// Returns the starting index of this window into the underlying buffer</span> |
| <span class="doccomment">/// `T`.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">start</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="self">self</span>.<span class="ident">range</span>.<span class="ident">start</span> |
| } |
| |
| <span class="doccomment">/// Returns the end index of this window into the underlying buffer</span> |
| <span class="doccomment">/// `T`.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">end</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="self">self</span>.<span class="ident">range</span>.<span class="ident">end</span> |
| } |
| |
| <span class="doccomment">/// Changes the starting index of this window to the index specified.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Returns the windows back to chain multiple calls to this method.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method will panic if `start` is out of bounds for the underlying</span> |
| <span class="doccomment">/// slice or if it comes after the `end` configured in this window.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_start</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">start</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Window</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { |
| <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">start</span> <span class="op"><=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">as_ref</span>().<span class="ident">len</span>()); |
| <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">start</span> <span class="op"><=</span> <span class="self">self</span>.<span class="ident">range</span>.<span class="ident">end</span>); |
| <span class="self">self</span>.<span class="ident">range</span>.<span class="ident">start</span> <span class="op">=</span> <span class="ident">start</span>; |
| <span class="self">self</span> |
| } |
| |
| <span class="doccomment">/// Changes the end index of this window to the index specified.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Returns the windows back to chain multiple calls to this method.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method will panic if `end` is out of bounds for the underlying</span> |
| <span class="doccomment">/// slice or if it comes before the `start` configured in this window.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_end</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">end</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Window</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { |
| <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">end</span> <span class="op"><=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">as_ref</span>().<span class="ident">len</span>()); |
| <span class="macro">assert</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">range</span>.<span class="ident">start</span> <span class="op"><=</span> <span class="ident">end</span>); |
| <span class="self">self</span>.<span class="ident">range</span>.<span class="ident">end</span> <span class="op">=</span> <span class="ident">end</span>; |
| <span class="self">self</span> |
| } |
| |
| <span class="comment">// TODO: how about a generic set() method along the lines of:</span> |
| <span class="comment">//</span> |
| <span class="comment">// buffer.set(..3)</span> |
| <span class="comment">// .set(0..2)</span> |
| <span class="comment">// .set(4..)</span> |
| <span class="comment">//</span> |
| <span class="comment">// etc.</span> |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">>></span> <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span> <span class="kw">for</span> <span class="ident">Window</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { |
| <span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span>[<span class="ident">u8</span>] { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">as_ref</span>()[<span class="self">self</span>.<span class="ident">range</span>.<span class="ident">start</span>..<span class="self">self</span>.<span class="ident">range</span>.<span class="ident">end</span>] |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</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">AsMut</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span> <span class="kw">for</span> <span class="ident">Window</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { |
| <span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">u8</span>] { |
| <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">as_mut</span>()[<span class="self">self</span>.<span class="ident">range</span>.<span class="ident">start</span>..<span class="self">self</span>.<span class="ident">range</span>.<span class="ident">end</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> |
