207 lines
No EOL
12 KiB
HTML
207 lines
No EOL
12 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="API documentation for the Rust `hash` mod in crate `bitflags`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, hash">
|
||
|
||
<title>bitflags::__core::hash - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a></p><script>window.sidebarCurrent = {name: 'hash', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<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 mod">
|
||
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a class='mod' href=''>hash</a></span><span class='out-of-band'><span id='render-detail'>
|
||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||
[<span class='inner'>−</span>]
|
||
</a>
|
||
</span><a id='src-33809' class='srclink' href='https://doc.rust-lang.org/nightly/core/hash/index.html?gotosrc=33809' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>Generic hashing support.</p>
|
||
|
||
<p>This module provides a generic way to compute the hash of a value. The
|
||
simplest way to make a type hashable is to use <code>#[derive(Hash)]</code>:</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>hash</span>::{<span class='ident'>Hash</span>, <span class='ident'>SipHasher</span>, <span class='ident'>Hasher</span>};
|
||
|
||
<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Hash</span>)]</span>
|
||
<span class='kw'>struct</span> <span class='ident'>Person</span> {
|
||
<span class='ident'>id</span>: <span class='ident'>u32</span>,
|
||
<span class='ident'>name</span>: <span class='ident'>String</span>,
|
||
<span class='ident'>phone</span>: <span class='ident'>u64</span>,
|
||
}
|
||
|
||
<span class='kw'>let</span> <span class='ident'>person1</span> <span class='op'>=</span> <span class='ident'>Person</span> { <span class='ident'>id</span>: <span class='number'>5</span>, <span class='ident'>name</span>: <span class='string'>"Janet"</span>.<span class='ident'>to_string</span>(), <span class='ident'>phone</span>: <span class='number'>555_666_7777</span> };
|
||
<span class='kw'>let</span> <span class='ident'>person2</span> <span class='op'>=</span> <span class='ident'>Person</span> { <span class='ident'>id</span>: <span class='number'>5</span>, <span class='ident'>name</span>: <span class='string'>"Bob"</span>.<span class='ident'>to_string</span>(), <span class='ident'>phone</span>: <span class='number'>555_666_7777</span> };
|
||
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='ident'>person1</span>) <span class='op'>!=</span> <span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='ident'>person2</span>));
|
||
|
||
<span class='kw'>fn</span> <span class='ident'>hash</span><span class='op'><</span><span class='ident'>T</span>: <span class='ident'>Hash</span><span class='op'>></span>(<span class='ident'>t</span>: <span class='kw-2'>&</span><span class='ident'>T</span>) <span class='op'>-></span> <span class='ident'>u64</span> {
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>s</span> <span class='op'>=</span> <span class='ident'>SipHasher</span>::<span class='ident'>new</span>();
|
||
<span class='ident'>t</span>.<span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>s</span>);
|
||
<span class='ident'>s</span>.<span class='ident'>finish</span>()
|
||
}</pre>
|
||
|
||
<p>If you need more control over how a value is hashed, you need to implement
|
||
the trait <code>Hash</code>:</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>hash</span>::{<span class='ident'>Hash</span>, <span class='ident'>Hasher</span>, <span class='ident'>SipHasher</span>};
|
||
|
||
<span class='kw'>struct</span> <span class='ident'>Person</span> {
|
||
<span class='ident'>id</span>: <span class='ident'>u32</span>,
|
||
<span class='ident'>name</span>: <span class='ident'>String</span>,
|
||
<span class='ident'>phone</span>: <span class='ident'>u64</span>,
|
||
}
|
||
|
||
<span class='kw'>impl</span> <span class='ident'>Hash</span> <span class='kw'>for</span> <span class='ident'>Person</span> {
|
||
<span class='kw'>fn</span> <span class='ident'>hash</span><span class='op'><</span><span class='ident'>H</span>: <span class='ident'>Hasher</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>state</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>H</span>) {
|
||
<span class='self'>self</span>.<span class='ident'>id</span>.<span class='ident'>hash</span>(<span class='ident'>state</span>);
|
||
<span class='self'>self</span>.<span class='ident'>phone</span>.<span class='ident'>hash</span>(<span class='ident'>state</span>);
|
||
}
|
||
}
|
||
|
||
<span class='kw'>let</span> <span class='ident'>person1</span> <span class='op'>=</span> <span class='ident'>Person</span> { <span class='ident'>id</span>: <span class='number'>5</span>, <span class='ident'>name</span>: <span class='string'>"Janet"</span>.<span class='ident'>to_string</span>(), <span class='ident'>phone</span>: <span class='number'>555_666_7777</span> };
|
||
<span class='kw'>let</span> <span class='ident'>person2</span> <span class='op'>=</span> <span class='ident'>Person</span> { <span class='ident'>id</span>: <span class='number'>5</span>, <span class='ident'>name</span>: <span class='string'>"Bob"</span>.<span class='ident'>to_string</span>(), <span class='ident'>phone</span>: <span class='number'>555_666_7777</span> };
|
||
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='ident'>person1</span>), <span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='ident'>person2</span>));
|
||
|
||
<span class='kw'>fn</span> <span class='ident'>hash</span><span class='op'><</span><span class='ident'>T</span>: <span class='ident'>Hash</span><span class='op'>></span>(<span class='ident'>t</span>: <span class='kw-2'>&</span><span class='ident'>T</span>) <span class='op'>-></span> <span class='ident'>u64</span> {
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>s</span> <span class='op'>=</span> <span class='ident'>SipHasher</span>::<span class='ident'>new</span>();
|
||
<span class='ident'>t</span>.<span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>s</span>);
|
||
<span class='ident'>s</span>.<span class='ident'>finish</span>()
|
||
}</pre>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class='struct' href='struct.BuildHasherDefault.html'
|
||
title='bitflags::__core::hash::BuildHasherDefault'>BuildHasherDefault</a></td>
|
||
<td class='docblock short'>
|
||
<p>A structure which implements <code>BuildHasher</code> for all <code>Hasher</code> types which also
|
||
implement <code>Default</code>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class='struct' href='struct.SipHasher.html'
|
||
title='bitflags::__core::hash::SipHasher'>SipHasher</a></td>
|
||
<td class='docblock short'>
|
||
<p>An implementation of SipHash 2-4.</p>
|
||
</td>
|
||
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class='trait' href='trait.BuildHasher.html'
|
||
title='bitflags::__core::hash::BuildHasher'>BuildHasher</a></td>
|
||
<td class='docblock short'>
|
||
<p>A <code>BuildHasher</code> is typically used as a factory for instances of <code>Hasher</code>
|
||
which a <code>HashMap</code> can then use to hash keys independently.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class='trait' href='trait.Hash.html'
|
||
title='bitflags::__core::hash::Hash'>Hash</a></td>
|
||
<td class='docblock short'>
|
||
<p>A hashable type.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class='trait' href='trait.Hasher.html'
|
||
title='bitflags::__core::hash::Hasher'>Hasher</a></td>
|
||
<td class='docblock short'>
|
||
<p>A trait which represents the ability to hash an arbitrary stream of bytes.</p>
|
||
</td>
|
||
</tr></table></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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</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 = "bitflags";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../../jquery.js"></script>
|
||
<script src="../../../main.js"></script>
|
||
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |