Files
phy/rustc_hash/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

10 lines
6.2 KiB
HTML
Raw Permalink 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="A speedy, non-cryptographic hashing algorithm used by `rustc`."><title>rustc_hash - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rustc_hash" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../rustc_hash/index.html">rustc_<wbr>hash</a><span class="version">2.1.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="#example" title="Example">Example</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="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></div></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 <span>rustc_hash</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/rustc_hash/lib.rs.html#1-459">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A speedy, non-cryptographic hashing algorithm used by <code>rustc</code>.</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rustc_hash::FxHashMap;
<span class="kw">let </span><span class="kw-2">mut </span>map: FxHashMap&lt;u32, u32&gt; = FxHashMap::default();
map.insert(<span class="number">22</span>, <span class="number">44</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.FxBuildHasher.html" title="struct rustc_hash::FxBuildHasher">FxBuild<wbr>Hasher</a></div><div class="desc docblock-short">An implementation of <a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher"><code>BuildHasher</code></a> that produces <a href="struct.FxHasher.html" title="struct rustc_hash::FxHasher"><code>FxHasher</code></a>s.</div></li><li><div class="item-name"><a class="struct" href="struct.FxHasher.html" title="struct rustc_hash::FxHasher">FxHasher</a></div><div class="desc docblock-short">A speedy hash algorithm for use within rustc. The hashmap in liballoc
by default uses SipHash which isnt quite as speedy as we want. In the
compiler were not really worried about DOS attempts, so we use a fast
non-cryptographic hash.</div></li><li><div class="item-name"><a class="struct" href="struct.FxSeededState.html" title="struct rustc_hash::FxSeededState">FxSeeded<wbr>State</a></div><div class="desc docblock-short"><a href="struct.FxSeededState.html" title="struct rustc_hash::FxSeededState"><code>FxSeededState</code></a> is an alternative state for <code>HashMap</code> types, allowing to use <a href="struct.FxHasher.html" title="struct rustc_hash::FxHasher"><code>FxHasher</code></a> with a set seed.</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.FxHashMap.html" title="type rustc_hash::FxHashMap">FxHash<wbr>Map</a></div><div class="desc docblock-short">Type alias for a hash map that uses the Fx hashing algorithm.</div></li><li><div class="item-name"><a class="type" href="type.FxHashMapSeed.html" title="type rustc_hash::FxHashMapSeed">FxHash<wbr>MapSeed</a></div><div class="desc docblock-short">Type alias for a hashmap using the <code>fx</code> hash algorithm with <a href="struct.FxSeededState.html" title="struct rustc_hash::FxSeededState"><code>FxSeededState</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.FxHashSet.html" title="type rustc_hash::FxHashSet">FxHash<wbr>Set</a></div><div class="desc docblock-short">Type alias for a hash set that uses the Fx hashing algorithm.</div></li><li><div class="item-name"><a class="type" href="type.FxHashSetSeed.html" title="type rustc_hash::FxHashSetSeed">FxHash<wbr>SetSeed</a></div><div class="desc docblock-short">Type alias for a hashmap using the <code>fx</code> hash algorithm with <a href="struct.FxSeededState.html" title="struct rustc_hash::FxSeededState"><code>FxSeededState</code></a>.</div></li></ul></section></div></main></body></html>