169 lines
14 KiB
HTML
169 lines
14 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 `MutableKeys` trait in crate `ordermap`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, MutableKeys">
|
|||
|
|
|
|||
|
|
<title>ordermap::MutableKeys - 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 trait">
|
|||
|
|
<!--[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'>Trait MutableKeys</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Key">Key</a><a href="#associatedtype.Value">Value</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.get_full_mut2">get_full_mut2</a><a href="#tymethod.retain2">retain2</a><a href="#tymethod.__private_marker">__private_marker</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>ordermap</a></p><script>window.sidebarCurrent = {name: 'MutableKeys', ty: 'trait', 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'>Trait <a href='index.html'>ordermap</a>::<wbr><a class="trait" href=''>MutableKeys</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/mutable_keys.rs.html#21-44' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait MutableKeys {
|
|||
|
|
type <a href='#associatedtype.Key' class="type">Key</a>;
|
|||
|
|
type <a href='#associatedtype.Value' class="type">Value</a>;
|
|||
|
|
fn <a href='#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>, &mut Self::<a class="type" href="../ordermap/trait.MutableKeys.html#associatedtype.Key" title="type ordermap::MutableKeys::Key">Key</a>, &mut Self::<a class="type" href="../ordermap/trait.MutableKeys.html#associatedtype.Value" title="type ordermap::MutableKeys::Value">Value</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>><br> <span class="where">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><Self::<a class="type" href="../ordermap/trait.MutableKeys.html#associatedtype.Key" title="type ordermap::MutableKeys::Key">Key</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.retain2' class='fnname'>retain2</a><F>(&mut self, keep: F)<br> <span class="where">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>(&mut Self::<a class="type" href="../ordermap/trait.MutableKeys.html#associatedtype.Key" title="type ordermap::MutableKeys::Key">Key</a>, &mut Self::<a class="type" href="../ordermap/trait.MutableKeys.html#associatedtype.Value" title="type ordermap::MutableKeys::Value">Value</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.__private_marker' class='fnname'>__private_marker</a>(&self) -> PrivateMarker;
|
|||
|
|
}</pre><div class='docblock'><p>Opt-in mutable access to keys.</p>
|
|||
|
|
<p>These methods expose <code>&mut K</code>, mutable references to the key as it is stored
|
|||
|
|
in the map.
|
|||
|
|
You are allowed to modify the keys in the hashmap <strong>if the modifcation
|
|||
|
|
does not change the key’s hash and equality</strong>.</p>
|
|||
|
|
<p>If keys are modified erronously, you can no longer look them up.
|
|||
|
|
This is sound (memory safe) but a logical error hazard (just like
|
|||
|
|
implementing PartialEq, Eq, or Hash incorrectly would be).</p>
|
|||
|
|
<p><code>use</code> this trait to enable its methods for <code>OrderMap</code>.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='associated-types' class='small-section-header'>
|
|||
|
|
Associated Types<a href='#associated-types' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='associatedtype.Key' class='method'><span id='Key.t' class='invisible'><code>type <a href='#associatedtype.Key' class="type">Key</a></code></span></h3><h3 id='associatedtype.Value' class='method'><span id='Value.t' class='invisible'><code>type <a href='#associatedtype.Value' class="type">Value</a></code></span></h3></div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.get_full_mut2' class='method'><span id='get_full_mut2.v' class='invisible'><code>fn <a href='#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>, &mut Self::<a class="type" href="../ordermap/trait.MutableKeys.html#associatedtype.Key" title="type ordermap::MutableKeys::Key">Key</a>, &mut Self::<a class="type" href="../ordermap/trait.MutableKeys.html#associatedtype.Value" title="type ordermap::MutableKeys::Value">Value</a><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><Self::<a class="type" href="../ordermap/trait.MutableKeys.html#associatedtype.Key" title="type ordermap::MutableKeys::Key">Key</a>>, </span></code></span></h3><div class='docblock'><p>Return item index, mutable reference to key and value</p>
|
|||
|
|
</div><h3 id='tymethod.retain2' class='method'><span id='retain2.v' class='invisible'><code>fn <a href='#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>(&mut Self::<a class="type" href="../ordermap/trait.MutableKeys.html#associatedtype.Key" title="type ordermap::MutableKeys::Key">Key</a>, &mut Self::<a class="type" href="../ordermap/trait.MutableKeys.html#associatedtype.Value" title="type ordermap::MutableKeys::Value">Value</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, </span></code></span></h3><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><h3 id='tymethod.__private_marker' class='method'><span id='__private_marker.v' class='invisible'><code>fn <a href='#tymethod.__private_marker' class='fnname'>__private_marker</a>(&self) -> PrivateMarker</code></span></h3><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.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../src/ordermap/mutable_keys.rs.html#49-76' title='goto source code'>[src]</a></div><code>impl<K, V, S> MutableKeys 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><span class="where fmt-newline"> type <a href='#associatedtype.Key' class="type">Key</a> = K;</span><span class="where fmt-newline"> type <a href='#associatedtype.Value' class="type">Value</a> = V;</span></code></li>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../implementors/ordermap/trait.MutableKeys.js">
|
|||
|
|
</script></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>
|