edlang/fnv/index.html

47 lines
7.1 KiB
HTML
Raw Normal View History

<!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="An implementation of the FowlerNollVo hash function."><title>fnv - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="fnv" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../fnv/index.html">fnv</a><span class="version">1.0.7</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#types">Type Aliases</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">fnv</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/fnv/lib.rs.html#1-367">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An implementation of the <a href="http://www.isthe.com/chongo/tech/comp/fnv/index.html">FowlerNollVo hash function</a>.</p>
<h3 id="about"><a class="doc-anchor" href="#about">§</a>About</h3>
<p>The FNV hash function is a custom <code>Hasher</code> implementation that is more
efficient for smaller hash keys.</p>
<p><a href="https://www.rust-lang.org/en-US/faq.html#why-are-rusts-hashmaps-slow">The Rust FAQ states that</a> while the default <code>Hasher</code> implementation,
SipHash, is good in many cases, it is notably slower than other algorithms
with short keys, such as when you have a map of integers to other values.
In cases like these, <a href="https://cglab.ca/~abeinges/blah/hash-rs/">FNV is demonstrably faster</a>.</p>
<p>Its disadvantages are that it performs badly on larger inputs, and
provides no protection against collision attacks, where a malicious user
can craft specific keys designed to slow a hasher down. Thus, it is
important to profile your program to ensure that you are using small hash
keys, and be certain that your program could not be exposed to malicious
inputs (including being a networked server).</p>
<p>The Rust compiler itself uses FNV, as it is not worried about
denial-of-service attacks, and can assume that its inputs are going to be
small—a perfect use case for FNV.</p>
<h3 id="using-fnv-in-a-hashmap"><a class="doc-anchor" href="#using-fnv-in-a-hashmap">§</a>Using FNV in a <code>HashMap</code></h3>
<p>The <code>FnvHashMap</code> type alias is the easiest way to use the standard librarys
<code>HashMap</code> with FNV.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>fnv::FnvHashMap;
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvHashMap::default();
map.insert(<span class="number">1</span>, <span class="string">"one"</span>);
map.insert(<span class="number">2</span>, <span class="string">"two"</span>);
map = FnvHashMap::with_capacity_and_hasher(<span class="number">10</span>, Default::default());
map.insert(<span class="number">1</span>, <span class="string">"one"</span>);
map.insert(<span class="number">2</span>, <span class="string">"two"</span>);</code></pre></div>
<p>Note, the standard librarys <code>HashMap::new</code> and <code>HashMap::with_capacity</code>
are only implemented for the <code>RandomState</code> hasher, so using <code>Default</code> to
get the hasher is the next best option.</p>
<h3 id="using-fnv-in-a-hashset"><a class="doc-anchor" href="#using-fnv-in-a-hashset">§</a>Using FNV in a <code>HashSet</code></h3>
<p>Similarly, <code>FnvHashSet</code> is a type alias for the standard librarys <code>HashSet</code>
with FNV.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>fnv::FnvHashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set = FnvHashSet::default();
set.insert(<span class="number">1</span>);
set.insert(<span class="number">2</span>);
set = FnvHashSet::with_capacity_and_hasher(<span class="number">10</span>, Default::default());
set.insert(<span class="number">1</span>);
set.insert(<span class="number">2</span>);</code></pre></div>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.FnvHasher.html" title="struct fnv::FnvHasher">FnvHasher</a></div><div class="desc docblock-short">An implementation of the FowlerNollVo hash function.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.FnvBuildHasher.html" title="type fnv::FnvBuildHasher">FnvBuildHasher</a></div><div class="desc docblock-short">A builder for default FNV hashers.</div></li><li><div class="item-name"><a class="type" href="type.FnvHashMap.html" title="type fnv::FnvHashMap">FnvHashMap</a></div><div class="desc docblock-short">A <code>HashMap</code> using a default FNV hasher.</div></li><li><div class="item-name"><a class="type" href="type.FnvHashSet.html" title="type fnv::FnvHashSet">FnvHashSet</a></div><div class="desc docblock-short">A <code>HashSet</code> using a default FNV hasher.</div></li></ul></section></div></main></body></html>