rtic/dev/api/hash32/trait.Hasher.html
2024-10-24 05:57:30 +00:00

12 lines
No EOL
5.8 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="An extension of core::hash::Hasher for hashers which use 32 bits."><title>Hasher in hash32 - 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-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="hash32" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.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 trait"><!--[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="../hash32/index.html">hash32</a><span class="version">0.3.1</span></h2></div><h2 class="location"><a href="#">Hasher</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.finish32">finish32</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate hash32</a></h2></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>Trait <a href="index.html">hash32</a>::<wbr><a class="trait" href="#">Hasher</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/hash32/lib.rs.html#134-141">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Hasher: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a> {
// Required method
fn <a href="#tymethod.finish32" class="fn">finish32</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u32.html">u32</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An extension of <a href="https://doc.rust-lang.org/core/hash/trait.Hasher.html">core::hash::Hasher</a> for hashers which use 32 bits.</p>
<p>For hashers which implement this trait, the standard <code>finish</code> method should just return a
zero-extended version of the result of <code>finish32</code>.</p>
<h2 id="contract"><a class="doc-anchor" href="#contract">§</a>Contract</h2>
<p>Implementers of this trait must <em>not</em> perform any 64-bit (or 128-bit) operation while computing
the hash.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.finish32" class="method"><a class="src rightside" href="../src/hash32/lib.rs.html#140">source</a><h4 class="code-header">fn <a href="#tymethod.finish32" class="fn">finish32</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>The equivalent of <a href="https://doc.rust-lang.org/std/hash/trait.Hasher.html#tymethod.finish"><code>core::hash::Hasher.finish</code></a> for 32-bit hashers.</p>
<p>This returns the hash directly; <code>finish</code> zero-extends it to 64 bits for compatibility.</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Hasher-for-Hasher" class="impl"><a class="src rightside" href="../src/hash32/fnv.rs.html#17-22">source</a><a href="#impl-Hasher-for-Hasher" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Hasher.html" title="trait hash32::Hasher">Hasher</a> for hash32::<a class="struct" href="struct.FnvHasher.html" title="struct hash32::FnvHasher">FnvHasher</a></h3></section><section id="impl-Hasher-for-Hasher-1" class="impl"><a class="src rightside" href="../src/hash32/murmur3.rs.html#82-123">source</a><a href="#impl-Hasher-for-Hasher-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Hasher.html" title="trait hash32::Hasher">Hasher</a> for hash32::<a class="struct" href="struct.Murmur3Hasher.html" title="struct hash32::Murmur3Hasher">Murmur3Hasher</a></h3></section></div><script src="../trait.impl/hash32/trait.Hasher.js" async></script></section></div></main></body></html>