mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 23:14:34 +01:00
41 lines
13 KiB
HTML
41 lines
13 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."><title>MutableKeys in indexmap::map - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="indexmap" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../indexmap/index.html">indexmap</a><span class="version">1.9.3</span></h2></div><h2 class="location"><a href="#">Mutable<wbr>Keys</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Key">Key</a></li><li><a href="#associatedtype.Value">Value</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.__private_marker">__private_marker</a></li><li><a href="#tymethod.get_full_mut2">get_full_mut2</a></li><li><a href="#tymethod.retain2">retain2</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In indexmap::<wbr>map</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>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" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/indexmap/mutable_keys.rs.html#19-46">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait MutableKeys {
|
|||
|
|
type <a href="#associatedtype.Key" class="associatedtype">Key</a>;
|
|||
|
|
type <a href="#associatedtype.Value" class="associatedtype">Value</a>;
|
|||
|
|
|
|||
|
|
// Required methods
|
|||
|
|
fn <a href="#tymethod.get_full_mut2" class="fn">get_full_mut2</a><Q>(
|
|||
|
|
&mut self,
|
|||
|
|
key: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.reference.html">&Q</a>,
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="primitive" href="https://doc.rust-lang.org/1.82.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>)>
|
|||
|
|
<span class="where">where Q: <a class="trait" href="https://doc.rust-lang.org/1.82.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>> + ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.retain2" class="fn">retain2</a><F>(&mut self, keep: F)
|
|||
|
|
<span class="where">where F: <a class="trait" href="https://doc.rust-lang.org/1.82.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.82.0/std/primitive.bool.html">bool</a></span>;
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.__private_marker" class="fn">__private_marker</a>(&self) -> PrivateMarker;
|
|||
|
|
}</code></pre><details class="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="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Key" class="method"><a class="src rightside" href="../../src/indexmap/mutable_keys.rs.html#20">source</a><h4 class="code-header">type <a href="#associatedtype.Key" class="associatedtype">Key</a></h4></section><section id="associatedtype.Value" class="method"><a class="src rightside" href="../../src/indexmap/mutable_keys.rs.html#21">source</a><h4 class="code-header">type <a href="#associatedtype.Value" class="associatedtype">Value</a></h4></section></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.get_full_mut2" class="method"><a class="src rightside" href="../../src/indexmap/mutable_keys.rs.html#24-29">source</a><h4 class="code-header">fn <a href="#tymethod.get_full_mut2" class="fn">get_full_mut2</a><Q>(
|
|||
|
|
&mut self,
|
|||
|
|
key: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.reference.html">&Q</a>,
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="primitive" href="https://doc.rust-lang.org/1.82.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>)><div class="where">where
|
|||
|
|
Q: <a class="trait" href="https://doc.rust-lang.org/1.82.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>> + ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Return item index, mutable reference to key and value</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.retain2" class="method"><a class="src rightside" href="../../src/indexmap/mutable_keys.rs.html#38-40">source</a><h4 class="code-header">fn <a href="#tymethod.retain2" class="fn">retain2</a><F>(&mut self, keep: F)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.82.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.82.0/std/primitive.bool.html">bool</a>,</div></h4></section></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="toggle method-toggle" open><summary><section id="tymethod.__private_marker" class="method"><a class="src rightside" href="../../src/indexmap/mutable_keys.rs.html#45">source</a><h4 class="code-header">fn <a href="#tymethod.__private_marker" class="fn">__private_marker</a>(&self) -> PrivateMarker</h4></section></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="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.82.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-MutableKeys-for-IndexMap%3CK,+V,+S%3E" class="impl"><a class="src rightside" href="../../src/indexmap/mutable_keys.rs.html#51-75">source</a><a href="#impl-MutableKeys-for-IndexMap%3CK,+V,+S%3E" class="anchor">§</a><h3 class="code-header">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><div class="where">where
|
|||
|
|
K: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,
|
|||
|
|
S: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section></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"><section id="associatedtype.Key-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/indexmap/mutable_keys.rs.html#56">source</a><a href="#associatedtype.Key-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Key" class="associatedtype">Key</a> = K</h4></section><section id="associatedtype.Value-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/indexmap/mutable_keys.rs.html#57">source</a><a href="#associatedtype.Value-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Value" class="associatedtype">Value</a> = V</h4></section></div></details></div><script src="../../trait.impl/indexmap/mutable_keys/trait.MutableKeys.js" async></script></section></div></main></body></html>
|