366 lines
No EOL
89 KiB
HTML
366 lines
No EOL
89 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 `OrderMap` struct in crate `ordermap`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, OrderMap">
|
||
|
||
<title>ordermap::OrderMap - 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="../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</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>
|
||
|
||
<p class='location'>Struct OrderMap</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.with_capacity">with_capacity</a><a href="#method.with_capacity_and_hasher">with_capacity_and_hasher</a><a href="#method.len">len</a><a href="#method.is_empty">is_empty</a><a href="#method.with_hasher">with_hasher</a><a href="#method.hasher">hasher</a><a href="#method.capacity">capacity</a><a href="#method.clear">clear</a><a href="#method.reserve">reserve</a><a href="#method.insert">insert</a><a href="#method.entry">entry</a><a href="#method.iter">iter</a><a href="#method.iter_mut">iter_mut</a><a href="#method.keys">keys</a><a href="#method.values">values</a><a href="#method.values_mut">values_mut</a><a href="#method.contains_key">contains_key</a><a href="#method.get">get</a><a href="#method.get_full">get_full</a><a href="#method.get_mut">get_mut</a><a href="#method.get_full_mut">get_full_mut</a><a href="#method.remove">remove</a><a href="#method.swap_remove">swap_remove</a><a href="#method.swap_remove_full">swap_remove_full</a><a href="#method.pop">pop</a><a href="#method.retain">retain</a><a href="#method.sort_keys">sort_keys</a><a href="#method.sort_by">sort_by</a><a href="#method.sorted_by">sorted_by</a><a href="#method.drain">drain</a><a href="#method.get_index">get_index</a><a href="#method.get_index_mut">get_index_mut</a><a href="#method.swap_remove_index">swap_remove_index</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-MutableKeys">MutableKeys</a><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-IntoIterator">IntoIterator</a><a href="#impl-Index%3C%26%27a%20Q%3E">Index<&'a Q></a><a href="#impl-IndexMut%3C%26%27a%20Q%3E">IndexMut<&'a Q></a><a href="#impl-FromIterator%3C(K%2C%20V)%3E">FromIterator<(K, V)></a><a href="#impl-Extend%3C(K%2C%20V)%3E">Extend<(K, V)></a><a href="#impl-Extend%3C(%26%27a%20K%2C%20%26%27a%20V)%3E">Extend<(&'a K, &'a V)></a><a href="#impl-Default">Default</a><a href="#impl-PartialEq%3COrderMap%3CK%2C%20V2%2C%20S2%3E%3E">PartialEq<OrderMap<K, V2, S2>></a><a href="#impl-Eq">Eq</a></div></div><p class='location'><a href='index.html'>ordermap</a></p><script>window.sidebarCurrent = {name: 'OrderMap', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../theme.js"></script>
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>ordermap</a>::<wbr><a class="struct" href=''>OrderMap</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/ordermap/lib.rs.html#292-299' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct OrderMap<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 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>
|
||
<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>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">ordermap</span>::<span class="ident">OrderMap</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">OrderMap</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="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>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><code>impl<K, V> <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</a><K, V></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#384-397' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#386-388' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Create a new map. (Does not allocate.)</p>
|
||
</div><h4 id='method.with_capacity' class="method"><span id='with_capacity.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#394-396' title='goto source code'>[src]</a></span></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'><span class='in-band'><code>impl<K, V, S> <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</a><K, V, S></code><a href='#impl-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#399-473' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.with_capacity_and_hasher' class="method"><span id='with_capacity_and_hasher.v' class='invisible'><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 <span class="where fmt-newline">where<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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#405-425' title='goto source code'>[src]</a></span></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.len' class="method"><span id='len.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#430' title='goto source code'>[src]</a></span></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"><span id='is_empty.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#435' title='goto source code'>[src]</a></span></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.with_hasher' class="method"><span id='with_hasher.v' class='invisible'><code>pub fn <a href='#method.with_hasher' class='fnname'>with_hasher</a>(hash_builder: S) -> Self <span class="where fmt-newline">where<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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#438-442' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Create a new map with <code>hash_builder</code></p>
|
||
</div><h4 id='method.hasher' class="method"><span id='hasher.v' class='invisible'><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 <span class="where fmt-newline">where<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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#445-449' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return a reference to the map's <code>BuildHasher</code>.</p>
|
||
</div><h4 id='method.capacity' class="method"><span id='capacity.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#470-472' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Computes in <strong>O(1)</strong> time.</p>
|
||
</div></div><h3 id='impl-2' class='impl'><span class='in-band'><code>impl<K, V, S> <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#632-1137' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.clear' class="method"><span id='clear.v' class='invisible'><code>pub fn <a href='#method.clear' class='fnname'>clear</a>(&mut self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#681-684' title='goto source code'>[src]</a></span></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.reserve' class="method"><span id='reserve.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#696-700' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Reserve capacity for <code>additional</code> more key-value pairs.</p>
|
||
<p>FIXME Not implemented fully yet.</p>
|
||
</div><h4 id='method.insert' class="method"><span id='insert.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#843-864' title='goto source code'>[src]</a></span></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 <code>index</code> of the corresponding key-value pair.</p>
|
||
</div><h4 id='method.entry' class="method"><span id='entry.v' class='invisible'><code>pub fn <a href='#method.entry' class='fnname'>entry</a>(&mut self, key: K) -> <a class="enum" href="../ordermap/enum.Entry.html" title="enum ordermap::Entry">Entry</a><K, V, S></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#870-873' title='goto source code'>[src]</a></span></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.iter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../ordermap/struct.Iter.html" title="struct ordermap::Iter">Iter</a><'a, K, V></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../ordermap/struct.Iter.html" title="struct ordermap::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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../ordermap/struct.Iter.html" title="struct ordermap::Iter">Iter</a><'a, K, V></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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></div></div><span id='iter.v' class='invisible'><code>pub fn <a href='#method.iter' class='fnname'>iter</a>(&self) -> <a class="struct" href="../ordermap/struct.Iter.html" title="struct ordermap::Iter">Iter</a><K, V></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#877-881' title='goto source code'>[src]</a></span></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"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../ordermap/struct.IterMut.html" title="struct ordermap::IterMut">IterMut</a><'a, K, V></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../ordermap/struct.IterMut.html" title="struct ordermap::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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../ordermap/struct.IterMut.html" title="struct ordermap::IterMut">IterMut</a><'a, K, V></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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></div></div><span id='iter_mut.v' class='invisible'><code>pub fn <a href='#method.iter_mut' class='fnname'>iter_mut</a>(&mut self) -> <a class="struct" href="../ordermap/struct.IterMut.html" title="struct ordermap::IterMut">IterMut</a><K, V></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#884-888' title='goto source code'>[src]</a></span></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"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../ordermap/struct.Keys.html" title="struct ordermap::Keys">Keys</a><'a, K, V></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../ordermap/struct.Keys.html" title="struct ordermap::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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../ordermap/struct.Keys.html" title="struct ordermap::Keys">Keys</a><'a, K, V></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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></div></div><span id='keys.v' class='invisible'><code>pub fn <a href='#method.keys' class='fnname'>keys</a>(&self) -> <a class="struct" href="../ordermap/struct.Keys.html" title="struct ordermap::Keys">Keys</a><K, V></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#891-895' title='goto source code'>[src]</a></span></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"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../ordermap/struct.Values.html" title="struct ordermap::Values">Values</a><'a, K, V></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../ordermap/struct.Values.html" title="struct ordermap::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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../ordermap/struct.Values.html" title="struct ordermap::Values">Values</a><'a, K, V></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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></div></div><span id='values.v' class='invisible'><code>pub fn <a href='#method.values' class='fnname'>values</a>(&self) -> <a class="struct" href="../ordermap/struct.Values.html" title="struct ordermap::Values">Values</a><K, V></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#898-902' title='goto source code'>[src]</a></span></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"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../ordermap/struct.ValuesMut.html" title="struct ordermap::ValuesMut">ValuesMut</a><'a, K, V></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../ordermap/struct.ValuesMut.html" title="struct ordermap::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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../ordermap/struct.ValuesMut.html" title="struct ordermap::ValuesMut">ValuesMut</a><'a, K, V></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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></div></div><span id='values_mut.v' class='invisible'><code>pub fn <a href='#method.values_mut' class='fnname'>values_mut</a>(&mut self) -> <a class="struct" href="../ordermap/struct.ValuesMut.html" title="struct ordermap::ValuesMut">ValuesMut</a><K, V></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#906-910' title='goto source code'>[src]</a></span></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.contains_key' class="method"><span id='contains_key.v' class='invisible'><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="../ordermap/trait.Equivalent.html" title="trait ordermap::Equivalent">Equivalent</a><K>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#915-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return <code>true</code> if and 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"><span id='get.v' class='invisible'><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="../ordermap/trait.Equivalent.html" title="trait ordermap::Equivalent">Equivalent</a><K>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#925-929' title='goto source code'>[src]</a></span></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_full' class="method"><span id='get_full.v' class='invisible'><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="../ordermap/trait.Equivalent.html" title="trait ordermap::Equivalent">Equivalent</a><K>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#932-941' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return item index, key and value</p>
|
||
</div><h4 id='method.get_mut' class="method"><span id='get_mut.v' class='invisible'><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="../ordermap/trait.Equivalent.html" title="trait ordermap::Equivalent">Equivalent</a><K>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#943-947' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.get_full_mut' class="method"><span id='get_full_mut.v' class='invisible'><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="../ordermap/trait.Equivalent.html" title="trait ordermap::Equivalent">Equivalent</a><K>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#949-954' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.remove' class="method"><span id='remove.v' class='invisible'><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="../ordermap/trait.Equivalent.html" title="trait ordermap::Equivalent">Equivalent</a><K>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#968-972' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>NOTE: Same as .swap_remove</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div><h4 id='method.swap_remove' class="method"><span id='swap_remove.v' class='invisible'><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="../ordermap/trait.Equivalent.html" title="trait ordermap::Equivalent">Equivalent</a><K>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#984-988' title='goto source code'>[src]</a></span></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 postion 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"><span id='swap_remove_full.v' class='invisible'><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="../ordermap/trait.Equivalent.html" title="trait ordermap::Equivalent">Equivalent</a><K>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#998-1007' title='goto source code'>[src]</a></span></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 postion of what used to be the last element!</strong></p>
|
||
<p>Return <code>None</code> if <code>key</code> is not in map.</p>
|
||
</div><h4 id='method.pop' class="method"><span id='pop.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1012-1014' title='goto source code'>[src]</a></span></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"><span id='retain.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1023-1027' title='goto source code'>[src]</a></span></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"><span id='sort_keys.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1068-1072' title='goto source code'>[src]</a></span></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"><span id='sort_by.v' class='invisible'><code>pub fn <a href='#method.sort_by' class='fnname'>sort_by</a><F>(&mut self, compare: 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1082-1105' title='goto source code'>[src]</a></span></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"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../ordermap/struct.IntoIter.html" title="struct ordermap::IntoIter">IntoIter</a><K, V></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../ordermap/struct.IntoIter.html" title="struct ordermap::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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../ordermap/struct.IntoIter.html" title="struct ordermap::IntoIter">IntoIter</a><K, V></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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></div></div><span id='sorted_by.v' class='invisible'><code>pub fn <a href='#method.sorted_by' class='fnname'>sorted_by</a><F>(self, cmp: F) -> <a class="struct" href="../ordermap/struct.IntoIter.html" title="struct ordermap::IntoIter">IntoIter</a><K, V> <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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1121-1126' title='goto source code'>[src]</a></span></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.drain' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../ordermap/struct.Drain.html" title="struct ordermap::Drain">Drain</a><'a, K, V></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../ordermap/struct.Drain.html" title="struct ordermap::Drain">Drain</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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../ordermap/struct.Drain.html" title="struct ordermap::Drain">Drain</a><'a, K, V></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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></div></div><span id='drain.v' class='invisible'><code>pub fn <a href='#method.drain' class='fnname'>drain</a>(&mut self, range: <a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.RangeFull.html" title="struct core::ops::range::RangeFull">RangeFull</a>) -> <a class="struct" href="../ordermap/struct.Drain.html" title="struct ordermap::Drain">Drain</a><K, V></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1130-1136' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Clears the <code>OrderMap</code>, returning all key-value pairs as a drain iterator.
|
||
Keeps the allocated memory for reuse.</p>
|
||
</div></div><h3 id='impl-3' class='impl'><span class='in-band'><code>impl<K, V, S> <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</a><K, V, S></code><a href='#impl-3' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1139-1172' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.get_index' class="method"><span id='get_index.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1145-1147' title='goto source code'>[src]</a></span></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"><span id='get_index_mut.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1154-1156' title='goto source code'>[src]</a></span></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.swap_remove_index' class="method"><span id='swap_remove_index.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1163-1171' title='goto source code'>[src]</a></span></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>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-MutableKeys' class='impl'><span class='in-band'><code>impl<K, V, S> <a class="trait" href="../ordermap/trait.MutableKeys.html" title="trait ordermap::MutableKeys">MutableKeys</a> for <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/mutable_keys.rs.html#49-76' title='goto source code'>[src]</a></span></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"><span id='Key.t' class='invisible'><code>type <a href='../ordermap/trait.MutableKeys.html#associatedtype.Key' class="type">Key</a> = K</code></span></h4>
|
||
<h4 id='associatedtype.Value' class="type"><span id='Value.t' class='invisible'><code>type <a href='../ordermap/trait.MutableKeys.html#associatedtype.Value' class="type">Value</a> = V</code></span></h4>
|
||
<h4 id='method.get_full_mut2' class="method"><span id='get_full_mut2.v' class='invisible'><code>fn <a href='../ordermap/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="../ordermap/trait.Equivalent.html" title="trait ordermap::Equivalent">Equivalent</a><K>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/mutable_keys.rs.html#55-65' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return item index, mutable reference to key and value</p>
|
||
</div><h4 id='method.retain2' class="method"><span id='retain2.v' class='invisible'><code>fn <a href='../ordermap/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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/mutable_keys.rs.html#67-71' title='goto source code'>[src]</a></span></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>. <a href="../ordermap/trait.MutableKeys.html#tymethod.retain2">Read more</a></p>
|
||
</div><h4 id='method.__private_marker' class="method"><span id='__private_marker.v' class='invisible'><code>fn <a href='../ordermap/trait.MutableKeys.html#tymethod.__private_marker' class='fnname'>__private_marker</a>(&self) -> PrivateMarker</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/mutable_keys.rs.html#73-75' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><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="../ordermap/trait.MutableKeys.html#tymethod.__private_marker">Read more</a></p>
|
||
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl<K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <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="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</a><K, V, S></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#291' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</a><K, V, S></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#291' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><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"><span id='clone_from.v' class='invisible'><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, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><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'><span class='in-band'><code>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="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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> + <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> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</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-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#328-358' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#333-357' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><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-IntoIterator' class='impl'><span class='in-band'><code>impl<'a, K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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-IntoIterator' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1489-1498' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/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></span></h4>
|
||
<div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
</div><h4 id='associatedtype.IntoIter' class="type"><span id='IntoIter.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../ordermap/struct.Iter.html" title="struct ordermap::Iter">Iter</a><'a, K, V></code></span></h4>
|
||
<div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
</div><h4 id='method.into_iter' class="method"><span id='into_iter.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/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/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::IntoIterator::IntoIter">IntoIter</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1495-1497' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
</div></div><h3 id='impl-IntoIterator-1' class='impl'><span class='in-band'><code>impl<'a, K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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-IntoIterator-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1500-1509' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Item-1' class="type"><span id='Item.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/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></span></h4>
|
||
<div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
</div><h4 id='associatedtype.IntoIter-1' class="type"><span id='IntoIter.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../ordermap/struct.IterMut.html" title="struct ordermap::IterMut">IterMut</a><'a, K, V></code></span></h4>
|
||
<div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
</div><h4 id='method.into_iter-1' class="method"><span id='into_iter.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/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/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::IntoIterator::IntoIter">IntoIter</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1506-1508' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
</div></div><h3 id='impl-IntoIterator-2' class='impl'><span class='in-band'><code>impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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-IntoIterator-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1511-1522' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Item-2' class="type"><span id='Item.t-2' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/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></span></h4>
|
||
<div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
</div><h4 id='associatedtype.IntoIter-2' class="type"><span id='IntoIter.t-2' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../ordermap/struct.IntoIter.html" title="struct ordermap::IntoIter">IntoIter</a><K, V></code></span></h4>
|
||
<div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
</div><h4 id='method.into_iter-2' class="method"><span id='into_iter.v-2' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/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/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::IntoIterator::IntoIter">IntoIter</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1517-1521' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
</div></div><h3 id='impl-Index%3C%26%27a%20Q%3E' class='impl'><span class='in-band'><code>impl<'a, 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 </a>Q> for <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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="../ordermap/trait.Equivalent.html" title="trait ordermap::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%27a%20Q%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1526-1541' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Output' class="type"><span id='Output.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output' class="type">Output</a> = V</code></span></h4>
|
||
<div class='docblock'><p>The returned type after indexing.</p>
|
||
</div><h4 id='method.index' class="method"><span id='index.v' class='invisible'><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 </a>Q) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1534-1540' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p><strong><em>Panics</em></strong> if <code>key</code> is not present in the map.</p>
|
||
</div></div><h3 id='impl-IndexMut%3C%26%27a%20Q%3E' class='impl'><span class='in-band'><code>impl<'a, 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 </a>Q> for <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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="../ordermap/trait.Equivalent.html" title="trait ordermap::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%27a%20Q%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1547-1560' title='goto source code'>[src]</a></span></h3>
|
||
<div class='docblock'><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>
|
||
</div><div class='impl-items'><h4 id='method.index_mut' class="method"><span id='index_mut.v' class='invisible'><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 </a>Q) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>V</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1553-1559' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p><strong><em>Panics</em></strong> if <code>key</code> is not present in the map.</p>
|
||
</div></div><h3 id='impl-FromIterator%3C(K%2C%20V)%3E' class='impl'><span class='in-band'><code>impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.FromIterator.html" title="trait core::iter::traits::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="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1562-1578' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.from_iter' class="method"><span id='from_iter.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/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/trait.IntoIterator.html" title="trait core::iter::traits::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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1571-1577' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Create an <code>OrderMap</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-Extend%3C(K%2C%20V)%3E' class='impl'><span class='in-band'><code>impl<K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html" title="trait core::iter::traits::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="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1580-1596' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.extend' class="method"><span id='extend.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html#tymethod.extend' class='fnname'>extend</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1593-1595' title='goto source code'>[src]</a></span></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 inserted in the order in the sequence. If
|
||
equivalents of a key occur more than once, the last corresponding value
|
||
prevails.</p>
|
||
</div></div><h3 id='impl-Extend%3C(%26%27a%20K%2C%20%26%27a%20V)%3E' class='impl'><span class='in-band'><code>impl<'a, K, V, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html" title="trait core::iter::traits::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="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1598-1609' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.extend-1' class="method"><span id='extend.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html#tymethod.extend' class='fnname'>extend</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1606-1608' title='goto source code'>[src]</a></span></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></div><h3 id='impl-Default' class='impl'><span class='in-band'><code>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="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</a><K, V, S> <span class="where fmt-newline">where<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-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1611-1618' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1615-1617' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return an empty <code>OrderMap</code></p>
|
||
</div></div><h3 id='impl-PartialEq%3COrderMap%3CK%2C%20V2%2C%20S2%3E%3E' class='impl'><span class='in-band'><code>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="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</a><K, V2, S2>> for <a class="struct" href="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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%3COrderMap%3CK%2C%20V2%2C%20S2%3E%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1620-1633' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><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="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</a><K, V2, S2>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1626-1632' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><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"><span id='ne.v' class='invisible'><code>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><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#121' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||
</div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><code>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="../ordermap/struct.OrderMap.html" title="struct ordermap::OrderMap">OrderMap</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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ordermap/lib.rs.html#1635-1640' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'></div></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt><kbd>?</kbd></dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt><kbd>S</kbd></dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt><kbd>↑</kbd></dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt><kbd>↓</kbd></dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt><kbd>↹</kbd></dt>
|
||
<dd>Switch tab</dd>
|
||
<dt><kbd>⏎</kbd></dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt><kbd>+</kbd></dt>
|
||
<dd>Expand all sections</dd>
|
||
<dt><kbd>-</kbd></dt>
|
||
<dd>Collapse all sections</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "ordermap";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |