30 lines
15 KiB
HTML
30 lines
15 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="Opt-in mutable access to keys."><meta name="keywords" content="rust, rustlang, rust-lang, MutableKeys"><title>MutableKeys in indexmap::map - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../indexmap/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Trait MutableKeys</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#associated-types">Associated Types</a></h3><div class="sidebar-links"><a href="#associatedtype.Key">Key</a><a href="#associatedtype.Value">Value</a></div><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.__private_marker">__private_marker</a><a href="#tymethod.get_full_mut2">get_full_mut2</a><a href="#tymethod.retain2">retain2</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../index.html">indexmap</a>::<wbr><a href="index.html">map</a></h2><div id="sidebar-vars" data-name="MutableKeys" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../indexmap/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">indexmap</a>::<wbr><a href="index.html">map</a>::<wbr><a class="trait" href="#">MutableKeys</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#19-46" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait MutableKeys {
|
||
type <a href="#associatedtype.Key" class="associatedtype">Key</a>;
|
||
type <a href="#associatedtype.Value" class="associatedtype">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/1.59.0/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/1.59.0/std/primitive.reference.html">&</a>Q<br> ) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>, &mut Self::<a class="associatedtype" href="trait.MutableKeys.html#associatedtype.Key" title="type indexmap::map::MutableKeys::Key">Key</a>, &mut Self::<a class="associatedtype" href="trait.MutableKeys.html#associatedtype.Value" title="type indexmap::map::MutableKeys::Value">Value</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.tuple.html">)</a>><br> <span class="where">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><Self::<a class="associatedtype" href="trait.MutableKeys.html#associatedtype.Key" title="type indexmap::map::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/1.59.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut Self::<a class="associatedtype" href="trait.MutableKeys.html#associatedtype.Key" title="type indexmap::map::MutableKeys::Key">Key</a>, &mut Self::<a class="associatedtype" href="trait.MutableKeys.html#associatedtype.Value" title="type indexmap::map::MutableKeys::Value">Value</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/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;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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 modification
|
||
does not change the key’s hash and equality</strong>.</p>
|
||
<p>If keys are modified erroneously, 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>IndexMap</code>.</p>
|
||
</div></details><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><div id="associatedtype.Key" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#20" title="goto source code">[src]</a></div><h4 class="code-header">type <a href="#associatedtype.Key" class="associatedtype">Key</a></h4></div><div id="associatedtype.Value" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#21" title="goto source code">[src]</a></div><h4 class="code-header">type <a href="#associatedtype.Value" class="associatedtype">Value</a></h4></div></div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.get_full_mut2" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#24-29" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.get_full_mut2" class="fnname">get_full_mut2</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/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/1.59.0/std/primitive.reference.html">&</a>Q<br>) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>, &mut Self::<a class="associatedtype" href="trait.MutableKeys.html#associatedtype.Key" title="type indexmap::map::MutableKeys::Key">Key</a>, &mut Self::<a class="associatedtype" href="trait.MutableKeys.html#associatedtype.Value" title="type indexmap::map::MutableKeys::Value">Value</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a><Self::<a class="associatedtype" href="trait.MutableKeys.html#associatedtype.Key" title="type indexmap::map::MutableKeys::Key">Key</a>>, </span></h4></div></summary><div class="docblock"><p>Return item index, mutable reference to key and value</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.retain2" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#38-40" title="goto source code">[src]</a></div><h4 class="code-header">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/1.59.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut Self::<a class="associatedtype" href="trait.MutableKeys.html#associatedtype.Key" title="type indexmap::map::MutableKeys::Key">Key</a>, &mut Self::<a class="associatedtype" href="trait.MutableKeys.html#associatedtype.Value" title="type indexmap::map::MutableKeys::Value">Value</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.bool.html">bool</a>, </span></h4></div></summary><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></details><details class="rustdoc-toggle" open><summary><div id="tymethod.__private_marker" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#45" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.__private_marker" class="fnname">__private_marker</a>(&self) -> PrivateMarker</h4></div></summary><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></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-MutableKeys" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/indexmap/mutable_keys.rs.html#51-75" title="goto source code">[src]</a></div><a href="#impl-MutableKeys" class="anchor"></a><h3 class="code-header in-band">impl<K, V, S> <a class="trait" href="trait.MutableKeys.html" title="trait indexmap::map::MutableKeys">MutableKeys</a> for <a class="struct" href="struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a><K, V, S> <span class="where fmt-newline">where<br> K: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>, </span></h3></div></summary><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"><div id="associatedtype.Key-1" class="type trait-impl has-srclink"><a href="#associatedtype.Key-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Key" class="associatedtype">Key</a> = K</h4></div><div id="associatedtype.Value-1" class="type trait-impl has-srclink"><a href="#associatedtype.Value-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Value" class="associatedtype">Value</a> = V</h4></div></div></details></div><script type="text/javascript" src="../../implementors/indexmap/map/trait.MutableKeys.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="indexmap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |