owoify/target/doc/memchr/index.html

34 lines
8.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="../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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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">&#9776;</div><a href='../memchr/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate memchr</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all memchr's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'memchr', ty: 'mod', relpath: '../'};</script></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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/memchr/lib.rs.html#1-312' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>memchr</a></span></h1><div class='docblock'><p>The <code>memchr</code> crate provides heavily optimized routines for searching bytes.</p>
<p>The <code>memchr</code> function is traditionally provided by libc, however, the
performance of <code>memchr</code> can vary significantly depending on the specific
implementation of libc that is used. They can range from manually tuned
Assembly implementations (like that found in GNU's libc) all the way to
non-vectorized C implementations (like that found in MUSL).</p>
<p>To smooth out the differences between implementations of libc, at least
on <code>x86_64</code> for Rust 1.27+, this crate provides its own implementation of
<code>memchr</code> that should perform competitively with the one found in GNU's libc.
The implementation is in pure Rust and has no dependency on a C compiler or an
Assembler.</p>
<p>Additionally, GNU libc also provides an extension, <code>memrchr</code>. This crate
provides its own implementation of <code>memrchr</code> as well, on top of <code>memchr2</code>,
<code>memchr3</code>, <code>memrchr2</code> and <code>memrchr3</code>. The difference between <code>memchr</code> and
<code>memchr2</code> is that that <code>memchr2</code> permits finding all occurrences of two bytes
instead of one. Similarly for <code>memchr3</code>.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.Memchr.html" title='memchr::Memchr struct'>Memchr</a></td><td class='docblock-short'><p>An iterator for <code>memchr</code>.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Memchr2.html" title='memchr::Memchr2 struct'>Memchr2</a></td><td class='docblock-short'><p>An iterator for <code>memchr2</code>.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Memchr3.html" title='memchr::Memchr3 struct'>Memchr3</a></td><td class='docblock-short'><p>An iterator for <code>memchr3</code>.</p>
</td></tr></table><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 fn'>memchr</a></td><td class='docblock-short'><p>Search for the first occurrence of a byte in a slice.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memchr2_iter.html" title='memchr::memchr2_iter fn'>memchr2_iter</a></td><td class='docblock-short'><p>An iterator over all occurrences of the needles in a haystack.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memchr2.html" title='memchr::memchr2 fn'>memchr2</a></td><td class='docblock-short'><p>Like <code>memchr</code>, but searches for two bytes instead of one.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memchr3_iter.html" title='memchr::memchr3_iter fn'>memchr3_iter</a></td><td class='docblock-short'><p>An iterator over all occurrences of the needles in a haystack.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memchr3.html" title='memchr::memchr3 fn'>memchr3</a></td><td class='docblock-short'><p>Like <code>memchr</code>, but searches for three bytes instead of one.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memchr_iter.html" title='memchr::memchr_iter fn'>memchr_iter</a></td><td class='docblock-short'><p>An iterator over all occurrences of the needle in a haystack.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memrchr.html" title='memchr::memrchr fn'>memrchr</a></td><td class='docblock-short'><p>Search for the last occurrence of a byte in a slice.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memrchr2_iter.html" title='memchr::memrchr2_iter fn'>memrchr2_iter</a></td><td class='docblock-short'><p>An iterator over all occurrences of the needles in a haystack, in reverse.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memrchr2.html" title='memchr::memrchr2 fn'>memrchr2</a></td><td class='docblock-short'><p>Like <code>memrchr</code>, but searches for two bytes instead of one.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memrchr3_iter.html" title='memchr::memrchr3_iter fn'>memrchr3_iter</a></td><td class='docblock-short'><p>An iterator over all occurrences of the needles in a haystack, in reverse.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memrchr3.html" title='memchr::memrchr3 fn'>memrchr3</a></td><td class='docblock-short'><p>Like <code>memrchr</code>, but searches for three bytes instead of one.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.memrchr_iter.html" title='memchr::memrchr_iter fn'>memrchr_iter</a></td><td class='docblock-short'><p>An iterator over all occurrences of the needle in a haystack, in reverse.</p>
</td></tr></table></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>&#9166;</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "memchr";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>