mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 04:10:02 +01:00
361 lines
135 KiB
HTML
361 lines
135 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `IndexMap` struct in crate `indexmap`."><meta name="keywords" content="rust, rustlang, rust-lang, IndexMap"><title>indexmap::map::IndexMap - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../indexmap/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Struct IndexMap</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.capacity">capacity</a><a href="#method.clear">clear</a><a href="#method.contains_key">contains_key</a><a href="#method.drain">drain</a><a href="#method.entry">entry</a><a href="#method.first">first</a><a href="#method.first_mut">first_mut</a><a href="#method.get">get</a><a href="#method.get_full">get_full</a><a href="#method.get_full_mut">get_full_mut</a><a href="#method.get_index">get_index</a><a href="#method.get_index_mut">get_index_mut</a><a href="#method.get_index_of">get_index_of</a><a href="#method.get_key_value">get_key_value</a><a href="#method.get_mut">get_mut</a><a href="#method.hasher">hasher</a><a href="#method.insert">insert</a><a href="#method.insert_full">insert_full</a><a href="#method.is_empty">is_empty</a><a href="#method.iter">iter</a><a href="#method.iter_mut">iter_mut</a><a href="#method.keys">keys</a><a href="#method.last">last</a><a href="#method.last_mut">last_mut</a><a href="#method.len">len</a><a href="#method.new">new</a><a href="#method.pop">pop</a><a href="#method.remove">remove</a><a href="#method.remove_entry">remove_entry</a><a href="#method.reserve">reserve</a><a href="#method.retain">retain</a><a href="#method.reverse">reverse</a><a href="#method.shift_remove">shift_remove</a><a href="#method.shift_remove_entry">shift_remove_entry</a><a href="#method.shift_remove_full">shift_remove_full</a><a href="#method.shift_remove_index">shift_remove_index</a><a href="#method.shrink_to_fit">shrink_to_fit</a><a href="#method.sort_by">sort_by</a><a href="#method.sort_keys">sort_keys</a><a href="#method.sorted_by">sorted_by</a><a href="#method.split_off">split_off</a><a href="#method.swap_indices">swap_indices</a><a href="#method.swap_remove">swap_remove</a><a href="#method.swap_remove_entry">swap_remove_entry</a><a href="#method.swap_remove_full">swap_remove_full</a><a href="#method.swap_remove_index">swap_remove_index</a><a href="#method.truncate">truncate</a><a href="#method.values">values</a><a href="#method.values_mut">values_mut</a><a href="#method.with_capacity">with_capacity</a><a href="#method.with_capacity_and_hasher">with_capacity_and_hasher</a><a href="#method.with_hasher">with_hasher</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a><a href="#impl-Eq">Eq</a><a href="#impl-Extend%3C(%26%27a%20K%2C%20%26%27a%20V)%3E">Extend<(&'a K, &'a V)></a><a href="#impl-Extend%3C(K%2C%20V)%3E">Extend<(K, V)></a><a href="#impl-FromIterator%3C(K%2C%20V)%3E">FromIterator<(K, V)></a><a href="#impl-Index%3C%26%27_%20Q%3E">Index<&'_ Q></a><a href="#impl-Index%3Cusize%3E">Index<usize></a><a href="#impl-IndexMut%3C%26%27_%20Q%3E">IndexMut<&'_ Q></a><a href="#impl-IndexMut%3Cusize%3E">IndexMut<usize></a><a href="#impl-IntoIterator">IntoIterator</a><a href="#impl-MutableKeys">MutableKeys</a><a href="#impl-PartialEq%3CIndexMap%3CK%2C%20V2%2C%20S2%3E%3E">PartialEq<IndexMap<K, V2, S2>></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">indexmap</a>::<wbr><a href="index.html">map</a></p><div id="sidebar-vars" data-name="IndexMap" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">indexmap</a>::<wbr><a href="index.html">map</a>::<wbr><a class="struct" href="">IndexMap</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/indexmap/map.rs.html#71-74" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct IndexMap<K, V, S = <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.RandomState.html" title="struct std::collections::hash::map::RandomState">RandomState</a>> { /* fields omitted */ }</pre></div><div class="docblock"><p>A hash table where the iteration order of the key-value pairs is independent
|
||
of the hash values of the keys.</p>
|
||
<p>The interface is closely compatible with the standard <code>HashMap</code>, but also
|
||
has additional features.</p>
|
||
<h1 id="order" class="section-header"><a href="#order">Order</a></h1>
|
||
<p>The key-value pairs have a consistent order that is determined by
|
||
the sequence of insertion and removal calls on the map. The order does
|
||
not depend on the keys or the hash function at all.</p>
|
||
<p>All iterators traverse the map in <em>the order</em>.</p>
|
||
<p>The insertion order is preserved, with <strong>notable exceptions</strong> like the
|
||
<code>.remove()</code> or <code>.swap_remove()</code> methods. Methods such as <code>.sort_by()</code> of
|
||
course result in a new order, depending on the sorting order.</p>
|
||
<h1 id="indices" class="section-header"><a href="#indices">Indices</a></h1>
|
||
<p>The key-value pairs are indexed in a compact range without holes in the
|
||
range <code>0..self.len()</code>. For example, the method <code>.get_full</code> looks up the
|
||
index for a key, and the method <code>.get_index</code> looks up the key-value pair by
|
||
index.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">indexmap</span>::<span class="ident">IndexMap</span>;
|
||
|
||
<span class="comment">// count the frequency of each letter in a sentence.</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">letters</span> <span class="op">=</span> <span class="ident">IndexMap</span>::<span class="ident">new</span>();
|
||
<span class="kw">for</span> <span class="ident">ch</span> <span class="kw">in</span> <span class="string">"a short treatise on fungi"</span>.<span class="ident">chars</span>() {
|
||
<span class="kw-2">*</span><span class="ident">letters</span>.<span class="ident">entry</span>(<span class="ident">ch</span>).<span class="ident">or_insert</span>(<span class="number">0</span>) <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">letters</span>[<span class="kw-2">&</span><span class="string">'s'</span>], <span class="number">2</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">letters</span>[<span class="kw-2">&</span><span class="string">'t'</span>], <span class="number">3</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">letters</span>[<span class="kw-2">&</span><span class="string">'u'</span>], <span class="number">1</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">letters</span>.<span class="ident">get</span>(<span class="kw-2">&</span><span class="string">'y'</span>), <span class="prelude-val">None</span>);</pre></div>
|
||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<K, V> <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#144-159" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>() -> Self</code><a class="srclink" href="../../src/indexmap/map.rs.html#147-149" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a new map. (Does not allocate.)</p>
|
||
</div><h4 id="method.with_capacity" class="method"><code>pub fn <a href="#method.with_capacity" class="fnname">with_capacity</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class="srclink" href="../../src/indexmap/map.rs.html#156-158" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a new map with capacity for <code>n</code> key-value pairs. (Does not
|
||
allocate if <code>n</code> is zero.)</p>
|
||
<p>Computes in <strong>O(n)</strong> time.</p>
|
||
</div></div><h3 id="impl-1" class="impl"><code class="in-band">impl<K, V, S> <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S></code><a href="#impl-1" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#161-300" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.with_capacity_and_hasher" class="method"><code>pub fn <a href="#method.with_capacity_and_hasher" class="fnname">with_capacity_and_hasher</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, hash_builder: S) -> Self</code><a class="srclink" href="../../src/indexmap/map.rs.html#167-179" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a new map with capacity for <code>n</code> key-value pairs. (Does not
|
||
allocate if <code>n</code> is zero.)</p>
|
||
<p>Computes in <strong>O(n)</strong> time.</p>
|
||
</div><h4 id="method.with_hasher" class="method"><code>pub fn <a href="#method.with_hasher" class="fnname">with_hasher</a>(hash_builder: S) -> Self</code><a class="srclink" href="../../src/indexmap/map.rs.html#182-184" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a new map with <code>hash_builder</code></p>
|
||
</div><h4 id="method.capacity" class="method"><code>pub fn <a href="#method.capacity" class="fnname">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class="srclink" href="../../src/indexmap/map.rs.html#187-189" title="goto source code">[src]</a></h4><div class="docblock"><p>Computes in <strong>O(1)</strong> time.</p>
|
||
</div><h4 id="method.hasher" class="method"><code>pub fn <a href="#method.hasher" class="fnname">hasher</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>S</code><a class="srclink" href="../../src/indexmap/map.rs.html#192-194" title="goto source code">[src]</a></h4><div class="docblock"><p>Return a reference to the map's <code>BuildHasher</code>.</p>
|
||
</div><h4 id="method.len" class="method"><code>pub fn <a href="#method.len" class="fnname">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class="srclink" href="../../src/indexmap/map.rs.html#200-202" title="goto source code">[src]</a></h4><div class="docblock"><p>Return the number of key-value pairs in the map.</p>
|
||
<p>Computes in <strong>O(1)</strong> time.</p>
|
||
</div><h4 id="method.is_empty" class="method"><code>pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/indexmap/map.rs.html#208-210" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns true if the map contains no elements.</p>
|
||
<p>Computes in <strong>O(1)</strong> time.</p>
|
||
</div><h4 id="method.iter" class="method"><code>pub fn <a href="#method.iter" class="fnname">iter</a>(&self) -> <a class="struct" href="../../indexmap/map/struct.Iter.html" title="struct indexmap::map::Iter">Iter</a><'_, K, V><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../indexmap/map/struct.Iter.html" title="struct indexmap::map::Iter">Iter</a><'a, K, V></h3><code class="content"><span class="where fmt-newline">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../../indexmap/map/struct.Iter.html" title="struct indexmap::map::Iter">Iter</a><'a, K, V></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/indexmap/map.rs.html#213-217" title="goto source code">[src]</a></h4><div class="docblock"><p>Return an iterator over the key-value pairs of the map, in their order</p>
|
||
</div><h4 id="method.iter_mut" class="method"><code>pub fn <a href="#method.iter_mut" class="fnname">iter_mut</a>(&mut self) -> <a class="struct" href="../../indexmap/map/struct.IterMut.html" title="struct indexmap::map::IterMut">IterMut</a><'_, K, V><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../indexmap/map/struct.IterMut.html" title="struct indexmap::map::IterMut">IterMut</a><'a, K, V></h3><code class="content"><span class="where fmt-newline">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../../indexmap/map/struct.IterMut.html" title="struct indexmap::map::IterMut">IterMut</a><'a, K, V></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/indexmap/map.rs.html#220-224" title="goto source code">[src]</a></h4><div class="docblock"><p>Return an iterator over the key-value pairs of the map, in their order</p>
|
||
</div><h4 id="method.keys" class="method"><code>pub fn <a href="#method.keys" class="fnname">keys</a>(&self) -> <a class="struct" href="../../indexmap/map/struct.Keys.html" title="struct indexmap::map::Keys">Keys</a><'_, K, V><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../indexmap/map/struct.Keys.html" title="struct indexmap::map::Keys">Keys</a><'a, K, V></h3><code class="content"><span class="where fmt-newline">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../../indexmap/map/struct.Keys.html" title="struct indexmap::map::Keys">Keys</a><'a, K, V></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>K;</span></code></span></div></span></span></code><a class="srclink" href="../../src/indexmap/map.rs.html#227-231" title="goto source code">[src]</a></h4><div class="docblock"><p>Return an iterator over the keys of the map, in their order</p>
|
||
</div><h4 id="method.values" class="method"><code>pub fn <a href="#method.values" class="fnname">values</a>(&self) -> <a class="struct" href="../../indexmap/map/struct.Values.html" title="struct indexmap::map::Values">Values</a><'_, K, V><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../indexmap/map/struct.Values.html" title="struct indexmap::map::Values">Values</a><'a, K, V></h3><code class="content"><span class="where fmt-newline">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../../indexmap/map/struct.Values.html" title="struct indexmap::map::Values">Values</a><'a, K, V></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>V;</span></code></span></div></span></span></code><a class="srclink" href="../../src/indexmap/map.rs.html#234-238" title="goto source code">[src]</a></h4><div class="docblock"><p>Return an iterator over the values of the map, in their order</p>
|
||
</div><h4 id="method.values_mut" class="method"><code>pub fn <a href="#method.values_mut" class="fnname">values_mut</a>(&mut self) -> <a class="struct" href="../../indexmap/map/struct.ValuesMut.html" title="struct indexmap::map::ValuesMut">ValuesMut</a><'_, K, V><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../indexmap/map/struct.ValuesMut.html" title="struct indexmap::map::ValuesMut">ValuesMut</a><'a, K, V></h3><code class="content"><span class="where fmt-newline">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../../indexmap/map/struct.ValuesMut.html" title="struct indexmap::map::ValuesMut">ValuesMut</a><'a, K, V></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>V;</span></code></span></div></span></span></code><a class="srclink" href="../../src/indexmap/map.rs.html#242-246" title="goto source code">[src]</a></h4><div class="docblock"><p>Return an iterator over mutable references to the the values of the map,
|
||
in their order</p>
|
||
</div><h4 id="method.clear" class="method"><code>pub fn <a href="#method.clear" class="fnname">clear</a>(&mut self)</code><a class="srclink" href="../../src/indexmap/map.rs.html#251-253" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove all key-value pairs in the map, while preserving its capacity.</p>
|
||
<p>Computes in <strong>O(n)</strong> time.</p>
|
||
</div><h4 id="method.truncate" class="method"><code>pub fn <a href="#method.truncate" class="fnname">truncate</a>(&mut self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class="srclink" href="../../src/indexmap/map.rs.html#258-260" title="goto source code">[src]</a></h4><div class="docblock"><p>Shortens the map, keeping the first <code>len</code> elements and dropping the rest.</p>
|
||
<p>If <code>len</code> is greater than the map's current length, this has no effect.</p>
|
||
</div><h4 id="method.drain" class="method"><code>pub fn <a href="#method.drain" class="fnname">drain</a><R>(&mut self, range: R) -> <a class="struct" href="../../indexmap/map/struct.Drain.html" title="struct indexmap::map::Drain">Drain</a><'_, K, V><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../indexmap/map/struct.Drain.html" title="struct indexmap::map::Drain">Drain</a><'_, K, V></h3><code class="content"><span class="where fmt-newline">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../../indexmap/map/struct.Drain.html" title="struct indexmap::map::Drain">Drain</a><'_, K, V></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/range/trait.RangeBounds.html" title="trait core::ops::range::RangeBounds">RangeBounds</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#275-282" title="goto source code">[src]</a></h4><div class="docblock"><p>Clears the <code>IndexMap</code> in the given index range, returning those
|
||
key-value pairs as a drain iterator.</p>
|
||
<p>The range may be any type that implements <code>RangeBounds<usize></code>,
|
||
including all of the <code>std::ops::Range*</code> types, or even a tuple pair of
|
||
<code>Bound</code> start and end values. To drain the map entirely, use <code>RangeFull</code>
|
||
like <code>map.drain(..)</code>.</p>
|
||
<p>This shifts down all entries following the drained range to fill the
|
||
gap, and keeps the allocated memory for reuse.</p>
|
||
<p><em><strong>Panics</strong></em> if the starting point is greater than the end point or if
|
||
the end point is greater than the length of the map.</p>
|
||
</div><h4 id="method.split_off" class="method"><code>pub fn <a href="#method.split_off" class="fnname">split_off</a>(&mut self, at: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self <span class="where fmt-newline">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#291-299" title="goto source code">[src]</a></h4><div class="docblock"><p>Splits the collection into two at the given index.</p>
|
||
<p>Returns a newly allocated map containing the elements in the range
|
||
<code>[at, len)</code>. After the call, the original map will be left containing
|
||
the elements <code>[0, at)</code> with its previous capacity unchanged.</p>
|
||
<p><em><strong>Panics</strong></em> if <code>at > len</code>.</p>
|
||
</div></div><h3 id="impl-2" class="impl"><code class="in-band">impl<K, V, S> <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></code><a href="#impl-2" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#302-699" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.reserve" class="method"><code>pub fn <a href="#method.reserve" class="fnname">reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class="srclink" href="../../src/indexmap/map.rs.html#310-312" title="goto source code">[src]</a></h4><div class="docblock"><p>Reserve capacity for <code>additional</code> more key-value pairs.</p>
|
||
<p>Computes in <strong>O(n)</strong> time.</p>
|
||
</div><h4 id="method.shrink_to_fit" class="method"><code>pub fn <a href="#method.shrink_to_fit" class="fnname">shrink_to_fit</a>(&mut self)</code><a class="srclink" href="../../src/indexmap/map.rs.html#317-319" title="goto source code">[src]</a></h4><div class="docblock"><p>Shrink the capacity of the map as much as possible.</p>
|
||
<p>Computes in <strong>O(n)</strong> time.</p>
|
||
</div><h4 id="method.insert" class="method"><code>pub fn <a href="#method.insert" class="fnname">insert</a>(&mut self, key: K, value: V) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V></code><a class="srclink" href="../../src/indexmap/map.rs.html#340-342" title="goto source code">[src]</a></h4><div class="docblock"><p>Insert a key-value pair in the map.</p>
|
||
<p>If an equivalent key already exists in the map: the key remains and
|
||
retains in its place in the order, its corresponding value is updated
|
||
with <code>value</code> and the older value is returned inside <code>Some(_)</code>.</p>
|
||
<p>If no equivalent key existed in the map: the new key-value pair is
|
||
inserted, last in order, and <code>None</code> is returned.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (amortized average).</p>
|
||
<p>See also <a href="#method.entry"><code>entry</code></a> if you you want to insert <em>or</em> modify
|
||
or if you need to get the index of the corresponding key-value pair.</p>
|
||
</div><h4 id="method.insert_full" class="method"><code>pub fn <a href="#method.insert_full" class="fnname">insert_full</a>(&mut self, key: K, value: V) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class="srclink" href="../../src/indexmap/map.rs.html#357-360" title="goto source code">[src]</a></h4><div class="docblock"><p>Insert a key-value pair in the map, and get their index.</p>
|
||
<p>If an equivalent key already exists in the map: the key remains and
|
||
retains in its place in the order, its corresponding value is updated
|
||
with <code>value</code> and the older value is returned inside <code>(index, Some(_))</code>.</p>
|
||
<p>If no equivalent key existed in the map: the new key-value pair is
|
||
inserted, last in order, and <code>(index, None)</code> is returned.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (amortized average).</p>
|
||
<p>See also <a href="#method.entry"><code>entry</code></a> if you you want to insert <em>or</em> modify
|
||
or if you need to get the index of the corresponding key-value pair.</p>
|
||
</div><h4 id="method.entry" class="method"><code>pub fn <a href="#method.entry" class="fnname">entry</a>(&mut self, key: K) -> <a class="enum" href="../../indexmap/map/enum.Entry.html" title="enum indexmap::map::Entry">Entry</a><'_, K, V></code><a class="srclink" href="../../src/indexmap/map.rs.html#366-369" title="goto source code">[src]</a></h4><div class="docblock"><p>Get the given key’s corresponding entry in the map for insertion and/or
|
||
in-place manipulation.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (amortized average).</p>
|
||
</div><h4 id="method.contains_key" class="method"><code>pub fn <a href="#method.contains_key" class="fnname">contains_key</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#374-379" title="goto source code">[src]</a></h4><div class="docblock"><p>Return <code>true</code> if an equivalent to <code>key</code> exists in the map.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id="method.get" class="method"><code>pub fn <a href="#method.get" class="fnname">get</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#385-395" title="goto source code">[src]</a></h4><div class="docblock"><p>Return a reference to the value stored for <code>key</code>, if it is present,
|
||
else <code>None</code>.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id="method.get_key_value" class="method"><code>pub fn <a href="#method.get_key_value" class="fnname">get_key_value</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#401-411" title="goto source code">[src]</a></h4><div class="docblock"><p>Return references to the key-value pair stored for <code>key</code>,
|
||
if it is present, else <code>None</code>.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id="method.get_full" class="method"><code>pub fn <a href="#method.get_full" class="fnname">get_full</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#414-424" title="goto source code">[src]</a></h4><div class="docblock"><p>Return item index, key and value</p>
|
||
</div><h4 id="method.get_index_of" class="method"><code>pub fn <a href="#method.get_index_of" class="fnname">get_index_of</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#427-437" title="goto source code">[src]</a></h4><div class="docblock"><p>Return item index, if it exists in the map</p>
|
||
</div><h4 id="method.get_mut" class="method"><code>pub fn <a href="#method.get_mut" class="fnname">get_mut</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#439-449" title="goto source code">[src]</a></h4><h4 id="method.get_full_mut" class="method"><code>pub fn <a href="#method.get_full_mut" class="fnname">get_full_mut</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &mut self, <br> key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#451-461" title="goto source code">[src]</a></h4><h4 id="method.remove" class="method"><code>pub fn <a href="#method.remove" class="fnname">remove</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#486-491" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove the key-value pair equivalent to <code>key</code> and return
|
||
its value.</p>
|
||
<p><strong>NOTE:</strong> This is equivalent to <code>.swap_remove(key)</code>, if you need to
|
||
preserve the order of the keys in the map, use <code>.shift_remove(key)</code>
|
||
instead.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id="method.remove_entry" class="method"><code>pub fn <a href="#method.remove_entry" class="fnname">remove_entry</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#500-505" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove and return the key-value pair equivalent to <code>key</code>.</p>
|
||
<p><strong>NOTE:</strong> This is equivalent to <code>.swap_remove_entry(key)</code>, if you need to
|
||
preserve the order of the keys in the map, use <code>.shift_remove_entry(key)</code>
|
||
instead.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id="method.swap_remove" class="method"><code>pub fn <a href="#method.swap_remove" class="fnname">swap_remove</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#517-522" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove the key-value pair equivalent to <code>key</code> and return
|
||
its value.</p>
|
||
<p>Like <code>Vec::swap_remove</code>, the pair is removed by swapping it with the
|
||
last element of the map and popping it off. <strong>This perturbs
|
||
the position of what used to be the last element!</strong></p>
|
||
<p>Return <code>None</code> if <code>key</code> is not in map.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id="method.swap_remove_entry" class="method"><code>pub fn <a href="#method.swap_remove_entry" class="fnname">swap_remove_entry</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#533-541" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove and return the key-value pair equivalent to <code>key</code>.</p>
|
||
<p>Like <code>Vec::swap_remove</code>, the pair is removed by swapping it with the
|
||
last element of the map and popping it off. <strong>This perturbs
|
||
the position of what used to be the last element!</strong></p>
|
||
<p>Return <code>None</code> if <code>key</code> is not in map.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id="method.swap_remove_full" class="method"><code>pub fn <a href="#method.swap_remove_full" class="fnname">swap_remove_full</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#553-562" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove the key-value pair equivalent to <code>key</code> and return it and
|
||
the index it had.</p>
|
||
<p>Like <code>Vec::swap_remove</code>, the pair is removed by swapping it with the
|
||
last element of the map and popping it off. <strong>This perturbs
|
||
the position of what used to be the last element!</strong></p>
|
||
<p>Return <code>None</code> if <code>key</code> is not in map.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id="method.shift_remove" class="method"><code>pub fn <a href="#method.shift_remove" class="fnname">shift_remove</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#574-579" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove the key-value pair equivalent to <code>key</code> and return
|
||
its value.</p>
|
||
<p>Like <code>Vec::remove</code>, the pair is removed by shifting all of the
|
||
elements that follow it, preserving their relative order.
|
||
<strong>This perturbs the index of all of those elements!</strong></p>
|
||
<p>Return <code>None</code> if <code>key</code> is not in map.</p>
|
||
<p>Computes in <strong>O(n)</strong> time (average).</p>
|
||
</div><h4 id="method.shift_remove_entry" class="method"><code>pub fn <a href="#method.shift_remove_entry" class="fnname">shift_remove_entry</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#590-598" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove and return the key-value pair equivalent to <code>key</code>.</p>
|
||
<p>Like <code>Vec::remove</code>, the pair is removed by shifting all of the
|
||
elements that follow it, preserving their relative order.
|
||
<strong>This perturbs the index of all of those elements!</strong></p>
|
||
<p>Return <code>None</code> if <code>key</code> is not in map.</p>
|
||
<p>Computes in <strong>O(n)</strong> time (average).</p>
|
||
</div><h4 id="method.shift_remove_full" class="method"><code>pub fn <a href="#method.shift_remove_full" class="fnname">shift_remove_full</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#610-619" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove the key-value pair equivalent to <code>key</code> and return it and
|
||
the index it had.</p>
|
||
<p>Like <code>Vec::remove</code>, the pair is removed by shifting all of the
|
||
elements that follow it, preserving their relative order.
|
||
<strong>This perturbs the index of all of those elements!</strong></p>
|
||
<p>Return <code>None</code> if <code>key</code> is not in map.</p>
|
||
<p>Computes in <strong>O(n)</strong> time (average).</p>
|
||
</div><h4 id="method.pop" class="method"><code>pub fn <a href="#method.pop" class="fnname">pop</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/indexmap/map.rs.html#624-626" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove the last key-value pair</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id="method.retain" class="method"><code>pub fn <a href="#method.retain" class="fnname">retain</a><F>(&mut self, keep: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#635-640" title="goto source code">[src]</a></h4><div class="docblock"><p>Scan through each key-value pair in the map and keep those where the
|
||
closure <code>keep</code> returns <code>true</code>.</p>
|
||
<p>The elements are visited in order, and remaining elements keep their
|
||
order.</p>
|
||
<p>Computes in <strong>O(n)</strong> time (average).</p>
|
||
</div><h4 id="method.sort_keys" class="method"><code>pub fn <a href="#method.sort_keys" class="fnname">sort_keys</a>(&mut self) <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#652-659" title="goto source code">[src]</a></h4><div class="docblock"><p>Sort the map’s key-value pairs by the default ordering of the keys.</p>
|
||
<p>See <code>sort_by</code> for details.</p>
|
||
</div><h4 id="method.sort_by" class="method"><code>pub fn <a href="#method.sort_by" class="fnname">sort_by</a><F>(&mut self, cmp: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#669-676" title="goto source code">[src]</a></h4><div class="docblock"><p>Sort the map’s key-value pairs in place using the comparison
|
||
function <code>compare</code>.</p>
|
||
<p>The comparison function receives two key and value pairs to compare (you
|
||
can sort by keys or values or their combination as needed).</p>
|
||
<p>Computes in <strong>O(n log n + c)</strong> time and <strong>O(n)</strong> space where <em>n</em> is
|
||
the length of the map and <em>c</em> the capacity. The sort is stable.</p>
|
||
</div><h4 id="method.sorted_by" class="method"><code>pub fn <a href="#method.sorted_by" class="fnname">sorted_by</a><F>(self, cmp: F) -> <a class="struct" href="../../indexmap/map/struct.IntoIter.html" title="struct indexmap::map::IntoIter">IntoIter</a><K, V><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../indexmap/map/struct.IntoIter.html" title="struct indexmap::map::IntoIter">IntoIter</a><K, V></h3><code class="content"><span class="where fmt-newline">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../../indexmap/map/struct.IntoIter.html" title="struct indexmap::map::IntoIter">IntoIter</a><K, V></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>, </span></code><a class="srclink" href="../../src/indexmap/map.rs.html#682-691" title="goto source code">[src]</a></h4><div class="docblock"><p>Sort the key-value pairs of the map and return a by value iterator of
|
||
the key-value pairs with the result.</p>
|
||
<p>The sort is stable.</p>
|
||
</div><h4 id="method.reverse" class="method"><code>pub fn <a href="#method.reverse" class="fnname">reverse</a>(&mut self)</code><a class="srclink" href="../../src/indexmap/map.rs.html#696-698" title="goto source code">[src]</a></h4><div class="docblock"><p>Reverses the order of the map’s key-value pairs in place.</p>
|
||
<p>Computes in <strong>O(n)</strong> time and <strong>O(1)</strong> space.</p>
|
||
</div></div><h3 id="impl-3" class="impl"><code class="in-band">impl<K, V, S> <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S></code><a href="#impl-3" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#701-780" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_index" class="method"><code>pub fn <a href="#method.get_index" class="fnname">get_index</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/indexmap/map.rs.html#707-709" title="goto source code">[src]</a></h4><div class="docblock"><p>Get a key-value pair by index</p>
|
||
<p>Valid indices are <em>0 <= index < self.len()</em></p>
|
||
<p>Computes in <strong>O(1)</strong> time.</p>
|
||
</div><h4 id="method.get_index_mut" class="method"><code>pub fn <a href="#method.get_index_mut" class="fnname">get_index_mut</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/indexmap/map.rs.html#716-718" title="goto source code">[src]</a></h4><div class="docblock"><p>Get a key-value pair by index</p>
|
||
<p>Valid indices are <em>0 <= index < self.len()</em></p>
|
||
<p>Computes in <strong>O(1)</strong> time.</p>
|
||
</div><h4 id="method.first" class="method"><code>pub fn <a href="#method.first" class="fnname">first</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/indexmap/map.rs.html#723-725" title="goto source code">[src]</a></h4><div class="docblock"><p>Get the first key-value pair</p>
|
||
<p>Computes in <strong>O(1)</strong> time.</p>
|
||
</div><h4 id="method.first_mut" class="method"><code>pub fn <a href="#method.first_mut" class="fnname">first_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/indexmap/map.rs.html#730-732" title="goto source code">[src]</a></h4><div class="docblock"><p>Get the first key-value pair, with mutable access to the value</p>
|
||
<p>Computes in <strong>O(1)</strong> time.</p>
|
||
</div><h4 id="method.last" class="method"><code>pub fn <a href="#method.last" class="fnname">last</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/indexmap/map.rs.html#737-739" title="goto source code">[src]</a></h4><div class="docblock"><p>Get the last key-value pair</p>
|
||
<p>Computes in <strong>O(1)</strong> time.</p>
|
||
</div><h4 id="method.last_mut" class="method"><code>pub fn <a href="#method.last_mut" class="fnname">last_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/indexmap/map.rs.html#744-746" title="goto source code">[src]</a></h4><div class="docblock"><p>Get the last key-value pair, with mutable access to the value</p>
|
||
<p>Computes in <strong>O(1)</strong> time.</p>
|
||
</div><h4 id="method.swap_remove_index" class="method"><code>pub fn <a href="#method.swap_remove_index" class="fnname">swap_remove_index</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/indexmap/map.rs.html#757-759" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove the key-value pair by index</p>
|
||
<p>Valid indices are <em>0 <= index < self.len()</em></p>
|
||
<p>Like <code>Vec::swap_remove</code>, the pair is removed by swapping it with the
|
||
last element of the map and popping it off. <strong>This perturbs
|
||
the position of what used to be the last element!</strong></p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id="method.shift_remove_index" class="method"><code>pub fn <a href="#method.shift_remove_index" class="fnname">shift_remove_index</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/indexmap/map.rs.html#770-772" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove the key-value pair by index</p>
|
||
<p>Valid indices are <em>0 <= index < self.len()</em></p>
|
||
<p>Like <code>Vec::remove</code>, the pair is removed by shifting all of the
|
||
elements that follow it, preserving their relative order.
|
||
<strong>This perturbs the index of all of those elements!</strong></p>
|
||
<p>Computes in <strong>O(n)</strong> time (average).</p>
|
||
</div><h4 id="method.swap_indices" class="method"><code>pub fn <a href="#method.swap_indices" class="fnname">swap_indices</a>(&mut self, a: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class="srclink" href="../../src/indexmap/map.rs.html#777-779" title="goto source code">[src]</a></h4><div class="docblock"><p>Swaps the position of two key-value pairs in the map.</p>
|
||
<p><em><strong>Panics</strong></em> if <code>a</code> or <code>b</code> are out of bounds.</p>
|
||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#81-98" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> Self</code><a class="srclink" href="../../src/indexmap/map.rs.html#87-92" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id="method.clone_from" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><a class="srclink" href="../../src/indexmap/map.rs.html#94-97" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, </span></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#126-141" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/indexmap/map.rs.html#131-140" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id="impl-Default" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>, </span></code><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1283-1291" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.default" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</code><a class="srclink" href="../../src/indexmap/map.rs.html#1288-1290" title="goto source code">[src]</a></h4><div class="docblock"><p>Return an empty <code>IndexMap</code></p>
|
||
</div></div><h3 id="impl-Eq" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></code><a href="#impl-Eq" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1310-1316" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Extend%3C(%26%27a%20K%2C%20%26%27a%20V)%3E" class="impl"><code class="in-band">impl<'a, K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></code><a href="#impl-Extend%3C(%26%27a%20K%2C%20%26%27a%20V)%3E" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1269-1281" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.extend-1" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#tymethod.extend" class="fnname">extend</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>>(&mut self, iterable: I)</code><a class="srclink" href="../../src/indexmap/map.rs.html#1278-1280" title="goto source code">[src]</a></h4><div class="docblock"><p>Extend the map with all key-value pairs in the iterable.</p>
|
||
<p>See the first extend method for more details.</p>
|
||
</div><h4 id="method.extend_one-1" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#method.extend_one" class="fnname">extend_one</a>(&mut self, item: A)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/iter/traits/collect.rs.html#340" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>extend_one</code>)</div></div><div class='docblock hidden'><p>Extends a collection with exactly one element.</p>
|
||
</div><h4 id="method.extend_reserve-1" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#method.extend_reserve" class="fnname">extend_reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/iter/traits/collect.rs.html#348" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>extend_one</code>)</div></div><div class='docblock hidden'><p>Reserves capacity in a collection for the given number of additional elements. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#method.extend_reserve">Read more</a></p>
|
||
</div></div><h3 id="impl-Extend%3C(K%2C%20V)%3E" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></code><a href="#impl-Extend%3C(K%2C%20V)%3E" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1236-1267" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.extend" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#tymethod.extend" class="fnname">extend</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>>(&mut self, iterable: I)</code><a class="srclink" href="../../src/indexmap/map.rs.html#1250-1266" title="goto source code">[src]</a></h4><div class="docblock"><p>Extend the map with all key-value pairs in the iterable.</p>
|
||
<p>This is equivalent to calling <a href="#method.insert"><code>insert</code></a> for each of
|
||
them in order, which means that for keys that already existed
|
||
in the map, their value is updated but it keeps the existing order.</p>
|
||
<p>New keys are inserted in the order they appear in the sequence. If
|
||
equivalents of a key occur more than once, the last corresponding value
|
||
prevails.</p>
|
||
</div><h4 id="method.extend_one" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#method.extend_one" class="fnname">extend_one</a>(&mut self, item: A)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/iter/traits/collect.rs.html#340" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>extend_one</code>)</div></div><div class='docblock hidden'><p>Extends a collection with exactly one element.</p>
|
||
</div><h4 id="method.extend_reserve" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#method.extend_reserve" class="fnname">extend_reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/iter/traits/collect.rs.html#348" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>extend_one</code>)</div></div><div class='docblock hidden'><p>Reserves capacity in a collection for the given number of additional elements. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#method.extend_reserve">Read more</a></p>
|
||
</div></div><h3 id="impl-FromIterator%3C(K%2C%20V)%3E" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>, </span></code><a href="#impl-FromIterator%3C(K%2C%20V)%3E" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1217-1234" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from_iter" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html#tymethod.from_iter" class="fnname">from_iter</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>>(iterable: I) -> Self</code><a class="srclink" href="../../src/indexmap/map.rs.html#1227-1233" title="goto source code">[src]</a></h4><div class="docblock"><p>Create an <code>IndexMap</code> from the sequence of key-value pairs in the
|
||
iterable.</p>
|
||
<p><code>from_iter</code> uses the same logic as <code>extend</code>. See
|
||
<a href="#method.extend"><code>extend</code></a> for more details.</p>
|
||
</div></div><h3 id="impl-Index%3C%26%27_%20Q%3E" class="impl"><code class="in-band">impl<K, V, Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ </a>Q> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>,<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></code><a href="#impl-Index%3C%26%27_%20Q%3E" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1077-1091" title="goto source code">[src]</a></h3><div class="docblock"><p>Access <code>IndexMap</code> values corresponding to a key.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">indexmap</span>::<span class="ident">IndexMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">IndexMap</span>::<span class="ident">new</span>();
|
||
<span class="kw">for</span> <span class="ident">word</span> <span class="kw">in</span> <span class="string">"Lorem ipsum dolor sit amet"</span>.<span class="ident">split_whitespace</span>() {
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="ident">word</span>.<span class="ident">to_lowercase</span>(), <span class="ident">word</span>.<span class="ident">to_uppercase</span>());
|
||
}
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"lorem"</span>], <span class="string">"LOREM"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"ipsum"</span>], <span class="string">"IPSUM"</span>);</pre></div>
|
||
|
||
<div class='information'><div class='tooltip should_panic'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered should_panic">
|
||
<span class="kw">use</span> <span class="ident">indexmap</span>::<span class="ident">IndexMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">IndexMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">"foo"</span>, <span class="number">1</span>);
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">map</span>[<span class="string">"bar"</span>]); <span class="comment">// panics!</span></pre></div>
|
||
</div><div class="impl-items"><h4 id="associatedtype.Output" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" class="type">Output</a> = V</code></h4><div class='docblock'><p>The returned type after indexing.</p>
|
||
</div><h4 id="method.index" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#tymethod.index" class="fnname">index</a>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V</code><a class="srclink" href="../../src/indexmap/map.rs.html#1088-1090" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the value corresponding to the supplied <code>key</code>.</p>
|
||
<p><em><strong>Panics</strong></em> if <code>key</code> is not present in the map.</p>
|
||
</div></div><h3 id="impl-Index%3Cusize%3E" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S></code><a href="#impl-Index%3Cusize%3E" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1164-1175" title="goto source code">[src]</a></h3><div class="docblock"><p>Access <code>IndexMap</code> values at indexed positions.</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">indexmap</span>::<span class="ident">IndexMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">IndexMap</span>::<span class="ident">new</span>();
|
||
<span class="kw">for</span> <span class="ident">word</span> <span class="kw">in</span> <span class="string">"Lorem ipsum dolor sit amet"</span>.<span class="ident">split_whitespace</span>() {
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="ident">word</span>.<span class="ident">to_lowercase</span>(), <span class="ident">word</span>.<span class="ident">to_uppercase</span>());
|
||
}
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="number">0</span>], <span class="string">"LOREM"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="number">1</span>], <span class="string">"IPSUM"</span>);
|
||
<span class="ident">map</span>.<span class="ident">reverse</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="number">0</span>], <span class="string">"AMET"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="number">1</span>], <span class="string">"SIT"</span>);
|
||
<span class="ident">map</span>.<span class="ident">sort_keys</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="number">0</span>], <span class="string">"AMET"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="number">1</span>], <span class="string">"DOLOR"</span>);</pre></div>
|
||
|
||
<div class='information'><div class='tooltip should_panic'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered should_panic">
|
||
<span class="kw">use</span> <span class="ident">indexmap</span>::<span class="ident">IndexMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">IndexMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">"foo"</span>, <span class="number">1</span>);
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">map</span>[<span class="number">10</span>]); <span class="comment">// panics!</span></pre></div>
|
||
</div><div class="impl-items"><h4 id="associatedtype.Output-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" class="type">Output</a> = V</code></h4><div class='docblock'><p>The returned type after indexing.</p>
|
||
</div><h4 id="method.index-1" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#tymethod.index" class="fnname">index</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V</code><a class="srclink" href="../../src/indexmap/map.rs.html#1170-1174" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the value at the supplied <code>index</code>.</p>
|
||
<p><em><strong>Panics</strong></em> if <code>index</code> is out of bounds.</p>
|
||
</div></div><h3 id="impl-IndexMut%3C%26%27_%20Q%3E" class="impl"><code class="in-band">impl<K, V, Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.IndexMut.html" title="trait core::ops::index::IndexMut">IndexMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ </a>Q> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>,<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></code><a href="#impl-IndexMut%3C%26%27_%20Q%3E" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1122-1134" title="goto source code">[src]</a></h3><div class="docblock"><p>Access <code>IndexMap</code> values corresponding to a key.</p>
|
||
<p>Mutable indexing allows changing / updating values of key-value
|
||
pairs that are already present.</p>
|
||
<p>You can <strong>not</strong> insert new pairs with index syntax, use <code>.insert()</code>.</p>
|
||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">indexmap</span>::<span class="ident">IndexMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">IndexMap</span>::<span class="ident">new</span>();
|
||
<span class="kw">for</span> <span class="ident">word</span> <span class="kw">in</span> <span class="string">"Lorem ipsum dolor sit amet"</span>.<span class="ident">split_whitespace</span>() {
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="ident">word</span>.<span class="ident">to_lowercase</span>(), <span class="ident">word</span>.<span class="ident">to_string</span>());
|
||
}
|
||
<span class="kw">let</span> <span class="ident">lorem</span> <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">map</span>[<span class="string">"lorem"</span>];
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">lorem</span>, <span class="string">"Lorem"</span>);
|
||
<span class="ident">lorem</span>.<span class="ident">retain</span>(<span class="ident">char</span>::<span class="ident">is_lowercase</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"lorem"</span>], <span class="string">"orem"</span>);</pre></div>
|
||
|
||
<div class='information'><div class='tooltip should_panic'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered should_panic">
|
||
<span class="kw">use</span> <span class="ident">indexmap</span>::<span class="ident">IndexMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">IndexMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">"foo"</span>, <span class="number">1</span>);
|
||
<span class="ident">map</span>[<span class="string">"bar"</span>] <span class="op">=</span> <span class="number">1</span>; <span class="comment">// panics!</span></pre></div>
|
||
</div><div class="impl-items"><h4 id="method.index_mut" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/ops/index/trait.IndexMut.html#tymethod.index_mut" class="fnname">index_mut</a>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V</code><a class="srclink" href="../../src/indexmap/map.rs.html#1131-1133" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the value corresponding to the supplied <code>key</code>.</p>
|
||
<p><em><strong>Panics</strong></em> if <code>key</code> is not present in the map.</p>
|
||
</div></div><h3 id="impl-IndexMut%3Cusize%3E" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.IndexMut.html" title="trait core::ops::index::IndexMut">IndexMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S></code><a href="#impl-IndexMut%3Cusize%3E" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1206-1215" title="goto source code">[src]</a></h3><div class="docblock"><p>Access <code>IndexMap</code> values at indexed positions.</p>
|
||
<p>Mutable indexing allows changing / updating indexed values
|
||
that are already present.</p>
|
||
<p>You can <strong>not</strong> insert new values with index syntax, use <code>.insert()</code>.</p>
|
||
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">indexmap</span>::<span class="ident">IndexMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">IndexMap</span>::<span class="ident">new</span>();
|
||
<span class="kw">for</span> <span class="ident">word</span> <span class="kw">in</span> <span class="string">"Lorem ipsum dolor sit amet"</span>.<span class="ident">split_whitespace</span>() {
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="ident">word</span>.<span class="ident">to_lowercase</span>(), <span class="ident">word</span>.<span class="ident">to_string</span>());
|
||
}
|
||
<span class="kw">let</span> <span class="ident">lorem</span> <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">map</span>[<span class="number">0</span>];
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">lorem</span>, <span class="string">"Lorem"</span>);
|
||
<span class="ident">lorem</span>.<span class="ident">retain</span>(<span class="ident">char</span>::<span class="ident">is_lowercase</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"lorem"</span>], <span class="string">"orem"</span>);</pre></div>
|
||
|
||
<div class='information'><div class='tooltip should_panic'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered should_panic">
|
||
<span class="kw">use</span> <span class="ident">indexmap</span>::<span class="ident">IndexMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">IndexMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">"foo"</span>, <span class="number">1</span>);
|
||
<span class="ident">map</span>[<span class="number">10</span>] <span class="op">=</span> <span class="number">1</span>; <span class="comment">// panics!</span></pre></div>
|
||
</div><div class="impl-items"><h4 id="method.index_mut-1" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/ops/index/trait.IndexMut.html#tymethod.index_mut" class="fnname">index_mut</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V</code><a class="srclink" href="../../src/indexmap/map.rs.html#1210-1214" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the value at the supplied <code>index</code>.</p>
|
||
<p><em><strong>Panics</strong></em> if <code>index</code> is out of bounds.</p>
|
||
</div></div><h3 id="impl-IntoIterator" class="impl"><code class="in-band">impl<'a, K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S></code><a href="#impl-IntoIterator" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1029-1035" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Item" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
</div><h4 id="associatedtype.IntoIter" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="type">IntoIter</a> = <a class="struct" href="../../indexmap/map/struct.Iter.html" title="struct indexmap::map::Iter">Iter</a><'a, K, V></code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
</div><h4 id="method.into_iter" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fnname">into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></code><a class="srclink" href="../../src/indexmap/map.rs.html#1032-1034" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
</div></div><h3 id="impl-IntoIterator-1" class="impl"><code class="in-band">impl<'a, K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S></code><a href="#impl-IntoIterator-1" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1037-1043" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Item-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
</div><h4 id="associatedtype.IntoIter-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="type">IntoIter</a> = <a class="struct" href="../../indexmap/map/struct.IterMut.html" title="struct indexmap::map::IterMut">IterMut</a><'a, K, V></code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
</div><h4 id="method.into_iter-1" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fnname">into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></code><a class="srclink" href="../../src/indexmap/map.rs.html#1040-1042" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
</div></div><h3 id="impl-IntoIterator-2" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S></code><a href="#impl-IntoIterator-2" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1045-1053" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Item-2" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
</div><h4 id="associatedtype.IntoIter-2" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="type">IntoIter</a> = <a class="struct" href="../../indexmap/map/struct.IntoIter.html" title="struct indexmap::map::IntoIter">IntoIter</a><K, V></code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
</div><h4 id="method.into_iter-2" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fnname">into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></code><a class="srclink" href="../../src/indexmap/map.rs.html#1048-1052" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
</div></div><h3 id="impl-MutableKeys" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="../../indexmap/map/trait.MutableKeys.html" title="trait indexmap::map::MutableKeys">MutableKeys</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></code><a href="#impl-MutableKeys" class="anchor"></a><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#51-75" title="goto source code">[src]</a></h3><div class="docblock"><p>Opt-in mutable access to keys.</p>
|
||
<p>See <a href="trait.MutableKeys.html"><code>MutableKeys</code></a> for more information.</p>
|
||
</div><div class="impl-items"><h4 id="associatedtype.Key" class="type"><code>type <a href="../../indexmap/map/trait.MutableKeys.html#associatedtype.Key" class="type">Key</a> = K</code></h4><h4 id="associatedtype.Value" class="type"><code>type <a href="../../indexmap/map/trait.MutableKeys.html#associatedtype.Value" class="type">Value</a> = V</code></h4><h4 id="method.get_full_mut2" class="method hidden"><code>fn <a href="../../indexmap/map/trait.MutableKeys.html#tymethod.get_full_mut2" class="fnname">get_full_mut2</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &mut self, <br> key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../../indexmap/trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><K>, </span></code><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#58-63" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Return item index, mutable reference to key and value</p>
|
||
</div><h4 id="method.retain2" class="method hidden"><code>fn <a href="../../indexmap/map/trait.MutableKeys.html#tymethod.retain2" class="fnname">retain2</a><F>(&mut self, keep: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, </span></code><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#65-70" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Scan through each key-value pair in the map and keep those where the
|
||
closure <code>keep</code> returns <code>true</code>. <a href="../../indexmap/map/trait.MutableKeys.html#tymethod.retain2">Read more</a></p>
|
||
</div><h4 id="method.__private_marker" class="method hidden"><code>fn <a href="../../indexmap/map/trait.MutableKeys.html#tymethod.__private_marker" class="fnname">__private_marker</a>(&self) -> PrivateMarker</code><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#72-74" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>This method is not useful in itself – it is there to “seal” the trait
|
||
for external implementation, so that we can add methods without
|
||
causing breaking changes. <a href="../../indexmap/map/trait.MutableKeys.html#tymethod.__private_marker">Read more</a></p>
|
||
</div></div><h3 id="impl-PartialEq%3CIndexMap%3CK%2C%20V2%2C%20S2%3E%3E" class="impl"><code class="in-band">impl<K, V1, S1, V2, S2> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V2, S2>> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V1, S1> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,<br> V1: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><V2>,<br> S1: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,<br> S2: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></code><a href="#impl-PartialEq%3CIndexMap%3CK%2C%20V2%2C%20S2%3E%3E" class="anchor"></a><a class="srclink" href="../../src/indexmap/map.rs.html#1293-1308" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.eq" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V2, S2>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/indexmap/map.rs.html#1300-1307" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||
</div><h4 id="method.ne" class="method hidden"><code><span class="docblock attributes">#[must_use]</span>pub fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#213" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
|
||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>, </span></code><a href="#impl-RefUnwindSafe" class="anchor"></a><a class="srclink" href="../../src/indexmap/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../../src/indexmap/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../../src/indexmap/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href="#impl-Unpin" class="anchor"></a><a class="srclink" href="../../src/indexmap/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code><a href="#impl-UnwindSafe" class="anchor"></a><a class="srclink" href="../../src/indexmap/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-ToOwned" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href="#impl-ToOwned" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#80-92" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Owned" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div><h4 id="method.to_owned" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div><h4 id="method.clone_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><details><summary><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="indexmap"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |