747 lines
160 KiB
HTML
747 lines
160 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 `HashMap` using `RandomState` to hash the items. (Requires the `std` feature to be enabled.)"><title>AHashMap in ahash - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="ahash" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../ahash/index.html">ahash</a><span class="version">0.8.11</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">AHash<wbr>Map</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.get" title="get">get</a></li><li><a href="#method.get_key_value" title="get_key_value">get_key_value</a></li><li><a href="#method.get_mut" title="get_mut">get_mut</a></li><li><a href="#method.insert" title="insert">insert</a></li><li><a href="#method.into_keys" title="into_keys">into_keys</a></li><li><a href="#method.into_values" title="into_values">into_values</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.remove" title="remove">remove</a></li><li><a href="#method.with_capacity" title="with_capacity">with_capacity</a></li><li><a href="#method.with_capacity_and_hasher" title="with_capacity_and_hasher">with_capacity_and_hasher</a></li><li><a href="#method.with_hasher" title="with_hasher">with_hasher</a></li></ul><h3><a href="#deref-methods-HashMap%3CK,+V,+S%3E">Methods from Deref<<wbr>Target=<wbr>Hash<wbr>Map<<wbr>K, V, S>></a></h3><ul class="block deref-methods"><li><a href="#method.capacity" title="capacity">capacity</a></li><li><a href="#method.clear" title="clear">clear</a></li><li><a href="#method.contains_key" title="contains_key">contains_key</a></li><li><a href="#method.drain" title="drain">drain</a></li><li><a href="#method.entry" title="entry">entry</a></li><li><a href="#method.extract_if" title="extract_if">extract_if</a></li><li><a href="#method.get-1" title="get">get</a></li><li><a href="#method.get_key_value-1" title="get_key_value">get_key_value</a></li><li><a href="#method.get_many_mut" title="get_many_mut">get_many_mut</a></li><li><a href="#method.get_many_unchecked_mut" title="get_many_unchecked_mut">get_many_unchecked_mut</a></li><li><a href="#method.get_mut-1" title="get_mut">get_mut</a></li><li><a href="#method.hasher" title="hasher">hasher</a></li><li><a href="#method.insert-1" title="insert">insert</a></li><li><a href="#method.is_empty" title="is_empty">is_empty</a></li><li><a href="#method.iter" title="iter">iter</a></li><li><a href="#method.iter_mut" title="iter_mut">iter_mut</a></li><li><a href="#method.keys" title="keys">keys</a></li><li><a href="#method.len" title="len">len</a></li><li><a href="#method.raw_entry" title="raw_entry">raw_entry</a></li><li><a href="#method.raw_entry_mut" title="raw_entry_mut">raw_entry_mut</a></li><li><a href="#method.remove-1" title="remove">remove</a></li><li><a href="#method.remove_entry" title="remove_entry">remove_entry</a></li><li><a href="#method.reserve" title="reserve">reserve</a></li><li><a href="#method.retain" title="retain">retain</a></li><li><a href="#method.shrink_to" title="shrink_to">shrink_to</a></li><li><a href="#method.shrink_to_fit" title="shrink_to_fit">shrink_to_fit</a></li><li><a href="#method.try_insert" title="try_insert">try_insert</a></li><li><a href="#method.try_reserve" title="try_reserve">try_reserve</a></li><li><a href="#method.values" title="values">values</a></li><li><a href="#method.values_mut" title="values_mut">values_mut</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-AHashMap%3CK,+V,+S%3E" title="Clone">Clone</a></li><li><a href="#impl-Debug-for-AHashMap%3CK,+V,+S%3E" title="Debug">Debug</a></li><li><a href="#impl-Default-for-AHashMap%3CK,+V%3E" title="Default">Default</a></li><li><a href="#impl-Deref-for-AHashMap%3CK,+V,+S%3E" title="Deref">Deref</a></li><li><a href="#impl-DerefMut-for-AHashMap%3CK,+V,+S%3E" title="DerefMut">DerefMut</a></li><li><a href="#impl-Eq-for-AHashMap%3CK,+V,+S%3E" title="Eq">Eq</a></li><li><a href="#impl-Extend%3C(%26K,+%26V)%3E-for-AHashMap%3CK,+V,+S%3E" title="Extend<(&'a K, &'a V)>">Extend<(&'a K, &'a V)></a></li><li><a href="#impl-Extend%3C(K,+V)%3E-for-AHashMap%3CK,+V,+S%3E" title="Extend<(K, V)>">Extend<(K, V)></a></li><li><a href="#impl-From%3CHashMap%3CK,+V,+RandomState%3E%3E-for-AHashMap%3CK,+V%3E" title="From<HashMap<K, V, RandomState>>">From<HashMap<K, V, RandomState>></a></li><li><a href="#impl-From%3C%5B(K,+V);+N%5D%3E-for-AHashMap%3CK,+V%3E" title="From<[(K, V); N]>">From<[(K, V); N]></a></li><li><a href="#impl-FromIterator%3C(K,+V)%3E-for-AHashMap%3CK,+V%3E" title="FromIterator<(K, V)>">FromIterator<(K, V)></a></li><li><a href="#impl-Index%3C%26Q%3E-for-AHashMap%3CK,+V,+S%3E" title="Index<&Q>">Index<&Q></a></li><li><a href="#impl-Into%3CHashMap%3CK,+V,+RandomState%3E%3E-for-AHashMap%3CK,+V%3E" title="Into<HashMap<K, V, RandomState>>">Into<HashMap<K, V, RandomState>></a></li><li><a href="#impl-IntoIterator-for-%26AHashMap%3CK,+V,+S%3E" title="IntoIterator">IntoIterator</a></li><li><a href="#impl-IntoIterator-for-%26mut+AHashMap%3CK,+V,+S%3E" title="IntoIterator">IntoIterator</a></li><li><a href="#impl-IntoIterator-for-AHashMap%3CK,+V,+S%3E" title="IntoIterator">IntoIterator</a></li><li><a href="#impl-PartialEq-for-AHashMap%3CK,+V,+S%3E" title="PartialEq">PartialEq</a></li><li><a href="#impl-UnwindSafe-for-AHashMap%3CK,+V,+S%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-AHashMap%3CK,+V,+S%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-AHashMap%3CK,+V,+S%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-AHashMap%3CK,+V,+S%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-AHashMap%3CK,+V,+S%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-AHashMap%3CK,+V,+S%3E" title="Unpin">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-Receiver-for-P" title="Receiver">Receiver</a></li><li><a href="#impl-ToOwned-for-T" title="ToOwned">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate ahash</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">ahash</a></span><h1>Struct <span class="struct">AHashMap</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/ahash/hash_map.rs.html#21">Source</a> </span></div><pre class="rust item-decl"><code>pub struct AHashMap<K, V, S = <a class="struct" href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState">RandomState</a>>(<span class="comment">/* private fields */</span>);</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A <a href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap"><code>HashMap</code></a> using <a href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState"><code>RandomState</code></a> to hash the items.
|
||
(Requires the <code>std</code> feature to be enabled.)</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-AHashMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#53-65">Source</a><a href="#impl-AHashMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, <a class="struct" href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState">RandomState</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#56-58">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -> Self</h4></section></summary><div class="docblock"><p>This crates a hashmap using <a href="random_state/struct.RandomState.html#method.new" title="associated function ahash::random_state::RandomState::new">RandomState::new</a> which obtains its keys from [RandomSource].
|
||
See the documentation in [RandomSource] for notes about key strength.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_capacity" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#62-64">Source</a><h4 class="code-header">pub fn <a href="#method.with_capacity" class="fn">with_capacity</a>(capacity: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> Self</h4></section></summary><div class="docblock"><p>This crates a hashmap with the specified capacity using <a href="random_state/struct.RandomState.html#method.new" title="associated function ahash::random_state::RandomState::new">RandomState::new</a>.
|
||
See the documentation in [RandomSource] for notes about key strength.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#67-78">Source</a><a href="#impl-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section></summary><div class="impl-items"><section id="method.with_hasher" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#71-73">Source</a><h4 class="code-header">pub fn <a href="#method.with_hasher" class="fn">with_hasher</a>(hash_builder: S) -> Self</h4></section><section id="method.with_capacity_and_hasher" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#75-77">Source</a><h4 class="code-header">pub fn <a href="#method.with_capacity_and_hasher" class="fn">with_capacity_and_hasher</a>(capacity: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, hash_builder: S) -> Self</h4></section></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AHashMap%3CK,+V,+S%3E-1" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#80-276">Source</a><a href="#impl-AHashMap%3CK,+V,+S%3E-1" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#102-108">Source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a><Q>(&self, k: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&V</a>><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Returns a reference to the value corresponding to the key.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but
|
||
<a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
|
||
the key type.</p>
|
||
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="macro">assert_eq!</span>(map.get(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">"a"</span>));
|
||
<span class="macro">assert_eq!</span>(map.get(<span class="kw-2">&</span><span class="number">2</span>), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_key_value" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#127-133">Source</a><h4 class="code-header">pub fn <a href="#method.get_key_value" class="fn">get_key_value</a><Q>(&self, k: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&V</a>)><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Returns the key-value pair corresponding to the supplied key.</p>
|
||
<p>The supplied key may be any borrowed form of the map’s key type, but
|
||
<a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
|
||
the key type.</p>
|
||
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="macro">assert_eq!</span>(map.get_key_value(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">Some</span>((<span class="kw-2">&</span><span class="number">1</span>, <span class="kw-2">&</span><span class="string">"a"</span>)));
|
||
<span class="macro">assert_eq!</span>(map.get_key_value(<span class="kw-2">&</span><span class="number">2</span>), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#154-160">Source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fn">get_mut</a><Q>(&mut self, k: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the value corresponding to the key.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but
|
||
<a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
|
||
the key type.</p>
|
||
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="kw">if let </span><span class="prelude-val">Some</span>(x) = map.get_mut(<span class="kw-2">&</span><span class="number">1</span>) {
|
||
<span class="kw-2">*</span>x = <span class="string">"b"</span>;
|
||
}
|
||
<span class="macro">assert_eq!</span>(map[<span class="kw-2">&</span><span class="number">1</span>], <span class="string">"b"</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#185-187">Source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>(&mut self, k: K, v: V) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V></h4></section></summary><div class="docblock"><p>Inserts a key-value pair into the map.</p>
|
||
<p>If the map did not have this key present, <a href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a> is returned.</p>
|
||
<p>If the map did have this key present, the value is updated, and the old
|
||
value is returned. The key is not updated, though; this matters for
|
||
types that can be <code>==</code> without being identical. See the [module-level
|
||
documentation] for more.</p>
|
||
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
<span class="macro">assert_eq!</span>(map.insert(<span class="number">37</span>, <span class="string">"a"</span>), <span class="prelude-val">None</span>);
|
||
<span class="macro">assert_eq!</span>(map.is_empty(), <span class="bool-val">false</span>);
|
||
|
||
map.insert(<span class="number">37</span>, <span class="string">"b"</span>);
|
||
<span class="macro">assert_eq!</span>(map.insert(<span class="number">37</span>, <span class="string">"c"</span>), <span class="prelude-val">Some</span>(<span class="string">"b"</span>));
|
||
<span class="macro">assert_eq!</span>(map[<span class="kw-2">&</span><span class="number">37</span>], <span class="string">"c"</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_keys" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#216-218">Source</a><h4 class="code-header">pub fn <a href="#method.into_keys" class="fn">into_keys</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.IntoKeys.html" title="struct std::collections::hash::map::IntoKeys">IntoKeys</a><K, V></h4></section></summary><div class="docblock"><p>Creates a consuming iterator visiting all the keys in arbitrary order.
|
||
The map cannot be used after calling this.
|
||
The iterator element type is <code>K</code>.</p>
|
||
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span>map = HashMap::from([
|
||
(<span class="string">"a"</span>, <span class="number">1</span>),
|
||
(<span class="string">"b"</span>, <span class="number">2</span>),
|
||
(<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]);
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>vec: Vec<<span class="kw-2">&</span>str> = map.into_keys().collect();
|
||
<span class="comment">// The `IntoKeys` iterator produces keys in arbitrary order, so the
|
||
// keys must be sorted to test them against a sorted array.
|
||
</span>vec.sort_unstable();
|
||
<span class="macro">assert_eq!</span>(vec, [<span class="string">"a"</span>, <span class="string">"b"</span>, <span class="string">"c"</span>]);</code></pre></div>
|
||
<h5 id="performance"><a class="doc-anchor" href="#performance">§</a>Performance</h5>
|
||
<p>In the current implementation, iterating over keys takes O(capacity) time
|
||
instead of O(len) because it internally visits empty buckets too.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_values" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#247-249">Source</a><h4 class="code-header">pub fn <a href="#method.into_values" class="fn">into_values</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.IntoValues.html" title="struct std::collections::hash::map::IntoValues">IntoValues</a><K, V></h4></section></summary><div class="docblock"><p>Creates a consuming iterator visiting all the values in arbitrary order.
|
||
The map cannot be used after calling this.
|
||
The iterator element type is <code>V</code>.</p>
|
||
<h5 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span>map = HashMap::from([
|
||
(<span class="string">"a"</span>, <span class="number">1</span>),
|
||
(<span class="string">"b"</span>, <span class="number">2</span>),
|
||
(<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]);
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>vec: Vec<i32> = map.into_values().collect();
|
||
<span class="comment">// The `IntoValues` iterator produces values in arbitrary order, so
|
||
// the values must be sorted to test them against a sorted array.
|
||
</span>vec.sort_unstable();
|
||
<span class="macro">assert_eq!</span>(vec, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]);</code></pre></div>
|
||
<h5 id="performance-1"><a class="doc-anchor" href="#performance-1">§</a>Performance</h5>
|
||
<p>In the current implementation, iterating over values takes O(capacity) time
|
||
instead of O(len) because it internally visits empty buckets too.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove" class="method"><a class="src rightside" href="../src/ahash/hash_map.rs.html#269-275">Source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a><Q>(&mut self, k: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Removes a key from the map, returning the value at the key if the key
|
||
was previously in the map.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but
|
||
<a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
|
||
the key type.</p>
|
||
<h5 id="examples-6"><a class="doc-anchor" href="#examples-6">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="macro">assert_eq!</span>(map.remove(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="string">"a"</span>));
|
||
<span class="macro">assert_eq!</span>(map.remove(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details></div></details></div><details class="toggle big-toggle" open><summary><h2 id="deref-methods-HashMap%3CK,+V,+S%3E" class="section-header"><span>Methods from <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V, S>></span><a href="#deref-methods-HashMap%3CK,+V,+S%3E" class="anchor">§</a></h2></summary><div id="deref-methods-HashMap%3CK,+V,+S%3E-1" class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.capacity" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#330">Source</a></span><h4 class="code-header">pub fn <a href="#method.capacity" class="fn">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of elements the map can hold without reallocating.</p>
|
||
<p>This number is a lower bound; the <code>HashMap<K, V></code> might be able to hold
|
||
more, but is guaranteed to be able to hold at least this many.</p>
|
||
<h5 id="examples-7"><a class="doc-anchor" href="#examples-7">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
<span class="kw">let </span>map: HashMap<i32, i32> = HashMap::with_capacity(<span class="number">100</span>);
|
||
<span class="macro">assert!</span>(map.capacity() >= <span class="number">100</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.keys" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#359">Source</a></span><h4 class="code-header">pub fn <a href="#method.keys" class="fn">keys</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.Keys.html" title="struct std::collections::hash::map::Keys">Keys</a><'_, K, V></h4></section></summary><div class="docblock"><p>An iterator visiting all keys in arbitrary order.
|
||
The iterator element type is <code>&'a K</code>.</p>
|
||
<h5 id="examples-8"><a class="doc-anchor" href="#examples-8">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span>map = HashMap::from([
|
||
(<span class="string">"a"</span>, <span class="number">1</span>),
|
||
(<span class="string">"b"</span>, <span class="number">2</span>),
|
||
(<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]);
|
||
|
||
<span class="kw">for </span>key <span class="kw">in </span>map.keys() {
|
||
<span class="macro">println!</span>(<span class="string">"{key}"</span>);
|
||
}</code></pre></div>
|
||
<h5 id="performance-2"><a class="doc-anchor" href="#performance-2">§</a>Performance</h5>
|
||
<p>In the current implementation, iterating over keys takes O(capacity) time
|
||
instead of O(len) because it internally visits empty buckets too.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.values" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#421">Source</a></span><h4 class="code-header">pub fn <a href="#method.values" class="fn">values</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.Values.html" title="struct std::collections::hash::map::Values">Values</a><'_, K, V></h4></section></summary><div class="docblock"><p>An iterator visiting all values in arbitrary order.
|
||
The iterator element type is <code>&'a V</code>.</p>
|
||
<h5 id="examples-9"><a class="doc-anchor" href="#examples-9">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span>map = HashMap::from([
|
||
(<span class="string">"a"</span>, <span class="number">1</span>),
|
||
(<span class="string">"b"</span>, <span class="number">2</span>),
|
||
(<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]);
|
||
|
||
<span class="kw">for </span>val <span class="kw">in </span>map.values() {
|
||
<span class="macro">println!</span>(<span class="string">"{val}"</span>);
|
||
}</code></pre></div>
|
||
<h5 id="performance-3"><a class="doc-anchor" href="#performance-3">§</a>Performance</h5>
|
||
<p>In the current implementation, iterating over values takes O(capacity) time
|
||
instead of O(len) because it internally visits empty buckets too.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.values_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.10.0">1.10.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#454">Source</a></span><h4 class="code-header">pub fn <a href="#method.values_mut" class="fn">values_mut</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.ValuesMut.html" title="struct std::collections::hash::map::ValuesMut">ValuesMut</a><'_, K, V></h4></section></summary><div class="docblock"><p>An iterator visiting all values mutably in arbitrary order.
|
||
The iterator element type is <code>&'a mut V</code>.</p>
|
||
<h5 id="examples-10"><a class="doc-anchor" href="#examples-10">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::from([
|
||
(<span class="string">"a"</span>, <span class="number">1</span>),
|
||
(<span class="string">"b"</span>, <span class="number">2</span>),
|
||
(<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]);
|
||
|
||
<span class="kw">for </span>val <span class="kw">in </span>map.values_mut() {
|
||
<span class="kw-2">*</span>val = <span class="kw-2">*</span>val + <span class="number">10</span>;
|
||
}
|
||
|
||
<span class="kw">for </span>val <span class="kw">in </span>map.values() {
|
||
<span class="macro">println!</span>(<span class="string">"{val}"</span>);
|
||
}</code></pre></div>
|
||
<h5 id="performance-4"><a class="doc-anchor" href="#performance-4">§</a>Performance</h5>
|
||
<p>In the current implementation, iterating over values takes O(capacity) time
|
||
instead of O(len) because it internally visits empty buckets too.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#516">Source</a></span><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.Iter.html" title="struct std::collections::hash::map::Iter">Iter</a><'_, K, V></h4></section></summary><div class="docblock"><p>An iterator visiting all key-value pairs in arbitrary order.
|
||
The iterator element type is <code>(&'a K, &'a V)</code>.</p>
|
||
<h5 id="examples-11"><a class="doc-anchor" href="#examples-11">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span>map = HashMap::from([
|
||
(<span class="string">"a"</span>, <span class="number">1</span>),
|
||
(<span class="string">"b"</span>, <span class="number">2</span>),
|
||
(<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]);
|
||
|
||
<span class="kw">for </span>(key, val) <span class="kw">in </span>map.iter() {
|
||
<span class="macro">println!</span>(<span class="string">"key: {key} val: {val}"</span>);
|
||
}</code></pre></div>
|
||
<h5 id="performance-5"><a class="doc-anchor" href="#performance-5">§</a>Performance</h5>
|
||
<p>In the current implementation, iterating over map takes O(capacity) time
|
||
instead of O(len) because it internally visits empty buckets too.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#551">Source</a></span><h4 class="code-header">pub fn <a href="#method.iter_mut" class="fn">iter_mut</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.IterMut.html" title="struct std::collections::hash::map::IterMut">IterMut</a><'_, K, V></h4></section></summary><div class="docblock"><p>An iterator visiting all key-value pairs in arbitrary order,
|
||
with mutable references to the values.
|
||
The iterator element type is <code>(&'a K, &'a mut V)</code>.</p>
|
||
<h5 id="examples-12"><a class="doc-anchor" href="#examples-12">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::from([
|
||
(<span class="string">"a"</span>, <span class="number">1</span>),
|
||
(<span class="string">"b"</span>, <span class="number">2</span>),
|
||
(<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]);
|
||
|
||
<span class="comment">// Update all values
|
||
</span><span class="kw">for </span>(<span class="kw">_</span>, val) <span class="kw">in </span>map.iter_mut() {
|
||
<span class="kw-2">*</span>val <span class="kw-2">*</span>= <span class="number">2</span>;
|
||
}
|
||
|
||
<span class="kw">for </span>(key, val) <span class="kw">in </span><span class="kw-2">&</span>map {
|
||
<span class="macro">println!</span>(<span class="string">"key: {key} val: {val}"</span>);
|
||
}</code></pre></div>
|
||
<h5 id="performance-6"><a class="doc-anchor" href="#performance-6">§</a>Performance</h5>
|
||
<p>In the current implementation, iterating over map takes O(capacity) time
|
||
instead of O(len) because it internally visits empty buckets too.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#568">Source</a></span><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of elements in the map.</p>
|
||
<h5 id="examples-13"><a class="doc-anchor" href="#examples-13">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a = HashMap::new();
|
||
<span class="macro">assert_eq!</span>(a.len(), <span class="number">0</span>);
|
||
a.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="macro">assert_eq!</span>(a.len(), <span class="number">1</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#586">Source</a></span><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the map contains no elements.</p>
|
||
<h5 id="examples-14"><a class="doc-anchor" href="#examples-14">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a = HashMap::new();
|
||
<span class="macro">assert!</span>(a.is_empty());
|
||
a.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="macro">assert!</span>(!a.is_empty());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.drain" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.6.0">1.6.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#616">Source</a></span><h4 class="code-header">pub fn <a href="#method.drain" class="fn">drain</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.Drain.html" title="struct std::collections::hash::map::Drain">Drain</a><'_, K, V></h4></section></summary><div class="docblock"><p>Clears the map, returning all key-value pairs as an iterator. Keeps the
|
||
allocated memory for reuse.</p>
|
||
<p>If the returned iterator is dropped before being fully consumed, it
|
||
drops the remaining key-value pairs. The returned iterator keeps a
|
||
mutable borrow on the map to optimize its implementation.</p>
|
||
<h5 id="examples-15"><a class="doc-anchor" href="#examples-15">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a = HashMap::new();
|
||
a.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
a.insert(<span class="number">2</span>, <span class="string">"b"</span>);
|
||
|
||
<span class="kw">for </span>(k, v) <span class="kw">in </span>a.drain().take(<span class="number">1</span>) {
|
||
<span class="macro">assert!</span>(k == <span class="number">1 </span>|| k == <span class="number">2</span>);
|
||
<span class="macro">assert!</span>(v == <span class="string">"a" </span>|| v == <span class="string">"b"</span>);
|
||
}
|
||
|
||
<span class="macro">assert!</span>(a.is_empty());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.extract_if" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#657-659">Source</a><h4 class="code-header">pub fn <a href="#method.extract_if" class="fn">extract_if</a><F>(&mut self, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.ExtractIf.html" title="struct std::collections::hash::map::ExtractIf">ExtractIf</a><'_, K, V, F><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>hash_extract_if</code>)</span></div></span></summary><div class="docblock"><p>Creates an iterator which uses a closure to determine if an element should be removed.</p>
|
||
<p>If the closure returns true, the element is removed from the map and yielded.
|
||
If the closure returns false, or panics, the element remains in the map and will not be
|
||
yielded.</p>
|
||
<p>Note that <code>extract_if</code> lets you mutate every value in the filter closure, regardless of
|
||
whether you choose to keep or remove it.</p>
|
||
<p>If the returned <code>ExtractIf</code> is not exhausted, e.g. because it is dropped without iterating
|
||
or the iteration short-circuits, then the remaining elements will be retained.
|
||
Use <a href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.HashMap.html#method.retain" title="method std::collections::hash::map::HashMap::retain"><code>retain</code></a> with a negated predicate if you do not need the returned iterator.</p>
|
||
<h5 id="examples-16"><a class="doc-anchor" href="#examples-16">§</a>Examples</h5>
|
||
<p>Splitting a map into even and odd keys, reusing the original map:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(hash_extract_if)]
|
||
</span><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map: HashMap<i32, i32> = (<span class="number">0</span>..<span class="number">8</span>).map(|x| (x, x)).collect();
|
||
<span class="kw">let </span>extracted: HashMap<i32, i32> = map.extract_if(|k, _v| k % <span class="number">2 </span>== <span class="number">0</span>).collect();
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>evens = extracted.keys().copied().collect::<Vec<<span class="kw">_</span>>>();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>odds = map.keys().copied().collect::<Vec<<span class="kw">_</span>>>();
|
||
evens.sort();
|
||
odds.sort();
|
||
|
||
<span class="macro">assert_eq!</span>(evens, <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="number">6</span>]);
|
||
<span class="macro">assert_eq!</span>(odds, <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">7</span>]);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.retain" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.18.0">1.18.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#686-688">Source</a></span><h4 class="code-header">pub fn <a href="#method.retain" class="fn">retain</a><F>(&mut self, f: F)<div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Retains only the elements specified by the predicate.</p>
|
||
<p>In other words, remove all pairs <code>(k, v)</code> for which <code>f(&k, &mut v)</code> returns <code>false</code>.
|
||
The elements are visited in unsorted (and unspecified) order.</p>
|
||
<h5 id="examples-17"><a class="doc-anchor" href="#examples-17">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map: HashMap<i32, i32> = (<span class="number">0</span>..<span class="number">8</span>).map(|x| (x, x<span class="kw-2">*</span><span class="number">10</span>)).collect();
|
||
map.retain(|<span class="kw-2">&</span>k, <span class="kw">_</span>| k % <span class="number">2 </span>== <span class="number">0</span>);
|
||
<span class="macro">assert_eq!</span>(map.len(), <span class="number">4</span>);</code></pre></div>
|
||
<h5 id="performance-7"><a class="doc-anchor" href="#performance-7">§</a>Performance</h5>
|
||
<p>In the current implementation, this operation takes O(capacity) time
|
||
instead of O(len) because it internally visits empty buckets too.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.clear" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#708">Source</a></span><h4 class="code-header">pub fn <a href="#method.clear" class="fn">clear</a>(&mut self)</h4></section></summary><div class="docblock"><p>Clears the map, removing all key-value pairs. Keeps the allocated memory
|
||
for reuse.</p>
|
||
<h5 id="examples-18"><a class="doc-anchor" href="#examples-18">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a = HashMap::new();
|
||
a.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
a.clear();
|
||
<span class="macro">assert!</span>(a.is_empty());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.hasher" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.9.0">1.9.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#726">Source</a></span><h4 class="code-header">pub fn <a href="#method.hasher" class="fn">hasher</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&S</a></h4></section></summary><div class="docblock"><p>Returns a reference to the map’s <a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher"><code>BuildHasher</code></a>.</p>
|
||
<h5 id="examples-19"><a class="doc-anchor" href="#examples-19">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
<span class="kw">use </span>std::hash::RandomState;
|
||
|
||
<span class="kw">let </span>hasher = RandomState::new();
|
||
<span class="kw">let </span>map: HashMap<i32, i32> = HashMap::with_hasher(hasher);
|
||
<span class="kw">let </span>hasher: <span class="kw-2">&</span>RandomState = map.hasher();</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.reserve" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#755">Source</a></span><h4 class="code-header">pub fn <a href="#method.reserve" class="fn">reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Reserves capacity for at least <code>additional</code> more elements to be inserted
|
||
in the <code>HashMap</code>. The collection may reserve more space to speculatively
|
||
avoid frequent reallocations. After calling <code>reserve</code>,
|
||
capacity will be greater than or equal to <code>self.len() + additional</code>.
|
||
Does nothing if capacity is already sufficient.</p>
|
||
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
||
<p>Panics if the new allocation size overflows <a href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html" title="primitive usize"><code>usize</code></a>.</p>
|
||
<h5 id="examples-20"><a class="doc-anchor" href="#examples-20">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map: HashMap<<span class="kw-2">&</span>str, i32> = HashMap::new();
|
||
map.reserve(<span class="number">10</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_reserve" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.57.0">1.57.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#781">Source</a></span><h4 class="code-header">pub fn <a href="#method.try_reserve" class="fn">try_reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/collections/struct.TryReserveError.html" title="struct alloc::collections::TryReserveError">TryReserveError</a>></h4></section></summary><div class="docblock"><p>Tries to reserve capacity for at least <code>additional</code> more elements to be inserted
|
||
in the <code>HashMap</code>. The collection may reserve more space to speculatively
|
||
avoid frequent reallocations. After calling <code>try_reserve</code>,
|
||
capacity will be greater than or equal to <code>self.len() + additional</code> if
|
||
it returns <code>Ok(())</code>.
|
||
Does nothing if capacity is already sufficient.</p>
|
||
<h5 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h5>
|
||
<p>If the capacity overflows, or the allocator reports a failure, then an error
|
||
is returned.</p>
|
||
<h5 id="examples-21"><a class="doc-anchor" href="#examples-21">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map: HashMap<<span class="kw-2">&</span>str, isize> = HashMap::new();
|
||
map.try_reserve(<span class="number">10</span>).expect(<span class="string">"why is the test harness OOMing on a handful of bytes?"</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.shrink_to_fit" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#803">Source</a></span><h4 class="code-header">pub fn <a href="#method.shrink_to_fit" class="fn">shrink_to_fit</a>(&mut self)</h4></section></summary><div class="docblock"><p>Shrinks the capacity of the map as much as possible. It will drop
|
||
down as much as possible while maintaining the internal rules
|
||
and possibly leaving some space in accordance with the resize policy.</p>
|
||
<h5 id="examples-22"><a class="doc-anchor" href="#examples-22">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map: HashMap<i32, i32> = HashMap::with_capacity(<span class="number">100</span>);
|
||
map.insert(<span class="number">1</span>, <span class="number">2</span>);
|
||
map.insert(<span class="number">3</span>, <span class="number">4</span>);
|
||
<span class="macro">assert!</span>(map.capacity() >= <span class="number">100</span>);
|
||
map.shrink_to_fit();
|
||
<span class="macro">assert!</span>(map.capacity() >= <span class="number">2</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.shrink_to" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.56.0">1.56.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#829">Source</a></span><h4 class="code-header">pub fn <a href="#method.shrink_to" class="fn">shrink_to</a>(&mut self, min_capacity: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Shrinks the capacity of the map with a lower limit. It will drop
|
||
down no lower than the supplied limit while maintaining the internal rules
|
||
and possibly leaving some space in accordance with the resize policy.</p>
|
||
<p>If the current capacity is less than the lower limit, this is a no-op.</p>
|
||
<h5 id="examples-23"><a class="doc-anchor" href="#examples-23">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map: HashMap<i32, i32> = HashMap::with_capacity(<span class="number">100</span>);
|
||
map.insert(<span class="number">1</span>, <span class="number">2</span>);
|
||
map.insert(<span class="number">3</span>, <span class="number">4</span>);
|
||
<span class="macro">assert!</span>(map.capacity() >= <span class="number">100</span>);
|
||
map.shrink_to(<span class="number">10</span>);
|
||
<span class="macro">assert!</span>(map.capacity() >= <span class="number">10</span>);
|
||
map.shrink_to(<span class="number">0</span>);
|
||
<span class="macro">assert!</span>(map.capacity() >= <span class="number">2</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.entry" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#853">Source</a></span><h4 class="code-header">pub fn <a href="#method.entry" class="fn">entry</a>(&mut self, key: K) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/enum.Entry.html" title="enum std::collections::hash::map::Entry">Entry</a><'_, K, V></h4></section></summary><div class="docblock"><p>Gets the given key’s corresponding entry in the map for in-place manipulation.</p>
|
||
<h5 id="examples-24"><a class="doc-anchor" href="#examples-24">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>letters = HashMap::new();
|
||
|
||
<span class="kw">for </span>ch <span class="kw">in </span><span class="string">"a short treatise on fungi"</span>.chars() {
|
||
letters.entry(ch).and_modify(|counter| <span class="kw-2">*</span>counter += <span class="number">1</span>).or_insert(<span class="number">1</span>);
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(letters[<span class="kw-2">&</span><span class="string">'s'</span>], <span class="number">2</span>);
|
||
<span class="macro">assert_eq!</span>(letters[<span class="kw-2">&</span><span class="string">'t'</span>], <span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(letters[<span class="kw-2">&</span><span class="string">'u'</span>], <span class="number">1</span>);
|
||
<span class="macro">assert_eq!</span>(letters.get(<span class="kw-2">&</span><span class="string">'y'</span>), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get-1" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#875-878">Source</a></span><h4 class="code-header">pub fn <a href="#method.get-1" class="fn">get</a><Q>(&self, k: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&V</a>><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Returns a reference to the value corresponding to the key.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but
|
||
<a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
|
||
the key type.</p>
|
||
<h5 id="examples-25"><a class="doc-anchor" href="#examples-25">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="macro">assert_eq!</span>(map.get(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">"a"</span>));
|
||
<span class="macro">assert_eq!</span>(map.get(<span class="kw-2">&</span><span class="number">2</span>), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_key_value-1" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.40.0">1.40.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#933-936">Source</a></span><h4 class="code-header">pub fn <a href="#method.get_key_value-1" class="fn">get_key_value</a><Q>(&self, k: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&V</a>)><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Returns the key-value pair corresponding to the supplied key. This is
|
||
potentially useful:</p>
|
||
<ul>
|
||
<li>for key types where non-identical keys can be considered equal;</li>
|
||
<li>for getting the <code>&K</code> stored key value from a borrowed <code>&Q</code> lookup key; or</li>
|
||
<li>for getting a reference to a key with the same lifetime as the collection.</li>
|
||
</ul>
|
||
<p>The supplied key may be any borrowed form of the map’s key type, but
|
||
<a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
|
||
the key type.</p>
|
||
<h5 id="examples-26"><a class="doc-anchor" href="#examples-26">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
<span class="kw">use </span>std::hash::{Hash, Hasher};
|
||
|
||
<span class="attr">#[derive(Clone, Copy, Debug)]
|
||
</span><span class="kw">struct </span>S {
|
||
id: u32,
|
||
name: <span class="kw-2">&</span><span class="lifetime">'static </span>str, <span class="comment">// ignored by equality and hashing operations
|
||
</span>}
|
||
|
||
<span class="kw">impl </span>PartialEq <span class="kw">for </span>S {
|
||
<span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>S) -> bool {
|
||
<span class="self">self</span>.id == other.id
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl </span>Eq <span class="kw">for </span>S {}
|
||
|
||
<span class="kw">impl </span>Hash <span class="kw">for </span>S {
|
||
<span class="kw">fn </span>hash<H: Hasher>(<span class="kw-2">&</span><span class="self">self</span>, state: <span class="kw-2">&mut </span>H) {
|
||
<span class="self">self</span>.id.hash(state);
|
||
}
|
||
}
|
||
|
||
<span class="kw">let </span>j_a = S { id: <span class="number">1</span>, name: <span class="string">"Jessica" </span>};
|
||
<span class="kw">let </span>j_b = S { id: <span class="number">1</span>, name: <span class="string">"Jess" </span>};
|
||
<span class="kw">let </span>p = S { id: <span class="number">2</span>, name: <span class="string">"Paul" </span>};
|
||
<span class="macro">assert_eq!</span>(j_a, j_b);
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
map.insert(j_a, <span class="string">"Paris"</span>);
|
||
<span class="macro">assert_eq!</span>(map.get_key_value(<span class="kw-2">&</span>j_a), <span class="prelude-val">Some</span>((<span class="kw-2">&</span>j_a, <span class="kw-2">&</span><span class="string">"Paris"</span>)));
|
||
<span class="macro">assert_eq!</span>(map.get_key_value(<span class="kw-2">&</span>j_b), <span class="prelude-val">Some</span>((<span class="kw-2">&</span>j_a, <span class="kw-2">&</span><span class="string">"Paris"</span>))); <span class="comment">// the notable case
|
||
</span><span class="macro">assert_eq!</span>(map.get_key_value(<span class="kw-2">&</span>p), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_many_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#1010-1013">Source</a><h4 class="code-header">pub fn <a href="#method.get_many_mut" class="fn">get_many_mut</a><Q, const N: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>>(
|
||
&mut self,
|
||
ks: [<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">N</a>],
|
||
) -> [<a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">N</a>]<div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>map_many_mut</code>)</span></div></span></summary><div class="docblock"><p>Attempts to get mutable references to <code>N</code> values in the map at once.</p>
|
||
<p>Returns an array of length <code>N</code> with the results of each query. For soundness, at most one
|
||
mutable reference will be returned to any value. <code>None</code> will be used if the key is missing.</p>
|
||
<h5 id="panics-1"><a class="doc-anchor" href="#panics-1">§</a>Panics</h5>
|
||
<p>Panics if any keys are overlapping.</p>
|
||
<h5 id="examples-27"><a class="doc-anchor" href="#examples-27">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(map_many_mut)]
|
||
</span><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>libraries = HashMap::new();
|
||
libraries.insert(<span class="string">"Bodleian Library"</span>.to_string(), <span class="number">1602</span>);
|
||
libraries.insert(<span class="string">"Athenæum"</span>.to_string(), <span class="number">1807</span>);
|
||
libraries.insert(<span class="string">"Herzogin-Anna-Amalia-Bibliothek"</span>.to_string(), <span class="number">1691</span>);
|
||
libraries.insert(<span class="string">"Library of Congress"</span>.to_string(), <span class="number">1800</span>);
|
||
|
||
<span class="comment">// Get Athenæum and Bodleian Library
|
||
</span><span class="kw">let </span>[<span class="prelude-val">Some</span>(a), <span class="prelude-val">Some</span>(b)] = libraries.get_many_mut([
|
||
<span class="string">"Athenæum"</span>,
|
||
<span class="string">"Bodleian Library"</span>,
|
||
]) <span class="kw">else </span>{ <span class="macro">panic!</span>() };
|
||
|
||
<span class="comment">// Assert values of Athenæum and Library of Congress
|
||
</span><span class="kw">let </span>got = libraries.get_many_mut([
|
||
<span class="string">"Athenæum"</span>,
|
||
<span class="string">"Library of Congress"</span>,
|
||
]);
|
||
<span class="macro">assert_eq!</span>(
|
||
got,
|
||
[
|
||
<span class="prelude-val">Some</span>(<span class="kw-2">&mut </span><span class="number">1807</span>),
|
||
<span class="prelude-val">Some</span>(<span class="kw-2">&mut </span><span class="number">1800</span>),
|
||
],
|
||
);
|
||
|
||
<span class="comment">// Missing keys result in None
|
||
</span><span class="kw">let </span>got = libraries.get_many_mut([
|
||
<span class="string">"Athenæum"</span>,
|
||
<span class="string">"New York Public Library"</span>,
|
||
]);
|
||
<span class="macro">assert_eq!</span>(
|
||
got,
|
||
[
|
||
<span class="prelude-val">Some</span>(<span class="kw-2">&mut </span><span class="number">1807</span>),
|
||
<span class="prelude-val">None
|
||
</span>]
|
||
);</code></pre></div>
|
||
|
||
<div class="example-wrap should_panic"><a href="#" class="tooltip" title="This example panics">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(map_many_mut)]
|
||
</span><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>libraries = HashMap::new();
|
||
libraries.insert(<span class="string">"Athenæum"</span>.to_string(), <span class="number">1807</span>);
|
||
|
||
<span class="comment">// Duplicate keys panic!
|
||
</span><span class="kw">let </span>got = libraries.get_many_mut([
|
||
<span class="string">"Athenæum"</span>,
|
||
<span class="string">"Athenæum"</span>,
|
||
]);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_many_unchecked_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#1074-1080">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.get_many_unchecked_mut" class="fn">get_many_unchecked_mut</a><Q, const N: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>>(
|
||
&mut self,
|
||
ks: [<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">N</a>],
|
||
) -> [<a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">N</a>]<div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>map_many_mut</code>)</span></div></span></summary><div class="docblock"><p>Attempts to get mutable references to <code>N</code> values in the map at once, without validating that
|
||
the values are unique.</p>
|
||
<p>Returns an array of length <code>N</code> with the results of each query. <code>None</code> will be used if
|
||
the key is missing.</p>
|
||
<p>For a safe alternative see <a href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.HashMap.html#method.get_many_mut" title="method std::collections::hash::map::HashMap::get_many_mut"><code>get_many_mut</code></a>.</p>
|
||
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
||
<p>Calling this method with overlapping keys is <em><a href="https://doc.rust-lang.org/reference/behavior-considered-undefined.html">undefined behavior</a></em> even if the resulting
|
||
references are not used.</p>
|
||
<h5 id="examples-28"><a class="doc-anchor" href="#examples-28">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(map_many_mut)]
|
||
</span><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>libraries = HashMap::new();
|
||
libraries.insert(<span class="string">"Bodleian Library"</span>.to_string(), <span class="number">1602</span>);
|
||
libraries.insert(<span class="string">"Athenæum"</span>.to_string(), <span class="number">1807</span>);
|
||
libraries.insert(<span class="string">"Herzogin-Anna-Amalia-Bibliothek"</span>.to_string(), <span class="number">1691</span>);
|
||
libraries.insert(<span class="string">"Library of Congress"</span>.to_string(), <span class="number">1800</span>);
|
||
|
||
<span class="comment">// SAFETY: The keys do not overlap.
|
||
</span><span class="kw">let </span>[<span class="prelude-val">Some</span>(a), <span class="prelude-val">Some</span>(b)] = (<span class="kw">unsafe </span>{ libraries.get_many_unchecked_mut([
|
||
<span class="string">"Athenæum"</span>,
|
||
<span class="string">"Bodleian Library"</span>,
|
||
]) }) <span class="kw">else </span>{ <span class="macro">panic!</span>() };
|
||
|
||
<span class="comment">// SAFETY: The keys do not overlap.
|
||
</span><span class="kw">let </span>got = <span class="kw">unsafe </span>{ libraries.get_many_unchecked_mut([
|
||
<span class="string">"Athenæum"</span>,
|
||
<span class="string">"Library of Congress"</span>,
|
||
]) };
|
||
<span class="macro">assert_eq!</span>(
|
||
got,
|
||
[
|
||
<span class="prelude-val">Some</span>(<span class="kw-2">&mut </span><span class="number">1807</span>),
|
||
<span class="prelude-val">Some</span>(<span class="kw-2">&mut </span><span class="number">1800</span>),
|
||
],
|
||
);
|
||
|
||
<span class="comment">// SAFETY: The keys do not overlap.
|
||
</span><span class="kw">let </span>got = <span class="kw">unsafe </span>{ libraries.get_many_unchecked_mut([
|
||
<span class="string">"Athenæum"</span>,
|
||
<span class="string">"New York Public Library"</span>,
|
||
]) };
|
||
<span class="comment">// Missing keys result in None
|
||
</span><span class="macro">assert_eq!</span>(got, [<span class="prelude-val">Some</span>(<span class="kw-2">&mut </span><span class="number">1807</span>), <span class="prelude-val">None</span>]);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.contains_key" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#1104-1107">Source</a></span><h4 class="code-header">pub fn <a href="#method.contains_key" class="fn">contains_key</a><Q>(&self, k: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the map contains a value for the specified key.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but
|
||
<a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
|
||
the key type.</p>
|
||
<h5 id="examples-29"><a class="doc-anchor" href="#examples-29">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="macro">assert_eq!</span>(map.contains_key(<span class="kw-2">&</span><span class="number">1</span>), <span class="bool-val">true</span>);
|
||
<span class="macro">assert_eq!</span>(map.contains_key(<span class="kw-2">&</span><span class="number">2</span>), <span class="bool-val">false</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_mut-1" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#1132-1135">Source</a></span><h4 class="code-header">pub fn <a href="#method.get_mut-1" class="fn">get_mut</a><Q>(&mut self, k: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the value corresponding to the key.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but
|
||
<a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
|
||
the key type.</p>
|
||
<h5 id="examples-30"><a class="doc-anchor" href="#examples-30">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="kw">if let </span><span class="prelude-val">Some</span>(x) = map.get_mut(<span class="kw-2">&</span><span class="number">1</span>) {
|
||
<span class="kw-2">*</span>x = <span class="string">"b"</span>;
|
||
}
|
||
<span class="macro">assert_eq!</span>(map[<span class="kw-2">&</span><span class="number">1</span>], <span class="string">"b"</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert-1" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#1168">Source</a></span><h4 class="code-header">pub fn <a href="#method.insert-1" class="fn">insert</a>(&mut self, k: K, v: V) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V></h4></section></summary><div class="docblock"><p>Inserts a key-value pair into the map.</p>
|
||
<p>If the map did not have this key present, <a href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a> is returned.</p>
|
||
<p>If the map did have this key present, the value is updated, and the old
|
||
value is returned. The key is not updated, though; this matters for
|
||
types that can be <code>==</code> without being identical. See the <a href="https://doc.rust-lang.org/1.84.0/std/collections/index.html#insert-and-complex-keys" title="mod std::collections">module-level
|
||
documentation</a> for more.</p>
|
||
<h5 id="examples-31"><a class="doc-anchor" href="#examples-31">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
<span class="macro">assert_eq!</span>(map.insert(<span class="number">37</span>, <span class="string">"a"</span>), <span class="prelude-val">None</span>);
|
||
<span class="macro">assert_eq!</span>(map.is_empty(), <span class="bool-val">false</span>);
|
||
|
||
map.insert(<span class="number">37</span>, <span class="string">"b"</span>);
|
||
<span class="macro">assert_eq!</span>(map.insert(<span class="number">37</span>, <span class="string">"c"</span>), <span class="prelude-val">Some</span>(<span class="string">"b"</span>));
|
||
<span class="macro">assert_eq!</span>(map[<span class="kw-2">&</span><span class="number">37</span>], <span class="string">"c"</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_insert" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#1196">Source</a><h4 class="code-header">pub fn <a href="#method.try_insert" class="fn">try_insert</a>(
|
||
&mut self,
|
||
key: K,
|
||
value: V,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>, <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.OccupiedError.html" title="struct std::collections::hash::map::OccupiedError">OccupiedError</a><'_, K, V>></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>map_try_insert</code>)</span></div></span></summary><div class="docblock"><p>Tries to insert a key-value pair into the map, and returns
|
||
a mutable reference to the value in the entry.</p>
|
||
<p>If the map already had this key present, nothing is updated, and
|
||
an error containing the occupied entry and the value is returned.</p>
|
||
<h5 id="examples-32"><a class="doc-anchor" href="#examples-32">§</a>Examples</h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(map_try_insert)]
|
||
|
||
</span><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
<span class="macro">assert_eq!</span>(map.try_insert(<span class="number">37</span>, <span class="string">"a"</span>).unwrap(), <span class="kw-2">&</span><span class="string">"a"</span>);
|
||
|
||
<span class="kw">let </span>err = map.try_insert(<span class="number">37</span>, <span class="string">"b"</span>).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.entry.key(), <span class="kw-2">&</span><span class="number">37</span>);
|
||
<span class="macro">assert_eq!</span>(err.entry.get(), <span class="kw-2">&</span><span class="string">"a"</span>);
|
||
<span class="macro">assert_eq!</span>(err.value, <span class="string">"b"</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove-1" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#1223-1226">Source</a></span><h4 class="code-header">pub fn <a href="#method.remove-1" class="fn">remove</a><Q>(&mut self, k: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Removes a key from the map, returning the value at the key if the key
|
||
was previously in the map.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but
|
||
<a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
|
||
the key type.</p>
|
||
<h5 id="examples-33"><a class="doc-anchor" href="#examples-33">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="macro">assert_eq!</span>(map.remove(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="string">"a"</span>));
|
||
<span class="macro">assert_eq!</span>(map.remove(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove_entry" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.27.0">1.27.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#1252-1255">Source</a></span><h4 class="code-header">pub fn <a href="#method.remove_entry" class="fn">remove_entry</a><Q>(&mut self, k: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.tuple.html">(K, V)</a>><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Removes a key from the map, returning the stored key and value if the
|
||
key was previously in the map.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but
|
||
<a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
|
||
the key type.</p>
|
||
<h5 id="examples-34"><a class="doc-anchor" href="#examples-34">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::collections::HashMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="macro">assert_eq!</span>(map.remove_entry(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">Some</span>((<span class="number">1</span>, <span class="string">"a"</span>)));
|
||
<span class="macro">assert_eq!</span>(map.remove(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.raw_entry_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#1298">Source</a><h4 class="code-header">pub fn <a href="#method.raw_entry_mut" class="fn">raw_entry_mut</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.RawEntryBuilderMut.html" title="struct std::collections::hash::map::RawEntryBuilderMut">RawEntryBuilderMut</a><'_, K, V, S></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>hash_raw_entry</code>)</span></div></span></summary><div class="docblock"><p>Creates a raw entry builder for the HashMap.</p>
|
||
<p>Raw entries provide the lowest level of control for searching and
|
||
manipulating a map. They must be manually initialized with a hash and
|
||
then manually searched. After this, insertions into a vacant entry
|
||
still require an owned key to be provided.</p>
|
||
<p>Raw entries are useful for such exotic situations as:</p>
|
||
<ul>
|
||
<li>Hash memoization</li>
|
||
<li>Deferring the creation of an owned key until it is known to be required</li>
|
||
<li>Using a search key that doesn’t work with the Borrow trait</li>
|
||
<li>Using custom comparison logic without newtype wrappers</li>
|
||
</ul>
|
||
<p>Because raw entries provide much more low-level control, it’s much easier
|
||
to put the HashMap into an inconsistent state which, while memory-safe,
|
||
will cause the map to produce seemingly random results. Higher-level and
|
||
more foolproof APIs like <code>entry</code> should be preferred when possible.</p>
|
||
<p>In particular, the hash used to initialize the raw entry must still be
|
||
consistent with the hash of the key that is ultimately stored in the entry.
|
||
This is because implementations of HashMap may need to recompute hashes
|
||
when resizing, at which point only the keys are available.</p>
|
||
<p>Raw entries give mutable access to the keys. This must not be used
|
||
to modify how the key would compare or hash, as the map will not re-evaluate
|
||
where the key should go, meaning the keys may become “lost” if their
|
||
location does not reflect their state. For instance, if you change a key
|
||
so that the map now contains keys which compare equal, search may start
|
||
acting erratically, with two keys randomly masking each other. Implementations
|
||
are free to assume this doesn’t happen (within the limits of memory-safety).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.raw_entry" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/std/collections/hash/map.rs.html#1319">Source</a><h4 class="code-header">pub fn <a href="#method.raw_entry" class="fn">raw_entry</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.RawEntryBuilder.html" title="struct std::collections::hash::map::RawEntryBuilder">RawEntryBuilder</a><'_, K, V, S></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>hash_raw_entry</code>)</span></div></span></summary><div class="docblock"><p>Creates a raw immutable entry builder for the HashMap.</p>
|
||
<p>Raw entries provide the lowest level of control for searching and
|
||
manipulating a map. They must be manually initialized with a hash and
|
||
then manually searched.</p>
|
||
<p>This is useful for</p>
|
||
<ul>
|
||
<li>Hash memoization</li>
|
||
<li>Using a search key that doesn’t work with the Borrow trait</li>
|
||
<li>Using custom comparison logic without newtype wrappers</li>
|
||
</ul>
|
||
<p>Unless you are in such a situation, higher-level and more foolproof APIs like
|
||
<code>get</code> should be preferred.</p>
|
||
<p>Immutable raw entries have very limited use; you might instead want <code>raw_entry_mut</code>.</p>
|
||
</div></details></div></details><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#20">Source</a><a href="#impl-Clone-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#20">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#174">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#336-345">Source</a><a href="#impl-Debug-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#342-344">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-AHashMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#411-416">Source</a><a href="#impl-Default-for-AHashMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, <a class="struct" href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState">RandomState</a>></h3></section></summary><div class="docblock"><p>NOTE: For safety this trait impl is only available available if either of the flags <code>runtime-rng</code> (on by default) or
|
||
<code>compile-time-rng</code> are enabled. This is to prevent weakly keyed maps from being accidentally created. Instead one of
|
||
constructors for <a href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState">RandomState</a> must be used.</p>
|
||
</div><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#413-415">Source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, <a class="struct" href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState">RandomState</a>></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Deref-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#278-283">Source</a><a href="#impl-Deref-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#279">Source</a><a href="#associatedtype.Target" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html#associatedtype.Target" class="associatedtype">Target</a> = <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V, S></h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#280-282">Source</a><a href="#method.deref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html#tymethod.deref" class="fn">deref</a>(&self) -> &Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></h4></section></summary><div class='docblock'>Dereferences the value.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-DerefMut-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#285-289">Source</a><a href="#impl-DerefMut-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.deref_mut" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#286-288">Source</a><a href="#method.deref_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut" class="fn">deref_mut</a>(&mut self) -> &mut Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></h4></section></summary><div class='docblock'>Mutably dereferences the value.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Extend%3C(%26K,+%26V)%3E-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#395-405">Source</a><a href="#impl-Extend%3C(%26K,+%26V)%3E-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a K</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a V</a>)> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + 'a,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + 'a,
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.extend-1" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#402-404">Source</a><a href="#method.extend-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html#tymethod.extend" class="fn">extend</a><T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = (<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a K</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a V</a>)>>(&mut self, iter: T)</h4></section></summary><div class='docblock'>Extends a collection with the contents of an iterator. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html#tymethod.extend">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.extend_one-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/iter/traits/collect.rs.html#453">Source</a><a href="#method.extend_one-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html#method.extend_one" class="fn">extend_one</a>(&mut self, item: A)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>extend_one</code>)</span></div></span><div class='docblock'>Extends a collection with exactly one element.</div></details><details class="toggle method-toggle" open><summary><section id="method.extend_reserve-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/iter/traits/collect.rs.html#461">Source</a><a href="#method.extend_reserve-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html#method.extend_reserve" class="fn">extend_reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>extend_one</code>)</span></div></span><div class='docblock'>Reserves capacity in a collection for the given number of additional elements. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html#method.extend_reserve">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Extend%3C(K,+V)%3E-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#384-393">Source</a><a href="#impl-Extend%3C(K,+V)%3E-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.tuple.html">(K, V)</a>> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.extend" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#390-392">Source</a><a href="#method.extend" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html#tymethod.extend" class="fn">extend</a><T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.tuple.html">(K, V)</a>>>(&mut self, iter: T)</h4></section></summary><div class='docblock'>Extends a collection with the contents of an iterator. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html#tymethod.extend">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.extend_one" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/iter/traits/collect.rs.html#453">Source</a><a href="#method.extend_one" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html#method.extend_one" class="fn">extend_one</a>(&mut self, item: A)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>extend_one</code>)</span></div></span><div class='docblock'>Extends a collection with exactly one element.</div></details><details class="toggle method-toggle" open><summary><section id="method.extend_reserve" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/iter/traits/collect.rs.html#461">Source</a><a href="#method.extend_reserve" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html#method.extend_reserve" class="fn">extend_reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>extend_one</code>)</span></div></span><div class='docblock'>Reserves capacity in a collection for the given number of additional elements. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.Extend.html#method.extend_reserve">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3C%5B(K,+V);+N%5D%3E-for-AHashMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#29-45">Source</a><a href="#impl-From%3C%5B(K,+V);+N%5D%3E-for-AHashMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, const N: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.tuple.html">(K, V)</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">N</a>]> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#42-44">Source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(arr: [<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.tuple.html">(K, V)</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">N</a>]) -> Self</h4></section></summary><div class="docblock"><h5 id="examples-35"><a class="doc-anchor" href="#examples-35">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ahash::AHashMap;
|
||
|
||
<span class="kw">let </span>map1 = AHashMap::from([(<span class="number">1</span>, <span class="number">2</span>), (<span class="number">3</span>, <span class="number">4</span>)]);
|
||
<span class="kw">let </span>map2: AHashMap<<span class="kw">_</span>, <span class="kw">_</span>> = [(<span class="number">1</span>, <span class="number">2</span>), (<span class="number">3</span>, <span class="number">4</span>)].into();
|
||
<span class="macro">assert_eq!</span>(map1, map2);</code></pre></div>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CHashMap%3CK,+V,+RandomState%3E%3E-for-AHashMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#23-27">Source</a><a href="#impl-From%3CHashMap%3CK,+V,+RandomState%3E%3E-for-AHashMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V, <a class="struct" href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState">RandomState</a>>> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#24-26">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(item: <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V, <a class="struct" href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState">RandomState</a>>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-FromIterator%3C(K,+V)%3E-for-AHashMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#347-358">Source</a><a href="#impl-FromIterator%3C(K,+V)%3E-for-AHashMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.FromIterator.html" title="trait core::iter::traits::collect::FromIterator">FromIterator</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.tuple.html">(K, V)</a>> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, <a class="struct" href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState">RandomState</a>><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_iter" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#353-357">Source</a><a href="#method.from_iter" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.FromIterator.html#tymethod.from_iter" class="fn">from_iter</a><T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.tuple.html">(K, V)</a>>>(iter: T) -> Self</h4></section></summary><div class="docblock"><p>This crates a hashmap from the provided iterator using <a href="random_state/struct.RandomState.html#method.new" title="associated function ahash::random_state::RandomState::new">RandomState::new</a>.
|
||
See the documentation in [RandomSource] for notes about key strength.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Index%3C%26Q%3E-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#317-334">Source</a><a href="#impl-Index%3C%26Q%3E-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, Q, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.index" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#331-333">Source</a><a href="#method.index" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/ops/index/trait.Index.html#tymethod.index" class="fn">index</a>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Q</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&V</a></h4></section></summary><div class="docblock"><p>Returns a reference to the value corresponding to the supplied key.</p>
|
||
<h5 id="panics-2"><a class="doc-anchor" href="#panics-2">§</a>Panics</h5>
|
||
<p>Panics if the key is not present in the <code>HashMap</code>.</p>
|
||
</div></details><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#323">Source</a><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/ops/index/trait.Index.html#associatedtype.Output" class="associatedtype">Output</a> = V</h4></section></summary><div class='docblock'>The returned type after indexing.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Into%3CHashMap%3CK,+V,+RandomState%3E%3E-for-AHashMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#47-51">Source</a><a href="#impl-Into%3CHashMap%3CK,+V,+RandomState%3E%3E-for-AHashMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V, <a class="struct" href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState">RandomState</a>>> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#48-50">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V, <a class="struct" href="random_state/struct.RandomState.html" title="struct ahash::random_state::RandomState">RandomState</a>></h4></section></summary><div class='docblock'>Converts this type into the (usually inferred) input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#360-366">Source</a><a href="#impl-IntoIterator-for-%26AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#361">Source</a><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = (<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a K</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a V</a>)</h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter" class="associatedtype trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#362">Source</a><a href="#associatedtype.IntoIter" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.Iter.html" title="struct std::collections::hash::map::Iter">Iter</a><'a, K, V></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#363-365">Source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26mut+AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#368-374">Source</a><a href="#impl-IntoIterator-for-%26mut+AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#369">Source</a><a href="#associatedtype.Item-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = (<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a K</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a mut V</a>)</h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#370">Source</a><a href="#associatedtype.IntoIter-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.IterMut.html" title="struct std::collections::hash::map::IterMut">IterMut</a><'a, K, V></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter-1" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#371-373">Source</a><a href="#method.into_iter-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#376-382">Source</a><a href="#impl-IntoIterator-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item-2" class="associatedtype trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#377">Source</a><a href="#associatedtype.Item-2" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.tuple.html">(K, V)</a></h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter-2" class="associatedtype trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#378">Source</a><a href="#associatedtype.IntoIter-2" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/map/struct.IntoIter.html" title="struct std::collections::hash::map::IntoIter">IntoIter</a><K, V></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter-2" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#379-381">Source</a><a href="#method.into_iter-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#298-307">Source</a><a href="#impl-PartialEq-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#304-306">Source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&self, other: &<a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/core/cmp.rs.html#261">Source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>!=</code>. The default implementation is almost always sufficient,
|
||
and should not be overridden without very good reason.</div></details></div></details><section id="impl-Eq-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#309-315">Source</a><a href="#impl-Eq-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section><section id="impl-UnwindSafe-for-AHashMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../src/ahash/hash_map.rs.html#291-296">Source</a><a href="#impl-UnwindSafe-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</div></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-AHashMap%3CK,+V,+S%3E" class="impl"><a href="#impl-Freeze-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-AHashMap%3CK,+V,+S%3E" class="impl"><a href="#impl-RefUnwindSafe-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-AHashMap%3CK,+V,+S%3E" class="impl"><a href="#impl-Send-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-AHashMap%3CK,+V,+S%3E" class="impl"><a href="#impl-Sync-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-AHashMap%3CK,+V,+S%3E" class="impl"><a href="#impl-Unpin-for-AHashMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.AHashMap.html" title="struct ahash::AHashMap">AHashMap</a><K, V, S><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#273">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#275">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dst: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dst</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.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="toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">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.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Receiver-for-P" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/ops/deref.rs.html#374-376">Source</a><a href="#impl-Receiver-for-P" class="anchor">§</a><h3 class="code-header">impl<P, T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Receiver.html" title="trait core::ops::deref::Receiver">Receiver</a> for P<div class="where">where
|
||
P: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = T> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/ops/deref.rs.html#378">Source</a><a href="#associatedtype.Target-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Receiver.html#associatedtype.Target" class="associatedtype">Target</a> = T</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>arbitrary_self_types</code>)</span></div></span><div class='docblock'>The target type on which the method may be called.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#82-84">Source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#86">Source</a><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#87">Source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#91">Source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.84.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.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.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.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |