mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-02 00:14:33 +01:00
26 lines
No EOL
11 KiB
HTML
26 lines
No EOL
11 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 `Entry` keys."><title>MutableEntryKey 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">2.6.0</span></h2></div><h2 class="location"><a href="#">Mutable<wbr>Entry<wbr>Key</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></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.key_mut">key_mut</a></li></ul><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="#">MutableEntryKey</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/map/mutable.rs.html#107-113">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait MutableEntryKey: Sealed {
|
||
type <a href="#associatedtype.Key" class="associatedtype">Key</a>;
|
||
|
||
// Required method
|
||
fn <a href="#tymethod.key_mut" class="fn">key_mut</a>(&mut self) -> &mut Self::<a class="associatedtype" href="trait.MutableEntryKey.html#associatedtype.Key" title="type indexmap::map::MutableEntryKey::Key">Key</a>;
|
||
}</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 <a href="enum.Entry.html" title="enum indexmap::map::Entry"><code>Entry</code></a> 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 map <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 <code>PartialEq</code>, <code>Eq</code>, or <code>Hash</code> incorrectly would be).</p>
|
||
<p><code>use</code> this trait to enable its methods for <code>Entry</code>.</p>
|
||
<p>This trait is sealed and cannot be implemented for types outside this crate.</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/map/mutable.rs.html#108">source</a><h4 class="code-header">type <a href="#associatedtype.Key" class="associatedtype">Key</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.key_mut" class="method"><a class="src rightside" href="../../src/indexmap/map/mutable.rs.html#112">source</a><h4 class="code-header">fn <a href="#tymethod.key_mut" class="fn">key_mut</a>(&mut self) -> &mut Self::<a class="associatedtype" href="trait.MutableEntryKey.html#associatedtype.Key" title="type indexmap::map::MutableEntryKey::Key">Key</a></h4></section></summary><div class="docblock"><p>Gets a mutable reference to the entry’s key, either within the map if occupied,
|
||
or else the new key that was used to find the entry.</p>
|
||
</div></details></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-MutableEntryKey-for-Entry%3C'_,+K,+V%3E" class="impl"><a class="src rightside" href="../../src/indexmap/map/mutable.rs.html#118-126">source</a><a href="#impl-MutableEntryKey-for-Entry%3C'_,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="trait.MutableEntryKey.html" title="trait indexmap::map::MutableEntryKey">MutableEntryKey</a> for <a class="enum" href="enum.Entry.html" title="enum indexmap::map::Entry">Entry</a><'_, K, V></h3></section></summary><div class="docblock"><p>Opt-in mutable access to <a href="enum.Entry.html" title="enum indexmap::map::Entry"><code>Entry</code></a> keys.</p>
|
||
<p>See <a href="trait.MutableEntryKey.html" title="trait indexmap::map::MutableEntryKey"><code>MutableEntryKey</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/map/mutable.rs.html#119">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></div></details><details class="toggle implementors-toggle"><summary><section id="impl-MutableEntryKey-for-IndexedEntry%3C'_,+K,+V%3E" class="impl"><a class="src rightside" href="../../src/indexmap/map/mutable.rs.html#151-156">source</a><a href="#impl-MutableEntryKey-for-IndexedEntry%3C'_,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="trait.MutableEntryKey.html" title="trait indexmap::map::MutableEntryKey">MutableEntryKey</a> for <a class="struct" href="struct.IndexedEntry.html" title="struct indexmap::map::IndexedEntry">IndexedEntry</a><'_, K, V></h3></section></summary><div class="docblock"><p>Opt-in mutable access to <a href="struct.IndexedEntry.html" title="struct indexmap::map::IndexedEntry"><code>IndexedEntry</code></a> keys.</p>
|
||
<p>See <a href="trait.MutableEntryKey.html" title="trait indexmap::map::MutableEntryKey"><code>MutableEntryKey</code></a> for more information.</p>
|
||
</div><div class="impl-items"><section id="associatedtype.Key-2" class="associatedtype trait-impl"><a class="src rightside" href="../../src/indexmap/map/mutable.rs.html#152">source</a><a href="#associatedtype.Key-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Key" class="associatedtype">Key</a> = K</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-MutableEntryKey-for-OccupiedEntry%3C'_,+K,+V%3E" class="impl"><a class="src rightside" href="../../src/indexmap/map/mutable.rs.html#131-136">source</a><a href="#impl-MutableEntryKey-for-OccupiedEntry%3C'_,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="trait.MutableEntryKey.html" title="trait indexmap::map::MutableEntryKey">MutableEntryKey</a> for <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'_, K, V></h3></section></summary><div class="docblock"><p>Opt-in mutable access to <a href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry"><code>OccupiedEntry</code></a> keys.</p>
|
||
<p>See <a href="trait.MutableEntryKey.html" title="trait indexmap::map::MutableEntryKey"><code>MutableEntryKey</code></a> for more information.</p>
|
||
</div><div class="impl-items"><section id="associatedtype.Key-3" class="associatedtype trait-impl"><a class="src rightside" href="../../src/indexmap/map/mutable.rs.html#132">source</a><a href="#associatedtype.Key-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Key" class="associatedtype">Key</a> = K</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-MutableEntryKey-for-VacantEntry%3C'_,+K,+V%3E" class="impl"><a class="src rightside" href="../../src/indexmap/map/mutable.rs.html#141-146">source</a><a href="#impl-MutableEntryKey-for-VacantEntry%3C'_,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="trait.MutableEntryKey.html" title="trait indexmap::map::MutableEntryKey">MutableEntryKey</a> for <a class="struct" href="struct.VacantEntry.html" title="struct indexmap::map::VacantEntry">VacantEntry</a><'_, K, V></h3></section></summary><div class="docblock"><p>Opt-in mutable access to <a href="struct.VacantEntry.html" title="struct indexmap::map::VacantEntry"><code>VacantEntry</code></a> keys.</p>
|
||
<p>See <a href="trait.MutableEntryKey.html" title="trait indexmap::map::MutableEntryKey"><code>MutableEntryKey</code></a> for more information.</p>
|
||
</div><div class="impl-items"><section id="associatedtype.Key-4" class="associatedtype trait-impl"><a class="src rightside" href="../../src/indexmap/map/mutable.rs.html#142">source</a><a href="#associatedtype.Key-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Key" class="associatedtype">Key</a> = K</h4></section></div></details></div><script src="../../trait.impl/indexmap/map/mutable/trait.MutableEntryKey.js" async></script></section></div></main></body></html> |