217 lines
66 KiB
HTML
217 lines
66 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="A view into a single entry in a map, which may either be vacant or occupied, with any borrowed form of the map’s key type."><meta name="keywords" content="rust, rustlang, rust-lang, EntryRef"><title>EntryRef in hashbrown::hash_map - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc enum"><!--[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">☰</button><a class="sidebar-logo" href="../../hashbrown/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../hashbrown/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">EntryRef</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#variants">Variants</a></h3><ul><li><a href="#variant.Occupied">Occupied</a></li><li><a href="#variant.Vacant">Vacant</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.and_modify">and_modify</a></li><li><a href="#method.and_replace_entry_with">and_replace_entry_with</a></li><li><a href="#method.insert">insert</a></li><li><a href="#method.key">key</a></li><li><a href="#method.or_default">or_default</a></li><li><a href="#method.or_insert">or_insert</a></li><li><a href="#method.or_insert_with">or_insert_with</a></li><li><a href="#method.or_insert_with_key">or_insert_with_key</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-Debug-for-EntryRef%3C%27_%2C%20%27_%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">Debug</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><a href="#impl-RefUnwindSafe-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">Send</a></li><li><a href="#impl-Sync-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">Sync</a></li><li><a href="#impl-Unpin-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">!UnwindSafe</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><ul><li><a href="#impl-Any-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In hashbrown::hash_map</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../hashbrown/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Enum <a href="../index.html">hashbrown</a>::<wbr><a href="index.html">hash_map</a>::<wbr><a class="enum" href="#">EntryRef</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/hashbrown/map.rs.html#4321-4354">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust enum"><code>pub enum EntryRef<'a, 'b, K, Q: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, V, S, A = Global> <span class="where fmt-newline">where<br> A: Allocator + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span>{
|
||
Occupied(<a class="struct" href="struct.OccupiedEntryRef.html" title="struct hashbrown::hash_map::OccupiedEntryRef">OccupiedEntryRef</a><'a, 'b, K, Q, V, S, A>),
|
||
Vacant(<a class="struct" href="struct.VacantEntryRef.html" title="struct hashbrown::hash_map::VacantEntryRef">VacantEntryRef</a><'a, 'b, K, Q, V, S, A>),
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A view into a single entry in a map, which may either be vacant or occupied,
|
||
with any borrowed form of the map’s key type.</p>
|
||
<p>This <code>enum</code> is constructed from the <a href="struct.HashMap.html#method.entry_ref"><code>entry_ref</code></a> method on <a href="struct.HashMap.html"><code>HashMap</code></a>.</p>
|
||
<p><a href="https://doc.rust-lang.org/std/hash/trait.Hash.html"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/std/cmp/trait.Eq.html"><code>Eq</code></a> on the borrowed form of the map’s key type <em>must</em> match those
|
||
for the key type. It also require that key may be constructed from the borrowed
|
||
form through the <a href="https://doc.rust-lang.org/std/convert/trait.From.html"><code>From</code></a> trait.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::hash_map</span>::{<span class="ident">EntryRef</span>, <span class="ident">HashMap</span>, <span class="ident">OccupiedEntryRef</span>};
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
|
||
<span class="ident">map</span>.<span class="ident">extend</span>([(<span class="string">"a"</span>.<span class="ident">to_owned</span>(), <span class="number">10</span>), (<span class="string">"b"</span>.<span class="ident">into</span>(), <span class="number">20</span>), (<span class="string">"c"</span>.<span class="ident">into</span>(), <span class="number">30</span>)]);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>.<span class="ident">len</span>(), <span class="number">3</span>);
|
||
|
||
<span class="comment">// Existing key (insert)</span>
|
||
<span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">String::from</span>(<span class="string">"a"</span>);
|
||
<span class="kw">let</span> <span class="ident">entry</span>: <span class="ident">EntryRef</span><span class="op"><</span><span class="kw">_</span>, <span class="kw">_</span>, <span class="kw">_</span>, <span class="kw">_</span><span class="op">></span> <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="kw-2">&</span><span class="ident">key</span>);
|
||
<span class="kw">let</span> <span class="ident">_raw_o</span>: <span class="ident">OccupiedEntryRef</span><span class="op"><</span><span class="kw">_</span>, <span class="kw">_</span>, <span class="kw">_</span>, <span class="kw">_</span><span class="op">></span> <span class="op">=</span> <span class="ident">entry</span>.<span class="ident">insert</span>(<span class="number">1</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>.<span class="ident">len</span>(), <span class="number">3</span>);
|
||
<span class="comment">// Nonexistent key (insert)</span>
|
||
<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"d"</span>).<span class="ident">insert</span>(<span class="number">4</span>);
|
||
|
||
<span class="comment">// Existing key (or_insert)</span>
|
||
<span class="kw">let</span> <span class="ident">v</span> <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"b"</span>).<span class="ident">or_insert</span>(<span class="number">2</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">std::mem::replace</span>(<span class="ident">v</span>, <span class="number">2</span>), <span class="number">20</span>);
|
||
<span class="comment">// Nonexistent key (or_insert)</span>
|
||
<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"e"</span>).<span class="ident">or_insert</span>(<span class="number">5</span>);
|
||
|
||
<span class="comment">// Existing key (or_insert_with)</span>
|
||
<span class="kw">let</span> <span class="ident">v</span> <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"c"</span>).<span class="ident">or_insert_with</span>(<span class="op">|</span><span class="op">|</span> <span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">std::mem::replace</span>(<span class="ident">v</span>, <span class="number">3</span>), <span class="number">30</span>);
|
||
<span class="comment">// Nonexistent key (or_insert_with)</span>
|
||
<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"f"</span>).<span class="ident">or_insert_with</span>(<span class="op">|</span><span class="op">|</span> <span class="number">6</span>);
|
||
|
||
<span class="macro">println!</span>(<span class="string">"Our HashMap: {:?}"</span>, <span class="ident">map</span>);
|
||
|
||
<span class="kw">for</span> (<span class="ident">key</span>, <span class="ident">value</span>) <span class="kw">in</span> [<span class="string">"a"</span>, <span class="string">"b"</span>, <span class="string">"c"</span>, <span class="string">"d"</span>, <span class="string">"e"</span>, <span class="string">"f"</span>].<span class="ident">into_iter</span>().<span class="ident">zip</span>(<span class="number">1</span>..<span class="op">=</span><span class="number">6</span>) {
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="ident">key</span>], <span class="ident">value</span>)
|
||
}
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>.<span class="ident">len</span>(), <span class="number">6</span>);</code></pre></div>
|
||
</div></details><h2 id="variants" class="variants small-section-header">Variants<a href="#variants" class="anchor"></a></h2><h3 id="variant.Occupied" class="variant small-section-header"><a href="#variant.Occupied" class="anchor field"></a><code>Occupied(<a class="struct" href="struct.OccupiedEntryRef.html" title="struct hashbrown::hash_map::OccupiedEntryRef">OccupiedEntryRef</a><'a, 'b, K, Q, V, S, A>)</code></h3><div class="docblock"><p>An occupied entry.</p>
|
||
<h4 id="examples-1"><a href="#examples-1">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::hash_map</span>::{<span class="ident">EntryRef</span>, <span class="ident">HashMap</span>};
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="kw">_</span>, <span class="kw">_</span><span class="op">></span> <span class="op">=</span> [(<span class="string">"a"</span>.<span class="ident">to_owned</span>(), <span class="number">100</span>), (<span class="string">"b"</span>.<span class="ident">into</span>(), <span class="number">200</span>)].<span class="ident">into</span>();
|
||
|
||
<span class="kw">match</span> <span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"a"</span>) {
|
||
<span class="ident">EntryRef::Vacant</span>(<span class="kw">_</span>) => <span class="macro">unreachable!</span>(),
|
||
<span class="ident">EntryRef::Occupied</span>(<span class="kw">_</span>) => { }
|
||
}</code></pre></div>
|
||
</div><h3 id="variant.Vacant" class="variant small-section-header"><a href="#variant.Vacant" class="anchor field"></a><code>Vacant(<a class="struct" href="struct.VacantEntryRef.html" title="struct hashbrown::hash_map::VacantEntryRef">VacantEntryRef</a><'a, 'b, K, Q, V, S, A>)</code></h3><div class="docblock"><p>A vacant entry.</p>
|
||
<h4 id="examples-2"><a href="#examples-2">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::hash_map</span>::{<span class="ident">EntryRef</span>, <span class="ident">HashMap</span>};
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">i32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
|
||
|
||
<span class="kw">match</span> <span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"a"</span>) {
|
||
<span class="ident">EntryRef::Occupied</span>(<span class="kw">_</span>) => <span class="macro">unreachable!</span>(),
|
||
<span class="ident">EntryRef::Vacant</span>(<span class="kw">_</span>) => { }
|
||
}</code></pre></div>
|
||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#5595-5844">source</a></span><a href="#impl-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'b, K, Q: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, V, S, A: Allocator + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="enum" href="enum.EntryRef.html" title="enum hashbrown::hash_map::EntryRef">EntryRef</a><'a, 'b, K, Q, V, S, A></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.insert" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#5609-5621">source</a></span><h4 class="code-header">pub fn <a href="#method.insert" class="fnname">insert</a>(self, value: V) -> <a class="struct" href="struct.OccupiedEntryRef.html" title="struct hashbrown::hash_map::OccupiedEntryRef">OccupiedEntryRef</a><'a, 'b, K, Q, V, S, A> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'b </a>Q>,<br> S: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></h4></section></summary><div class="docblock"><p>Sets the value of the entry, and returns an OccupiedEntryRef.</p>
|
||
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::HashMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
|
||
<span class="kw">let</span> <span class="ident">entry</span> <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"horseyland"</span>).<span class="ident">insert</span>(<span class="number">37</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">entry</span>.<span class="ident">key</span>(), <span class="string">"horseyland"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.or_insert" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#5642-5651">source</a></span><h4 class="code-header">pub fn <a href="#method.or_insert" class="fnname">or_insert</a>(self, default: V) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'a mut </a>V <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'b </a>Q>,<br> S: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></h4></section></summary><div class="docblock"><p>Ensures a value is in the entry by inserting the default if empty, and returns
|
||
a mutable reference to the value in the entry.</p>
|
||
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::HashMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
|
||
|
||
<span class="comment">// nonexistent key</span>
|
||
<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert</span>(<span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">3</span>);
|
||
|
||
<span class="comment">// existing key</span>
|
||
<span class="kw-2">*</span><span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert</span>(<span class="number">10</span>) <span class="kw-2">*</span><span class="op">=</span> <span class="number">2</span>;
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">6</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.or_insert_with" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#5672-5681">source</a></span><h4 class="code-header">pub fn <a href="#method.or_insert_with" class="fnname">or_insert_with</a><F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> V>(self, default: F) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'a mut </a>V <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'b </a>Q>,<br> S: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></h4></section></summary><div class="docblock"><p>Ensures a value is in the entry by inserting the result of the default function if empty,
|
||
and returns a mutable reference to the value in the entry.</p>
|
||
<h5 id="examples-5"><a href="#examples-5">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::HashMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
|
||
|
||
<span class="comment">// nonexistent key</span>
|
||
<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert_with</span>(<span class="op">|</span><span class="op">|</span> <span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">3</span>);
|
||
|
||
<span class="comment">// existing key</span>
|
||
<span class="kw-2">*</span><span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert_with</span>(<span class="op">|</span><span class="op">|</span> <span class="number">10</span>) <span class="kw-2">*</span><span class="op">=</span> <span class="number">2</span>;
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">6</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.or_insert_with_key" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#5706-5718">source</a></span><h4 class="code-header">pub fn <a href="#method.or_insert_with_key" class="fnname">or_insert_with_key</a><F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>Q) -> V>(self, default: F) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'a mut </a>V <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><Q> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'b </a>Q>,<br> S: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></h4></section></summary><div class="docblock"><p>Ensures a value is in the entry by inserting, if empty, the result of the default function.
|
||
This method allows for generating key-derived values for insertion by providing the default
|
||
function a reference to the key that was moved during the <code>.entry_ref(key)</code> method call.</p>
|
||
<p>The reference to the moved key is provided so that cloning or copying the key is
|
||
unnecessary, unlike with <code>.or_insert_with(|| ... )</code>.</p>
|
||
<h5 id="examples-6"><a href="#examples-6">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::HashMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">usize</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
|
||
|
||
<span class="comment">// nonexistent key</span>
|
||
<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert_with_key</span>(<span class="op">|</span><span class="ident">key</span><span class="op">|</span> <span class="ident">key</span>.<span class="ident">chars</span>().<span class="ident">count</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">9</span>);
|
||
|
||
<span class="comment">// existing key</span>
|
||
<span class="kw-2">*</span><span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert_with_key</span>(<span class="op">|</span><span class="ident">key</span><span class="op">|</span> <span class="ident">key</span>.<span class="ident">chars</span>().<span class="ident">count</span>() <span class="op">*</span> <span class="number">10</span>) <span class="kw-2">*</span><span class="op">=</span> <span class="number">2</span>;
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">18</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.key" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#5735-5743">source</a></span><h4 class="code-header">pub fn <a href="#method.key" class="fnname">key</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>Q <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><Q>, </span></h4></section></summary><div class="docblock"><p>Returns a reference to this entry’s key.</p>
|
||
<h5 id="examples-7"><a href="#examples-7">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::HashMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
|
||
<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert</span>(<span class="number">3</span>);
|
||
<span class="comment">// existing key</span>
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>).<span class="ident">key</span>(), <span class="string">"poneyland"</span>);
|
||
<span class="comment">// nonexistent key</span>
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"horseland"</span>).<span class="ident">key</span>(), <span class="string">"horseland"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.and_modify" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#5766-5777">source</a></span><h4 class="code-header">pub fn <a href="#method.and_modify" class="fnname">and_modify</a><F>(self, f: F) -> Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>V), </span></h4></section></summary><div class="docblock"><p>Provides in-place mutable access to an occupied entry before any
|
||
potential inserts into the map.</p>
|
||
<h5 id="examples-8"><a href="#examples-8">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::HashMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
|
||
|
||
<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>)
|
||
.<span class="ident">and_modify</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> { <span class="kw-2">*</span><span class="ident">e</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span> })
|
||
.<span class="ident">or_insert</span>(<span class="number">42</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">42</span>);
|
||
|
||
<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>)
|
||
.<span class="ident">and_modify</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> { <span class="kw-2">*</span><span class="ident">e</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span> })
|
||
.<span class="ident">or_insert</span>(<span class="number">42</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">43</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.and_replace_entry_with" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#5834-5843">source</a></span><h4 class="code-header">pub fn <a href="#method.and_replace_entry_with" class="fnname">and_replace_entry_with</a><F>(self, f: F) -> Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>Q, V) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V>,<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><Q>, </span></h4></section></summary><div class="docblock"><p>Provides shared access to the key and owned access to the value of
|
||
an occupied entry and allows to replace or remove it based on the
|
||
value of the returned option.</p>
|
||
<h5 id="examples-9"><a href="#examples-9">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::HashMap</span>;
|
||
<span class="kw">use</span> <span class="ident">hashbrown::hash_map::EntryRef</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">entry</span> <span class="op">=</span> <span class="ident">map</span>
|
||
.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>)
|
||
.<span class="ident">and_replace_entry_with</span>(<span class="op">|</span><span class="ident">_k</span>, <span class="ident">_v</span><span class="op">|</span> <span class="macro">panic!</span>());
|
||
|
||
<span class="kw">match</span> <span class="ident">entry</span> {
|
||
<span class="ident">EntryRef::Vacant</span>(<span class="ident">e</span>) => {
|
||
<span class="macro">assert_eq!</span>(<span class="ident">e</span>.<span class="ident">key</span>(), <span class="string">"poneyland"</span>);
|
||
}
|
||
<span class="ident">EntryRef::Occupied</span>(<span class="kw">_</span>) => <span class="macro">panic!</span>(),
|
||
}
|
||
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">"poneyland"</span>.<span class="ident">to_string</span>(), <span class="number">42</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">entry</span> <span class="op">=</span> <span class="ident">map</span>
|
||
.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>)
|
||
.<span class="ident">and_replace_entry_with</span>(<span class="op">|</span><span class="ident">k</span>, <span class="ident">v</span><span class="op">|</span> {
|
||
<span class="macro">assert_eq!</span>(<span class="ident">k</span>, <span class="string">"poneyland"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">v</span>, <span class="number">42</span>);
|
||
<span class="prelude-val">Some</span>(<span class="ident">v</span> <span class="op">+</span> <span class="number">1</span>)
|
||
});
|
||
|
||
<span class="kw">match</span> <span class="ident">entry</span> {
|
||
<span class="ident">EntryRef::Occupied</span>(<span class="ident">e</span>) => {
|
||
<span class="macro">assert_eq!</span>(<span class="ident">e</span>.<span class="ident">key</span>(), <span class="string">"poneyland"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">e</span>.<span class="ident">get</span>(), <span class="kw-2">&</span><span class="number">43</span>);
|
||
}
|
||
<span class="ident">EntryRef::Vacant</span>(<span class="kw">_</span>) => <span class="macro">panic!</span>(),
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">43</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">entry</span> <span class="op">=</span> <span class="ident">map</span>
|
||
.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>)
|
||
.<span class="ident">and_replace_entry_with</span>(<span class="op">|</span><span class="ident">_k</span>, <span class="ident">_v</span><span class="op">|</span> <span class="prelude-val">None</span>);
|
||
|
||
<span class="kw">match</span> <span class="ident">entry</span> {
|
||
<span class="ident">EntryRef::Vacant</span>(<span class="ident">e</span>) => <span class="macro">assert_eq!</span>(<span class="ident">e</span>.<span class="ident">key</span>(), <span class="string">"poneyland"</span>),
|
||
<span class="ident">EntryRef::Occupied</span>(<span class="kw">_</span>) => <span class="macro">panic!</span>(),
|
||
}
|
||
|
||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">map</span>.<span class="ident">contains_key</span>(<span class="string">"poneyland"</span>));</code></pre></div>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E-1" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#5846-5877">source</a></span><a href="#impl-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E-1" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'b, K, Q: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, V: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>, S, A: Allocator + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="enum" href="enum.EntryRef.html" title="enum hashbrown::hash_map::EntryRef">EntryRef</a><'a, 'b, K, Q, V, S, A></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.or_default" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#5867-5876">source</a></span><h4 class="code-header">pub fn <a href="#method.or_default" class="fnname">or_default</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'a mut </a>V <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'b </a>Q>,<br> S: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></h4></section></summary><div class="docblock"><p>Ensures a value is in the entry by inserting the default value if empty,
|
||
and returns a mutable reference to the value in the entry.</p>
|
||
<h5 id="examples-10"><a href="#examples-10">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">hashbrown::HashMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
|
||
|
||
<span class="comment">// nonexistent key</span>
|
||
<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"poneyland"</span>).<span class="ident">or_default</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="prelude-val">None</span>);
|
||
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">"horseland"</span>.<span class="ident">to_string</span>(), <span class="prelude-val">Some</span>(<span class="number">3</span>));
|
||
|
||
<span class="comment">// existing key</span>
|
||
<span class="macro">assert_eq!</span>(<span class="ident">map</span>.<span class="ident">entry_ref</span>(<span class="string">"horseland"</span>).<span class="ident">or_default</span>(), <span class="kw-2">&mut</span> <span class="prelude-val">Some</span>(<span class="number">3</span>));</code></pre></div>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-EntryRef%3C%27_%2C%20%27_%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#4356-4365">source</a></span><a href="#impl-Debug-for-EntryRef%3C%27_%2C%20%27_%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><Q>, Q: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, V: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, S, A: Allocator + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="enum.EntryRef.html" title="enum hashbrown::hash_map::EntryRef">EntryRef</a><'_, '_, K, Q, V, S, A></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/hashbrown/map.rs.html#4359-4364">source</a></span><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'b, K, Q: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, V, S, A> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="enum.EntryRef.html" title="enum hashbrown::hash_map::EntryRef">EntryRef</a><'a, 'b, K, Q, V, S, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,<br> Q: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>, </span></h3></section><section id="impl-Send-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><a href="#impl-Send-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'b, K, Q: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, V, S, A> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="enum.EntryRef.html" title="enum hashbrown::hash_map::EntryRef">EntryRef</a><'a, 'b, K, Q, V, S, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> Q: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></h3></section><section id="impl-Sync-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><a href="#impl-Sync-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'b, K, Q: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, V, S, A> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="enum.EntryRef.html" title="enum hashbrown::hash_map::EntryRef">EntryRef</a><'a, 'b, K, Q, V, S, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> Q: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></h3></section><section id="impl-Unpin-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><a href="#impl-Unpin-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'b, K, Q: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, V, S, A> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="enum.EntryRef.html" title="enum hashbrown::hash_map::EntryRef">EntryRef</a><'a, 'b, K, Q, V, S, A> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></h3></section><section id="impl-UnwindSafe-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'b, K, Q, V, S, A = Global> !<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="enum.EntryRef.html" title="enum hashbrown::hash_map::EntryRef">EntryRef</a><'a, 'b, K, Q, V, S, A></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#203">source</a></span><a href="#impl-Any-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#204">source</a></span><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#209">source</a></span><a href="#impl-Borrow%3CT%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#211">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#218">source</a></span><a href="#impl-BorrowMut%3CT%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#219">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#557">source</a></span><a href="#impl-From%3CT%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#559">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#541">source</a></span><a href="#impl-Into%3CU%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#549">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#598">source</a></span><a href="#impl-TryFrom%3CU%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#604">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#583">source</a></span><a href="#impl-TryInto%3CU%3E-for-EntryRef%3C%27a%2C%20%27b%2C%20K%2C%20Q%2C%20V%2C%20S%2C%20A%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#589">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hashbrown" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |