diff options
Diffstat (limited to 'src/memchr/lib.rs.html')
| -rw-r--r-- | src/memchr/lib.rs.html | 287 |
1 files changed, 287 insertions, 0 deletions
diff --git a/src/memchr/lib.rs.html b/src/memchr/lib.rs.html new file mode 100644 index 0000000..0e3568c --- /dev/null +++ b/src/memchr/lib.rs.html @@ -0,0 +1,287 @@ +<!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/memchr-0.1.3/src/lib.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>lib.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + +</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"> + + + </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> +</pre><pre class='rust '> +<span class='doccomment'>/*! +This crate defines a single function, `memchr`, which exposes a safe interface +to the corresponding function in `libc`. +*/</span> + +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>deny</span>(<span class='ident'>missing_docs</span>)]</span> + +<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>libc</span>; + +<span class='kw'>use</span> <span class='ident'>libc</span>::<span class='ident'>funcs</span>::<span class='ident'>c95</span>::<span class='ident'>string</span>; +<span class='kw'>use</span> <span class='ident'>libc</span>::<span class='ident'>types</span>::<span class='ident'>common</span>::<span class='ident'>c95</span>::<span class='ident'>c_void</span>; +<span class='kw'>use</span> <span class='ident'>libc</span>::<span class='ident'>types</span>::<span class='ident'>os</span>::<span class='ident'>arch</span>::<span class='ident'>c95</span>::{<span class='ident'>c_int</span>, <span class='ident'>size_t</span>}; + +<span class='doccomment'>/// A safe interface to `memchr`.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// Returns the index corresponding to the first occurrence of `needle` in</span> +<span class='doccomment'>/// `haystack`, or `None` if one is not found.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// memchr reduces to super-optimized machine code at around an order of</span> +<span class='doccomment'>/// magnitude faster than `haystack.iter().position(|&b| b == needle)`.</span> +<span class='doccomment'>/// (See benchmarks.)</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Example</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// This shows how to find the first position of a byte in a byte string.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ```rust</span> +<span class='doccomment'>/// use memchr::memchr;</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// let haystack = b"the quick brown fox";</span> +<span class='doccomment'>/// assert_eq!(memchr(b'k', haystack), Some(8));</span> +<span class='doccomment'>/// ```</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>memchr</span>(<span class='ident'>needle</span>: <span class='ident'>u8</span>, <span class='ident'>haystack</span>: <span class='kw-2'>&</span>[<span class='ident'>u8</span>]) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>usize</span><span class='op'>></span> { + <span class='kw'>let</span> <span class='ident'>p</span> <span class='op'>=</span> <span class='kw'>unsafe</span> { + <span class='ident'>string</span>::<span class='ident'>memchr</span>( + <span class='ident'>haystack</span>.<span class='ident'>as_ptr</span>() <span class='kw'>as</span> <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>c_void</span>, + <span class='ident'>needle</span> <span class='kw'>as</span> <span class='ident'>c_int</span>, + <span class='ident'>haystack</span>.<span class='ident'>len</span>() <span class='kw'>as</span> <span class='ident'>size_t</span>) + }; + <span class='kw'>if</span> <span class='ident'>p</span>.<span class='ident'>is_null</span>() { + <span class='prelude-val'>None</span> + } <span class='kw'>else</span> { + <span class='prelude-val'>Some</span>(<span class='ident'>p</span> <span class='kw'>as</span> <span class='ident'>usize</span> <span class='op'>-</span> (<span class='ident'>haystack</span>.<span class='ident'>as_ptr</span>() <span class='kw'>as</span> <span class='ident'>usize</span>)) + } +} + +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>mod</span> <span class='ident'>tests</span> { + <span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>quickcheck</span>; + + <span class='kw'>use</span> <span class='ident'>super</span>::<span class='ident'>memchr</span>; + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>matches_one</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='prelude-val'>Some</span>(<span class='number'>0</span>), <span class='ident'>memchr</span>(<span class='string'>b'a'</span>, <span class='string'>b"a"</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>matches_begin</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='prelude-val'>Some</span>(<span class='number'>0</span>), <span class='ident'>memchr</span>(<span class='string'>b'a'</span>, <span class='string'>b"aaaa"</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>matches_end</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='prelude-val'>Some</span>(<span class='number'>4</span>), <span class='ident'>memchr</span>(<span class='string'>b'z'</span>, <span class='string'>b"aaaaz"</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>matches_nul</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='prelude-val'>Some</span>(<span class='number'>4</span>), <span class='ident'>memchr</span>(<span class='string'>b'\x00'</span>, <span class='string'>b"aaaa\x00"</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>matches_past_nul</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='prelude-val'>Some</span>(<span class='number'>5</span>), <span class='ident'>memchr</span>(<span class='string'>b'z'</span>, <span class='string'>b"aaaa\x00z"</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>no_match_empty</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='prelude-val'>None</span>, <span class='ident'>memchr</span>(<span class='string'>b'a'</span>, <span class='string'>b""</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>no_match</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='prelude-val'>None</span>, <span class='ident'>memchr</span>(<span class='string'>b'a'</span>, <span class='string'>b"xyz"</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>qc_never_fail</span>() { + <span class='kw'>fn</span> <span class='ident'>prop</span>(<span class='ident'>needle</span>: <span class='ident'>u8</span>, <span class='ident'>haystack</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='ident'>memchr</span>(<span class='ident'>needle</span>, <span class='kw-2'>&</span><span class='ident'>haystack</span>); <span class='boolval'>true</span> + } + <span class='ident'>quickcheck</span>::<span class='ident'>quickcheck</span>(<span class='ident'>prop</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>u8</span>, <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>bool</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 = "memchr"; + 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 |