mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-30 13:54:09 +01:00
201 lines
45 KiB
HTML
201 lines
45 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 `OccupiedEntry` struct in crate `hashbrown`."><meta name="keywords" content="rust, rustlang, rust-lang, OccupiedEntry"><title>hashbrown::hash_map::OccupiedEntry - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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='../../hashbrown/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Struct OccupiedEntry</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.get">get</a><a href="#method.get_mut">get_mut</a><a href="#method.insert">insert</a><a href="#method.into_mut">into_mut</a><a href="#method.key">key</a><a href="#method.remove">remove</a><a href="#method.remove_entry">remove_entry</a><a href="#method.replace_entry">replace_entry</a><a href="#method.replace_entry_with">replace_entry_with</a><a href="#method.replace_key">replace_key</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Unpin">Unpin</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">hashbrown</a>::<wbr><a href="index.html">hash_map</a></p><div id="sidebar-vars" data-name="OccupiedEntry" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">hashbrown</a>::<wbr><a href="index.html">hash_map</a>::<wbr><a class="struct" href="">OccupiedEntry</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 class="srclink" href="../../src/hashbrown/map.rs.html#2054-2059" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct OccupiedEntry<'a, K, V, S> { /* fields omitted */ }</pre></div><div class="docblock"><p>A view into an occupied entry in a <code>HashMap</code>.
|
||
It is part of the <a href="enum.Entry.html"><code>Entry</code></a> enum.</p>
|
||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<'a, K, V, S> <a class="struct" href="../../hashbrown/hash_map/struct.OccupiedEntry.html" title="struct hashbrown::hash_map::OccupiedEntry">OccupiedEntry</a><'a, K, V, S></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/hashbrown/map.rs.html#2611-2915" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.key" class="method"><code>pub fn <a href="#method.key" class="fnname">key</a>(&self) -> &K</code><a class="srclink" href="../../src/hashbrown/map.rs.html#2624-2626" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets a reference to the key in the entry.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">hashbrown</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-2">&</span><span class="ident">str</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert</span>(<span class="number">12</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>).<span class="ident">key</span>(), <span class="kw-2">&</span><span class="string">"poneyland"</span>);</pre></div>
|
||
</div><h4 id="method.remove_entry" class="method"><code>pub fn <a href="#method.remove_entry" class="fnname">remove_entry</a>(self) -> (K, V)</code><a class="srclink" href="../../src/hashbrown/map.rs.html#2647-2649" title="goto source code">[src]</a></h4><div class="docblock"><p>Take the ownership of the key and value from the map.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">HashMap</span>;
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">hash_map</span>::<span class="ident">Entry</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-2">&</span><span class="ident">str</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert</span>(<span class="number">12</span>);
|
||
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">o</span>) <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>) {
|
||
<span class="comment">// We delete the entry from the map.</span>
|
||
<span class="ident">o</span>.<span class="ident">remove_entry</span>();
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>.<span class="ident">contains_key</span>(<span class="string">"poneyland"</span>), <span class="bool-val">false</span>);</pre></div>
|
||
</div><h4 id="method.get" class="method"><code>pub fn <a href="#method.get" class="fnname">get</a>(&self) -> &V</code><a class="srclink" href="../../src/hashbrown/map.rs.html#2667-2669" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets a reference to the value in the entry.</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">HashMap</span>;
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">hash_map</span>::<span class="ident">Entry</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-2">&</span><span class="ident">str</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert</span>(<span class="number">12</span>);
|
||
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">o</span>) <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>) {
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">o</span>.<span class="ident">get</span>(), <span class="kw-2">&</span><span class="number">12</span>);
|
||
}</pre></div>
|
||
</div><h4 id="method.get_mut" class="method"><code>pub fn <a href="#method.get_mut" class="fnname">get_mut</a>(&mut self) -> &mut V</code><a class="srclink" href="../../src/hashbrown/map.rs.html#2699-2701" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets a mutable reference to the value in the entry.</p>
|
||
<p>If you need a reference to the <code>OccupiedEntry</code> which may outlive the
|
||
destruction of the <code>Entry</code> value, see <a href="#method.into_mut"><code>into_mut</code></a>.</p>
|
||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">HashMap</span>;
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">hash_map</span>::<span class="ident">Entry</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-2">&</span><span class="ident">str</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert</span>(<span class="number">12</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">12</span>);
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="kw-2">mut</span> <span class="ident">o</span>) <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>) {
|
||
<span class="kw-2">*</span><span class="ident">o</span>.<span class="ident">get_mut</span>() <span class="op">+</span><span class="op">=</span> <span class="number">10</span>;
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">o</span>.<span class="ident">get</span>(), <span class="number">22</span>);
|
||
|
||
<span class="comment">// We can use the same Entry multiple times.</span>
|
||
<span class="kw-2">*</span><span class="ident">o</span>.<span class="ident">get_mut</span>() <span class="op">+</span><span class="op">=</span> <span class="number">2</span>;
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">24</span>);</pre></div>
|
||
</div><h4 id="method.into_mut" class="method"><code>pub fn <a href="#method.into_mut" class="fnname">into_mut</a>(self) -> &'a mut V</code><a class="srclink" href="../../src/hashbrown/map.rs.html#2727-2729" title="goto source code">[src]</a></h4><div class="docblock"><p>Converts the OccupiedEntry into a mutable reference to the value in the entry
|
||
with a lifetime bound to the map itself.</p>
|
||
<p>If you need multiple references to the <code>OccupiedEntry</code>, see <a href="#method.get_mut"><code>get_mut</code></a>.</p>
|
||
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">HashMap</span>;
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">hash_map</span>::<span class="ident">Entry</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-2">&</span><span class="ident">str</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert</span>(<span class="number">12</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">12</span>);
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">o</span>) <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>) {
|
||
<span class="kw-2">*</span><span class="ident">o</span>.<span class="ident">into_mut</span>() <span class="op">+</span><span class="op">=</span> <span class="number">10</span>;
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">22</span>);</pre></div>
|
||
</div><h4 id="method.insert" class="method"><code>pub fn <a href="#method.insert" class="fnname">insert</a>(&mut self, value: V) -> V</code><a class="srclink" href="../../src/hashbrown/map.rs.html#2749-2753" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the value of the entry, and returns the entry's old value.</p>
|
||
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">HashMap</span>;
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">hash_map</span>::<span class="ident">Entry</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-2">&</span><span class="ident">str</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert</span>(<span class="number">12</span>);
|
||
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="kw-2">mut</span> <span class="ident">o</span>) <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>) {
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">o</span>.<span class="ident">insert</span>(<span class="number">15</span>), <span class="number">12</span>);
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"poneyland"</span>], <span class="number">15</span>);</pre></div>
|
||
</div><h4 id="method.remove" class="method"><code>pub fn <a href="#method.remove" class="fnname">remove</a>(self) -> V</code><a class="srclink" href="../../src/hashbrown/map.rs.html#2773-2775" title="goto source code">[src]</a></h4><div class="docblock"><p>Takes the value out of the entry, and returns it.</p>
|
||
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">HashMap</span>;
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">hash_map</span>::<span class="ident">Entry</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-2">&</span><span class="ident">str</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>).<span class="ident">or_insert</span>(<span class="number">12</span>);
|
||
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">o</span>) <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>) {
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">o</span>.<span class="ident">remove</span>(), <span class="number">12</span>);
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>.<span class="ident">contains_key</span>(<span class="string">"poneyland"</span>), <span class="bool-val">false</span>);</pre></div>
|
||
</div><h4 id="method.replace_entry" class="method"><code>pub fn <a href="#method.replace_entry" class="fnname">replace_entry</a>(self, value: V) -> (K, V)</code><a class="srclink" href="../../src/hashbrown/map.rs.html#2798-2805" title="goto source code">[src]</a></h4><div class="docblock"><p>Replaces the entry, returning the old key and value. The new key in the hash map will be
|
||
the key used to create this entry.</p>
|
||
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">hash_map</span>::{<span class="ident">Entry</span>, <span class="ident">HashMap</span>};
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">rc</span>::<span class="ident">Rc</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">Rc</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="ident">Rc</span>::<span class="ident">new</span>(<span class="string">"Stringthing"</span>.<span class="ident">to_string</span>()), <span class="number">15</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">my_key</span> <span class="op">=</span> <span class="ident">Rc</span>::<span class="ident">new</span>(<span class="string">"Stringthing"</span>.<span class="ident">to_string</span>());
|
||
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">entry</span>) <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="ident">my_key</span>) {
|
||
<span class="comment">// Also replace the key with a handle to our other key.</span>
|
||
<span class="kw">let</span> (<span class="ident">old_key</span>, <span class="ident">old_value</span>): (<span class="ident">Rc</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="ident">u32</span>) <span class="op">=</span> <span class="ident">entry</span>.<span class="ident">replace_entry</span>(<span class="number">16</span>);
|
||
}
|
||
</pre></div>
|
||
</div><h4 id="method.replace_key" class="method"><code>pub fn <a href="#method.replace_key" class="fnname">replace_key</a>(self) -> K</code><a class="srclink" href="../../src/hashbrown/map.rs.html#2832-2835" title="goto source code">[src]</a></h4><div class="docblock"><p>Replaces the key in the hash map with the key used to create this entry.</p>
|
||
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">hash_map</span>::{<span class="ident">Entry</span>, <span class="ident">HashMap</span>};
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">rc</span>::<span class="ident">Rc</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">Rc</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">known_strings</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">Rc</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">new</span>();
|
||
|
||
<span class="comment">// Initialise known strings, run program, etc.</span>
|
||
|
||
<span class="ident">reclaim_memory</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">map</span>, <span class="kw-2">&</span><span class="ident">known_strings</span>);
|
||
|
||
<span class="kw">fn</span> <span class="ident">reclaim_memory</span>(<span class="ident">map</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">HashMap</span><span class="op"><</span><span class="ident">Rc</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="ident">u32</span><span class="op">></span>, <span class="ident">known_strings</span>: <span class="kw-2">&</span>[<span class="ident">Rc</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>] ) {
|
||
<span class="kw">for</span> <span class="ident">s</span> <span class="kw">in</span> <span class="ident">known_strings</span> {
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">entry</span>) <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="ident">s</span>.<span class="ident">clone</span>()) {
|
||
<span class="comment">// Replaces the entry's key with our version of it in `known_strings`.</span>
|
||
<span class="ident">entry</span>.<span class="ident">replace_key</span>();
|
||
}
|
||
}
|
||
}</pre></div>
|
||
</div><h4 id="method.replace_entry_with" class="method"><code>pub fn <a href="#method.replace_entry_with" class="fnname">replace_entry_with</a><F>(self, f: F) -> <a class="enum" href="../../hashbrown/hash_map/enum.Entry.html" title="enum hashbrown::hash_map::Entry">Entry</a><'a, K, V, S> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&K, V) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V>, </span></code><a class="srclink" href="../../src/hashbrown/map.rs.html#2886-2914" title="goto source code">[src]</a></h4><div class="docblock"><p>Provides shared access to the key and owned access to the value of
|
||
the entry and allows to replace or remove it based on the
|
||
value of the returned option.</p>
|
||
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">HashMap</span>;
|
||
<span class="kw">use</span> <span class="ident">hashbrown</span>::<span class="ident">hash_map</span>::<span class="ident">Entry</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-2">&</span><span class="ident">str</span>, <span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">"poneyland"</span>, <span class="number">42</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">entry</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>) {
|
||
<span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> {
|
||
<span class="ident">e</span>.<span class="ident">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="macro">!</span>(<span class="ident">k</span>, <span class="kw-2">&</span><span class="string">"poneyland"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</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="ident">Entry</span>::<span class="ident">Vacant</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(),
|
||
};
|
||
|
||
<span class="kw">match</span> <span class="ident">entry</span> {
|
||
<span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> {
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="ident">key</span>(), <span class="kw-2">&</span><span class="string">"poneyland"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="ident">get</span>(), <span class="kw-2">&</span><span class="number">43</span>);
|
||
}
|
||
<span class="ident">Entry</span>::<span class="ident">Vacant</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(),
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</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="kw">match</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"poneyland"</span>) {
|
||
<span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="ident">e</span>.<span class="ident">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="ident">Entry</span>::<span class="ident">Vacant</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(),
|
||
};
|
||
|
||
<span class="kw">match</span> <span class="ident">entry</span> {
|
||
<span class="ident">Entry</span>::<span class="ident">Vacant</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> {
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="ident">key</span>(), <span class="kw-2">&</span><span class="string">"poneyland"</span>);
|
||
}
|
||
<span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(),
|
||
}
|
||
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">map</span>.<span class="ident">contains_key</span>(<span class="string">"poneyland"</span>));</pre></div>
|
||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl<K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../hashbrown/hash_map/struct.OccupiedEntry.html" title="struct hashbrown::hash_map::OccupiedEntry">OccupiedEntry</a><'_, K, V, S></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/hashbrown/map.rs.html#2076-2083" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/hashbrown/map.rs.html#2077-2082" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../hashbrown/hash_map/struct.OccupiedEntry.html" title="struct hashbrown::hash_map::OccupiedEntry">OccupiedEntry</a><'_, K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../../src/hashbrown/map.rs.html#2061-2067" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../hashbrown/hash_map/struct.OccupiedEntry.html" title="struct hashbrown::hash_map::OccupiedEntry">OccupiedEntry</a><'_, K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../../src/hashbrown/map.rs.html#2068-2074" title="goto source code">[src]</a></h3><div class="impl-items"></div></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"><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<'a, K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../hashbrown/hash_map/struct.OccupiedEntry.html" title="struct hashbrown::hash_map::OccupiedEntry">OccupiedEntry</a><'a, K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href="#impl-Unpin" class="anchor"></a><a class="srclink" href="../../src/hashbrown/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> &T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> &mut T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hashbrown"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |