22 lines
5.7 KiB
HTML
22 lines
5.7 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."><title>crc32fast - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="crc32fast" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Crate crc32fast</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../crc32fast/index.html">crc32fast</a><span class="version">1.5.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#usage" title="Usage">Usage</a><ul><li><a href="#simple-usage" title="Simple usage">Simple usage</a></li><li><a href="#advanced-usage" title="Advanced usage">Advanced usage</a></li></ul></li><li><a href="#performance" title="Performance">Performance</a></li></ul><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>crc32fast</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/crc32fast/lib.rs.html#1-214">Source</a> </span></div><details class="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"><a class="doc-anchor" href="#usage">§</a>Usage</h3><h4 id="simple-usage"><a class="doc-anchor" href="#simple-usage">§</a>Simple usage</h4>
|
|
<p>For simple use-cases, you can call the <a href="fn.hash.html" title="fn crc32fast::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>checksum = crc32fast::hash(<span class="string">b"foo bar baz"</span>);</code></pre></div><h4 id="advanced-usage"><a class="doc-anchor" href="#advanced-usage">§</a>Advanced usage</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="struct crc32fast::Hasher"><code>Hasher</code></a>:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crc32fast::Hasher;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>hasher = Hasher::new();
|
|
hasher.update(<span class="string">b"foo bar baz"</span>);
|
|
<span class="kw">let </span>checksum = hasher.finalize();</code></pre></div><h3 id="performance"><a class="doc-anchor" href="#performance">§</a>Performance</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="associated function crc32fast::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="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Hasher.html" title="struct crc32fast::Hasher">Hasher</a></dt><dd>Represents an in-progress CRC32 computation.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.hash.html" title="fn crc32fast::hash">hash</a></dt><dd>Computes the CRC32 hash of a byte slice.</dd></dl></section></div></main></body></html> |