<!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="API documentation for the Rust `SipHasher` struct in crate `std`.">
<meta name="keywords" content="rust, rustlang, rust-lang, SipHasher">
<title>std::hash::SipHasher - Rust</title>
<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="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
<a href='../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Struct SipHasher</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.new_with_keys">new_with_keys</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Hasher">Hasher</a><a href="#impl-Default">Default</a><a href="#impl-Clone">Clone</a></div></div><p class='location'><a href='../index.html'>std</a>::<wbr><a href='index.html'>hash</a></p><script>window.sidebarCurrent = {name: 'SipHasher', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>std</a>::<wbr><a href='index.html'>hash</a>::<wbr><a class="struct" href=''>SipHasher</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><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/core/hash/sip.rs.html#61' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct SipHasher(_);</pre><div class='stability'><div class='stab deprecated'>Deprecated since 1.13.0<p>: use <code>std::collections::hash_map::DefaultHasher</code> instead</p>
</div></div><div class='docblock'><p>An implementation of SipHash 2-4.</p>
<p>See: <a href="https://131002.net/siphash/">https://131002.net/siphash/</a></p>
<p>SipHash is a general-purpose hashing function: it runs at a good
speed (competitive with Spooky and City) and permits strong <em>keyed</em>
hashing. This lets you key your hashtables from a strong RNG, such as
<a href="https://doc.rust-lang.org/rand/rand/os/struct.OsRng.html"><code>rand::os::OsRng</code></a>.</p>
<p>Although the SipHash algorithm is considered to be generally strong,
it is not intended for cryptographic purposes. As such, all
cryptographic uses of this implementation are <em>strongly discouraged</em>.</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../std/hash/struct.SipHasher.html" title="struct std::hash::SipHasher">SipHasher</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#143-161' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../../std/hash/struct.SipHasher.html" title="struct std::hash::SipHasher">SipHasher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#149-151' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab deprecated'>Deprecated since 1.13.0<p>: use <code>std::collections::hash_map::DefaultHasher</code> instead</p>
</div></div><div class='docblock'><p>Creates a new <code>SipHasher</code> with the two initial keys set to 0.</p>
</div><h4 id='method.new_with_keys' class="method"><span id='new_with_keys.v' class='invisible'><code>pub fn <a href='#method.new_with_keys' class='fnname'>new_with_keys</a>(key0: <a class="primitive" href="../primitive.u64.html">u64</a>, key1: <a class="primitive" href="../primitive.u64.html">u64</a>) -> <a class="struct" href="../../std/hash/struct.SipHasher.html" title="struct std::hash::SipHasher">SipHasher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#158-160' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab deprecated'>Deprecated since 1.13.0<p>: use <code>std::collections::hash_map::DefaultHasher</code> instead</p>
</div></div><div class='docblock'><p>Creates a <code>SipHasher</code> that is keyed off the provided keys.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../std/fmt/trait.Debug.html" title="trait std::fmt::Debug">Debug</a> for <a class="struct" href="../../std/hash/struct.SipHasher.html" title="struct std::hash::SipHasher">SipHasher</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#60' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='../../std/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="../../std/fmt/struct.Formatter.html" title="struct std::fmt::Formatter">Formatter</a>) -> <a class="enum" href="../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><<a class="primitive" href="../primitive.unit.html">()</a>, <a class="struct" href="../../std/fmt/struct.Error.html" title="struct std::fmt::Error">Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#60' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="../../std/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Hasher' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../std/hash/trait.Hasher.html" title="trait std::hash::Hasher">Hasher</a> for <a class="struct" href="../../std/hash/struct.SipHasher.html" title="struct std::hash::SipHasher">SipHasher</a></code><a href='#impl-Hasher' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#271-281' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.write' class="method"><span id='write.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#tymethod.write' class='fnname'>write</a>(&mut self, msg: <a class="primitive" href="../primitive.slice.html">&[</a><a class="primitive" href="../primitive.u8.html">u8</a><a class="primitive" href="../primitive.slice.html">]</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#273-275' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes some data into this <code>Hasher</code>. <a href="../../std/hash/trait.Hasher.html#tymethod.write">Read more</a></p>
</div><h4 id='method.finish' class="method"><span id='finish.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#tymethod.finish' class='fnname'>finish</a>(&self) -> <a class="primitive" href="../primitive.u64.html">u64</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#278-280' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the hash value for the values written so far. <a href="../../std/hash/trait.Hasher.html#tymethod.finish">Read more</a></p>
</div><h4 id='method.write_u8' class="method"><span id='write_u8.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_u8' class='fnname'>write_u8</a>(&mut self, i: <a class="primitive" href="../primitive.u8.html">u8</a>)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='../../src/core/hash/mod.rs.html#287-289' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes a single <code>u8</code> into this hasher.</p>
</div><h4 id='method.write_u16' class="method"><span id='write_u16.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_u16' class='fnname'>write_u16</a>(&mut self, i: <a class="primitive" href="../primitive.u16.html">u16</a>)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='../../src/core/hash/mod.rs.html#293-295' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes a single <code>u16</code> into this hasher.</p>
</div><h4 id='method.write_u32' class="method"><span id='write_u32.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_u32' class='fnname'>write_u32</a>(&mut self, i: <a class="primitive" href="../primitive.u32.html">u32</a>)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='../../src/core/hash/mod.rs.html#299-301' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes a single <code>u32</code> into this hasher.</p>
</div><h4 id='method.write_u64' class="method"><span id='write_u64.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_u64' class='fnname'>write_u64</a>(&mut self, i: <a class="primitive" href="../primitive.u64.html">u64</a>)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='../../src/core/hash/mod.rs.html#305-307' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes a single <code>u64</code> into this hasher.</p>
</div><h4 id='method.write_u128' class="method"><span id='write_u128.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_u128' class='fnname'>write_u128</a>(&mut self, i: <a class="primitive" href="../primitive.u128.html">u128</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/mod.rs.html#311-313' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>i128 </code><a href="https://github.com/rust-lang/rust/issues/35118">#35118</a>)</div></div><div class='docblock'><p>Writes a single <code>u128</code> into this hasher.</p>
</div><h4 id='method.write_usize' class="method"><span id='write_usize.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_usize' class='fnname'>write_usize</a>(&mut self, i: <a class="primitive" href="../primitive.usize.html">usize</a>)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='../../src/core/hash/mod.rs.html#317-322' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes a single <code>usize</code> into this hasher.</p>
</div><h4 id='method.write_i8' class="method"><span id='write_i8.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_i8' class='fnname'>write_i8</a>(&mut self, i: <a class="primitive" href="../primitive.i8.html">i8</a>)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='../../src/core/hash/mod.rs.html#327-329' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes a single <code>i8</code> into this hasher.</p>
</div><h4 id='method.write_i16' class="method"><span id='write_i16.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_i16' class='fnname'>write_i16</a>(&mut self, i: <a class="primitive" href="../primitive.i16.html">i16</a>)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='../../src/core/hash/mod.rs.html#333-335' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes a single <code>i16</code> into this hasher.</p>
</div><h4 id='method.write_i32' class="method"><span id='write_i32.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_i32' class='fnname'>write_i32</a>(&mut self, i: <a class="primitive" href="../primitive.i32.html">i32</a>)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='../../src/core/hash/mod.rs.html#339-341' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes a single <code>i32</code> into this hasher.</p>
</div><h4 id='method.write_i64' class="method"><span id='write_i64.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_i64' class='fnname'>write_i64</a>(&mut self, i: <a class="primitive" href="../primitive.i64.html">i64</a>)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='../../src/core/hash/mod.rs.html#345-347' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes a single <code>i64</code> into this hasher.</p>
</div><h4 id='method.write_i128' class="method"><span id='write_i128.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_i128' class='fnname'>write_i128</a>(&mut self, i: <a class="primitive" href="../primitive.i128.html">i128</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/mod.rs.html#351-353' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>i128 </code><a href="https://github.com/rust-lang/rust/issues/35118">#35118</a>)</div></div><div class='docblock'><p>Writes a single <code>i128</code> into this hasher.</p>
</div><h4 id='method.write_isize' class="method"><span id='write_isize.v' class='invisible'><code>fn <a href='../../std/hash/trait.Hasher.html#method.write_isize' class='fnname'>write_isize</a>(&mut self, i: <a class="primitive" href="../primitive.isize.html">isize</a>)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='../../src/core/hash/mod.rs.html#357-359' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Writes a single <code>isize</code> into this hasher.</p>
</div></div><h3 id='impl-Default' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../std/default/trait.Default.html" title="trait std::default::Default">Default</a> for <a class="struct" href="../../std/hash/struct.SipHasher.html" title="struct std::hash::SipHasher">SipHasher</a></code><a href='#impl-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#60' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='../../std/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../../std/hash/struct.SipHasher.html" title="struct std::hash::SipHasher">SipHasher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#60' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the "default value" for a type. <a href="../../std/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../std/clone/trait.Clone.html" title="trait std::clone::Clone">Clone</a> for <a class="struct" href="../../std/hash/struct.SipHasher.html" title="struct std::hash::SipHasher">SipHasher</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#60' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='../../std/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../std/hash/struct.SipHasher.html" title="struct std::hash::SipHasher">SipHasher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/hash/sip.rs.html#60' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="../../std/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='../../std/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="../primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="../../std/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "std";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
fdedb3cf2140df9b6d419a2338ab1caa
>
files
>
4175
