<!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="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
<body class="rustdoc fn">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav 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>
</nav>
<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">
<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 class='srclink' href='../src/memchr/lib.rs.html#75-106' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn memchr(needle: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, haystack: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://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>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<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>
<dt>+</dt>
<dd>Collapse/expand 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 = "memchr";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>