diff options
Diffstat (limited to 'src/regex/input.rs.html')
| -rw-r--r-- | src/regex/input.rs.html | 325 |
1 files changed, 325 insertions, 0 deletions
diff --git a/src/regex/input.rs.html b/src/regex/input.rs.html new file mode 100644 index 0000000..dfe5571 --- /dev/null +++ b/src/regex/input.rs.html @@ -0,0 +1,325 @@ +<!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 `/home/travis/.cargo/registry/src/github.com-0a35038f75765ae4/regex-0.1.38/src/input.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>input.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../main.css"> + + <link rel="shortcut icon" href="http://www.rust-lang.org/favicon.ico"> + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <section class="sidebar"> + <a href='../../regex/index.html'><img src='http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='' width='100'></a> + + </section> + + <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 source"><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> +</pre><pre class='rust '> +<span class='comment'>// Copyright 2014-2015 The Rust Project Developers. See the COPYRIGHT</span> +<span class='comment'>// file at the top-level directory of this distribution and at</span> +<span class='comment'>// http://rust-lang.org/COPYRIGHT.</span> +<span class='comment'>//</span> +<span class='comment'>// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span> +<span class='comment'>// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span> +<span class='comment'>// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span> +<span class='comment'>// option. This file may not be copied, modified, or distributed</span> +<span class='comment'>// except according to those terms.</span> + +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ops</span>; + +<span class='kw'>use</span> <span class='ident'>char</span>::<span class='ident'>Char</span>; +<span class='kw'>use</span> <span class='ident'>prefix</span>::<span class='ident'>Prefix</span>; + +<span class='doccomment'>/// Represents a location in the input.</span> +<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Clone</span>, <span class='ident'>Copy</span>, <span class='ident'>Debug</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>InputAt</span> { + <span class='ident'>pos</span>: <span class='ident'>usize</span>, + <span class='ident'>c</span>: <span class='ident'>Char</span>, + <span class='ident'>len</span>: <span class='ident'>usize</span>, +} + +<span class='kw'>impl</span> <span class='ident'>InputAt</span> { + <span class='doccomment'>/// Returns true iff this position is at the beginning of the input.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_beginning</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='self'>self</span>.<span class='ident'>pos</span> <span class='op'>==</span> <span class='number'>0</span> + } + + <span class='doccomment'>/// Returns the character at this position.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// If this position is just before or after the input, then an absent</span> + <span class='doccomment'>/// character is returned.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>char</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Char</span> { + <span class='self'>self</span>.<span class='ident'>c</span> + } + + <span class='doccomment'>/// Returns the UTF-8 width of the character at this position.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>len</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'>len</span> + } + + <span class='doccomment'>/// Returns the byte offset of this position.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>pos</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'>pos</span> + } + + <span class='doccomment'>/// Returns the byte offset of the next position in the input.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>next_pos</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'>pos</span> <span class='op'>+</span> <span class='self'>self</span>.<span class='ident'>len</span> + } +} + +<span class='doccomment'>/// An abstraction over input used in the matching engines.</span> +<span class='kw'>pub</span> <span class='kw'>trait</span> <span class='ident'>Input</span> { + <span class='doccomment'>/// Return an encoding of the position at byte offset `i`.</span> + <span class='kw'>fn</span> <span class='ident'>at</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>i</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='ident'>InputAt</span>; + <span class='doccomment'>/// Return an encoding of the char position just prior to byte offset `i`.</span> + <span class='kw'>fn</span> <span class='ident'>previous_at</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>i</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='ident'>InputAt</span>; + <span class='doccomment'>/// Scan the input for a matching prefix.</span> + <span class='kw'>fn</span> <span class='ident'>prefix_at</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>prefixes</span>: <span class='kw-2'>&</span><span class='ident'>Prefix</span>, <span class='ident'>at</span>: <span class='ident'>InputAt</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>InputAt</span><span class='op'>></span>; +} + +<span class='doccomment'>/// An input reader over characters.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// (This is the only implementation of `Input` at the moment.)</span> +<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Debug</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>CharInput</span><span class='op'><</span><span class='lifetime'>'t</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='lifetime'>'t</span> <span class='ident'>str</span>); + +<span class='kw'>impl</span><span class='op'><</span><span class='lifetime'>'t</span><span class='op'>></span> <span class='ident'>CharInput</span><span class='op'><</span><span class='lifetime'>'t</span><span class='op'>></span> { + <span class='doccomment'>/// Return a new character input reader for the given string.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>(<span class='ident'>s</span>: <span class='kw-2'>&</span><span class='lifetime'>'t</span> <span class='ident'>str</span>) <span class='op'>-></span> <span class='ident'>CharInput</span><span class='op'><</span><span class='lifetime'>'t</span><span class='op'>></span> { + <span class='ident'>CharInput</span>(<span class='ident'>s</span>) + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='lifetime'>'t</span><span class='op'>></span> <span class='ident'>ops</span>::<span class='ident'>Deref</span> <span class='kw'>for</span> <span class='ident'>CharInput</span><span class='op'><</span><span class='lifetime'>'t</span><span class='op'>></span> { + <span class='kw'>type</span> <span class='ident'>Target</span> <span class='op'>=</span> <span class='ident'>str</span>; + + <span class='kw'>fn</span> <span class='ident'>deref</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>str</span> { + <span class='self'>self</span>.<span class='number'>0</span> + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='lifetime'>'t</span><span class='op'>></span> <span class='ident'>Input</span> <span class='kw'>for</span> <span class='ident'>CharInput</span><span class='op'><</span><span class='lifetime'>'t</span><span class='op'>></span> { + <span class='comment'>// This `inline(always)` increases throughput by almost 25% on the `hard`</span> + <span class='comment'>// benchmarks over a normal `inline` annotation.</span> + <span class='comment'>//</span> + <span class='comment'>// I'm not sure why `#[inline]` isn't enough to convince LLVM, but it is</span> + <span class='comment'>// used *a lot* in the guts of the matching engines.</span> + <span class='attribute'>#[<span class='ident'>inline</span>(<span class='ident'>always</span>)]</span> + <span class='kw'>fn</span> <span class='ident'>at</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>i</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='ident'>InputAt</span> { + <span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='self'>self</span>[<span class='ident'>i</span>..].<span class='ident'>chars</span>().<span class='ident'>next</span>().<span class='ident'>into</span>(); + <span class='ident'>InputAt</span> { + <span class='ident'>pos</span>: <span class='ident'>i</span>, + <span class='ident'>c</span>: <span class='ident'>c</span>, + <span class='ident'>len</span>: <span class='ident'>c</span>.<span class='ident'>len_utf8</span>(), + } + } + + <span class='kw'>fn</span> <span class='ident'>previous_at</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>i</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='ident'>InputAt</span> { + <span class='kw'>let</span> <span class='ident'>c</span>: <span class='ident'>Char</span> <span class='op'>=</span> <span class='self'>self</span>[..<span class='ident'>i</span>].<span class='ident'>chars</span>().<span class='ident'>rev</span>().<span class='ident'>next</span>().<span class='ident'>into</span>(); + <span class='kw'>let</span> <span class='ident'>len</span> <span class='op'>=</span> <span class='ident'>c</span>.<span class='ident'>len_utf8</span>(); + <span class='ident'>InputAt</span> { + <span class='ident'>pos</span>: <span class='ident'>i</span> <span class='op'>-</span> <span class='ident'>len</span>, + <span class='ident'>c</span>: <span class='ident'>c</span>, + <span class='ident'>len</span>: <span class='ident'>len</span>, + } + } + + <span class='kw'>fn</span> <span class='ident'>prefix_at</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>prefixes</span>: <span class='kw-2'>&</span><span class='ident'>Prefix</span>, <span class='ident'>at</span>: <span class='ident'>InputAt</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>InputAt</span><span class='op'>></span> { + <span class='ident'>prefixes</span>.<span class='ident'>find</span>(<span class='kw-2'>&</span><span class='self'>self</span>[<span class='ident'>at</span>.<span class='ident'>pos</span>()..]).<span class='ident'>map</span>(<span class='op'>|</span>(<span class='ident'>s</span>, _)<span class='op'>|</span> <span class='self'>self</span>.<span class='ident'>at</span>(<span class='ident'>at</span>.<span class='ident'>pos</span>() <span class='op'>+</span> <span class='ident'>s</span>)) + } +} +</pre> +</section> + <section id='search' class="content hidden"></section> + + <section class="footer"></section> + + <div id="help" class="hidden"> + <div class="shortcuts"> + <h1>Keyboard shortcuts</h1> + <dl> + <dt>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</dd> + </dl> + </div> + <div class="infos"> + <h1>Search tricks</h1> + <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>typedef</code> (or + <code>tdef</code>). + </p> + <p> + Search functions by type signature (e.g. + <code>vec -> usize</code>) + </p> + </div> + </div> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "regex"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script async src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file |