diff options
| author | 2015-06-29 20:16:15 +0000 | |
|---|---|---|
| committer | 2015-06-29 20:16:15 +0000 | |
| commit | 64106c4d3d4ddba8c7bc2af75376e6d3d3d75601 (patch) | |
| tree | 8c64d6e8be006486d975a651505fbbde61365cd6 /memchr | |
| download | irsc-64106c4d3d4ddba8c7bc2af75376e6d3d3d75601.tar.gz irsc-64106c4d3d4ddba8c7bc2af75376e6d3d3d75601.tar.xz irsc-64106c4d3d4ddba8c7bc2af75376e6d3d3d75601.zip | |
Update documentationgh-pages
Diffstat (limited to 'memchr')
| -rw-r--r-- | memchr/fn.memchr.html | 119 | ||||
| -rw-r--r-- | memchr/index.html | 113 | ||||
| -rw-r--r-- | memchr/sidebar-items.js | 1 |
3 files changed, 233 insertions, 0 deletions
diff --git a/memchr/fn.memchr.html b/memchr/fn.memchr.html new file mode 100644 index 0000000..814d477 --- /dev/null +++ b/memchr/fn.memchr.html @@ -0,0 +1,119 @@ +<!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="API documentation for the Rust `memchr` fn in crate `memchr`."> + <meta name="keywords" content="rust, rustlang, rust-lang, memchr"> + + <title>memchr::memchr - Rust</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"> + + <p class='location'><a href='index.html'>memchr</a></p><script>window.sidebarCurrent = {name: 'memchr', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script> + </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 fn"> +<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>memchr</a>::<wbr><a class='fn' href=''>memchr</a></span><span class='out-of-band'><span id='render-detail'> + <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs"> + [<span class='inner'>−</span>] + </a> + </span><a id='src-10' class='srclink' href='../src/memchr/lib.rs.html#33-45' title='goto source code'>[src]</a></span></h1> +<pre class='rust fn'>pub fn memchr(needle: <a href='http://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a>, haystack: <a href='http://doc.rust-lang.org/nightly/std/primitive.slice.html'>&[</a><a href='http://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a><a href='http://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.usize.html'>usize</a>></pre><div class='docblock'><p>A safe interface to <code>memchr</code>.</p> + +<p>Returns the index corresponding to the first occurrence of <code>needle</code> in +<code>haystack</code>, or <code>None</code> if one is not found.</p> + +<p>memchr reduces to super-optimized machine code at around an order of +magnitude faster than <code>haystack.iter().position(|&b| b == needle)</code>. +(See benchmarks.)</p> + +<h1 id="example" class='section-header'><a + href="#example">Example</a></h1> +<p>This shows how to find the first position of a byte in a byte string.</p> +<pre class='rust rust-example-rendered'> +<span class='kw'>use</span> <span class='ident'>memchr</span>::<span class='ident'>memchr</span>; + +<span class='kw'>let</span> <span class='ident'>haystack</span> <span class='op'>=</span> <span class='string'>b"the quick brown fox"</span>; +<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>memchr</span>(<span class='string'>b'k'</span>, <span class='ident'>haystack</span>), <span class='prelude-val'>Some</span>(<span class='number'>8</span>)); +</pre> +</div></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 diff --git a/memchr/index.html b/memchr/index.html new file mode 100644 index 0000000..438fa0f --- /dev/null +++ b/memchr/index.html @@ -0,0 +1,113 @@ +<!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="API documentation for the Rust `memchr` crate."> + <meta name="keywords" content="rust, rustlang, rust-lang, memchr"> + + <title>memchr - Rust</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"> + + <p class='location'></p><script>window.sidebarCurrent = {name: 'memchr', ty: 'mod', relpath: '../'};</script> + </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 mod"> +<h1 class='fqn'><span class='in-band'>Crate <a class='mod' href=''>memchr</a></span><span class='out-of-band'><span id='render-detail'> + <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs"> + [<span class='inner'>−</span>] + </a> + </span><a id='src-0' class='srclink' href='../src/memchr/lib.rs.html#1-95' title='goto source code'>[src]</a></span></h1> +<div class='docblock'><p>This crate defines a single function, <code>memchr</code>, which exposes a safe interface +to the corresponding function in <code>libc</code>.</p> +</div><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2> +<table> + <tr class=' module-item'> + <td><a class='fn' href='fn.memchr.html' + title='memchr::memchr'>memchr</a></td> + <td class='docblock short'> + <p>A safe interface to <code>memchr</code>.</p> + + </td> + </tr> + </table></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 diff --git a/memchr/sidebar-items.js b/memchr/sidebar-items.js new file mode 100644 index 0000000..a685a6a --- /dev/null +++ b/memchr/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["memchr","A safe interface to `memchr`."]]});
\ No newline at end of file |