31 lines
7.4 KiB
HTML
31 lines
7.4 KiB
HTML
<!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="Fast, SIMD-accelerated CRC32 (IEEE) checksum computation."><meta name="keywords" content="rust, rustlang, rust-lang, crc32fast"><title>crc32fast - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../crc32fast/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Crate crc32fast</h2><div class="block version"><div class="narrow-helper"></div><p>Version 1.3.2</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all crc32fast'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><div id="sidebar-vars" data-name="crc32fast" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../crc32fast/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><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><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">crc32fast</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></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/crc32fast/lib.rs.html#1-235" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Fast, SIMD-accelerated CRC32 (IEEE) checksum computation.</p>
|
||
<h3 id="usage" class="section-header"><a href="#usage">Usage</a></h3><h4 id="simple-usage" class="section-header"><a href="#simple-usage">Simple usage</a></h4>
|
||
<p>For simple use-cases, you can call the <a href="fn.hash.html" title="hash()"><code>hash()</code></a> convenience function to
|
||
directly compute the CRC32 checksum for a given byte slice:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">checksum</span> <span class="op">=</span> <span class="ident">crc32fast::hash</span>(<span class="string">b"foo bar baz"</span>);</code></pre></div>
|
||
<h4 id="advanced-usage" class="section-header"><a href="#advanced-usage">Advanced usage</a></h4>
|
||
<p>For use-cases that require more flexibility or performance, for example when
|
||
processing large amounts of data, you can create and manipulate a <a href="struct.Hasher.html" title="Hasher"><code>Hasher</code></a>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crc32fast::Hasher</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">hasher</span> <span class="op">=</span> <span class="ident">Hasher::new</span>();
|
||
<span class="ident">hasher</span>.<span class="ident">update</span>(<span class="string">b"foo bar baz"</span>);
|
||
<span class="kw">let</span> <span class="ident">checksum</span> <span class="op">=</span> <span class="ident">hasher</span>.<span class="ident">finalize</span>();</code></pre></div>
|
||
<h3 id="performance" class="section-header"><a href="#performance">Performance</a></h3>
|
||
<p>This crate contains multiple CRC32 implementations:</p>
|
||
<ul>
|
||
<li>A fast baseline implementation which processes up to 16 bytes per iteration</li>
|
||
<li>An optimized implementation for modern <code>x86</code> using <code>sse</code> and <code>pclmulqdq</code> instructions</li>
|
||
</ul>
|
||
<p>Calling the <a href="struct.Hasher.html#method.new" title="Hasher::new"><code>Hasher::new</code></a> constructor at runtime will perform a feature detection to select the most
|
||
optimal implementation for the current CPU feature set.</p>
|
||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Hasher.html" title="crc32fast::Hasher struct">Hasher</a></div><div class="item-right docblock-short"><p>Represents an in-progress CRC32 computation.</p>
|
||
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.hash.html" title="crc32fast::hash fn">hash</a></div><div class="item-right docblock-short"><p>Computes the CRC32 hash of a byte slice.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="crc32fast" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |