mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 15:04:32 +01:00
79 lines
No EOL
41 KiB
HTML
79 lines
No EOL
41 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="A view into an occupied entry in an `IndexMap`. It is part of the `Entry` enum."><title>OccupiedEntry 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 struct"><!--[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="#">Occupied<wbr>Entry</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.get">get</a></li><li><a href="#method.get_mut">get_mut</a></li><li><a href="#method.index">index</a></li><li><a href="#method.insert">insert</a></li><li><a href="#method.into_mut">into_mut</a></li><li><a href="#method.key">key</a></li><li><a href="#method.move_index">move_index</a></li><li><a href="#method.remove">remove</a></li><li><a href="#method.remove_entry">remove_entry</a></li><li><a href="#method.shift_remove">shift_remove</a></li><li><a href="#method.shift_remove_entry">shift_remove_entry</a></li><li><a href="#method.swap_indices">swap_indices</a></li><li><a href="#method.swap_remove">swap_remove</a></li><li><a href="#method.swap_remove_entry">swap_remove_entry</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-OccupiedEntry%3C'_,+K,+V%3E">Debug</a></li><li><a href="#impl-From%3CIndexedEntry%3C'a,+K,+V%3E%3E-for-OccupiedEntry%3C'a,+K,+V%3E">From<IndexedEntry<'a, K, V>></a></li><li><a href="#impl-From%3COccupiedEntry%3C'a,+K,+V%3E%3E-for-IndexedEntry%3C'a,+K,+V%3E">From<OccupiedEntry<'a, K, V>></a></li><li><a href="#impl-MutableEntryKey-for-OccupiedEntry%3C'_,+K,+V%3E">MutableEntryKey</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-UnwindSafe-for-OccupiedEntry%3C'a,+K,+V%3E">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-OccupiedEntry%3C'a,+K,+V%3E">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-OccupiedEntry%3C'a,+K,+V%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-OccupiedEntry%3C'a,+K,+V%3E">Send</a></li><li><a href="#impl-Sync-for-OccupiedEntry%3C'a,+K,+V%3E">Sync</a></li><li><a href="#impl-Unpin-for-OccupiedEntry%3C'a,+K,+V%3E">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li></ul></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>Struct <a href="../index.html">indexmap</a>::<wbr><a href="index.html">map</a>::<wbr><a class="struct" href="#">OccupiedEntry</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/core/entry.rs.html#133-136">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct OccupiedEntry<'a, K, V> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A view into an occupied entry in an <a href="struct.IndexMap.html" title="struct indexmap::map::IndexMap"><code>IndexMap</code></a>.
|
||
It is part of the <a href="enum.Entry.html" title="enum indexmap::map::Entry"><code>Entry</code></a> enum.</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-OccupiedEntry%3C'a,+K,+V%3E" class="impl"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#138-289">source</a><a href="#impl-OccupiedEntry%3C'a,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V> <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.index" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#141-143">source</a><h4 class="code-header">pub fn <a href="#method.index" class="fn">index</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Return the index of the key-value pair</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.key" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#155-157">source</a><h4 class="code-header">pub fn <a href="#method.key" class="fn">key</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.reference.html">&K</a></h4></section></summary><div class="docblock"><p>Gets a reference to the entry’s key in the map.</p>
|
||
<p>Note that this is not the key that was used to find the entry. There may be an observable
|
||
difference if the key type has any distinguishing features outside of <code>Hash</code> and <code>Eq</code>, like
|
||
extra fields or the memory address of an allocation.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#165-167">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.reference.html">&V</a></h4></section></summary><div class="docblock"><p>Gets a reference to the entry’s value in the map.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#173-176">source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fn">get_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.reference.html">&mut V</a></h4></section></summary><div class="docblock"><p>Gets a mutable reference to the entry’s value in the map.</p>
|
||
<p>If you need a reference which may outlive the destruction of the
|
||
<a href="enum.Entry.html" title="enum indexmap::map::Entry"><code>Entry</code></a> value, see <a href="struct.OccupiedEntry.html#method.into_mut" title="method indexmap::map::OccupiedEntry::into_mut"><code>into_mut</code></a>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_mut" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#180-183">source</a><h4 class="code-header">pub fn <a href="#method.into_mut" class="fn">into_mut</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.reference.html">&'a mut V</a></h4></section></summary><div class="docblock"><p>Converts into a mutable reference to the entry’s value in the map,
|
||
with a lifetime bound to the map itself.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#186-188">source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>(&mut self, value: V) -> V</h4></section></summary><div class="docblock"><p>Sets the value of the entry to <code>value</code>, and returns the entry’s old value.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#198-200">source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a>(self) -> V</h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated: <code>remove</code> disrupts the map order – use <code>swap_remove</code> or <code>shift_remove</code> for explicit behavior.</span></div></span></summary><div class="docblock"><p>Remove the key, value pair stored in the map for this entry, and return the value.</p>
|
||
<p><strong>NOTE:</strong> This is equivalent to <a href="struct.OccupiedEntry.html#method.swap_remove" title="method indexmap::map::OccupiedEntry::swap_remove"><code>.swap_remove()</code></a>, replacing this
|
||
entry’s position with the last element, and it is deprecated in favor of calling that
|
||
explicitly. If you need to preserve the relative order of the keys in the map, use
|
||
<a href="struct.OccupiedEntry.html#method.shift_remove" title="method indexmap::map::OccupiedEntry::shift_remove"><code>.shift_remove()</code></a> instead.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.swap_remove" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#209-211">source</a><h4 class="code-header">pub fn <a href="#method.swap_remove" class="fn">swap_remove</a>(self) -> V</h4></section></summary><div class="docblock"><p>Remove the key, value pair stored in the map for this entry, and return the value.</p>
|
||
<p>Like <a href="https://doc.rust-lang.org/1.82.0/alloc/vec/struct.Vec.html#method.swap_remove" title="method alloc::vec::Vec::swap_remove"><code>Vec::swap_remove</code></a>, the pair is removed by swapping it with
|
||
the last element of the map and popping it off.
|
||
<strong>This perturbs the position of what used to be the last element!</strong></p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.shift_remove" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#220-222">source</a><h4 class="code-header">pub fn <a href="#method.shift_remove" class="fn">shift_remove</a>(self) -> V</h4></section></summary><div class="docblock"><p>Remove the key, value pair stored in the map for this entry, and return the value.</p>
|
||
<p>Like <a href="https://doc.rust-lang.org/1.82.0/alloc/vec/struct.Vec.html#method.remove" title="method alloc::vec::Vec::remove"><code>Vec::remove</code></a>, the pair is removed by shifting all of the
|
||
elements that follow it, preserving their relative order.
|
||
<strong>This perturbs the index of all of those elements!</strong></p>
|
||
<p>Computes in <strong>O(n)</strong> time (average).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove_entry" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#232-234">source</a><h4 class="code-header">pub fn <a href="#method.remove_entry" class="fn">remove_entry</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.tuple.html">(K, V)</a></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated: <code>remove_entry</code> disrupts the map order – use <code>swap_remove_entry</code> or <code>shift_remove_entry</code> for explicit behavior.</span></div></span></summary><div class="docblock"><p>Remove and return the key, value pair stored in the map for this entry</p>
|
||
<p><strong>NOTE:</strong> This is equivalent to <a href="struct.OccupiedEntry.html#method.swap_remove_entry" title="method indexmap::map::OccupiedEntry::swap_remove_entry"><code>.swap_remove_entry()</code></a>,
|
||
replacing this entry’s position with the last element, and it is deprecated in favor of
|
||
calling that explicitly. If you need to preserve the relative order of the keys in the map,
|
||
use <a href="struct.OccupiedEntry.html#method.shift_remove_entry" title="method indexmap::map::OccupiedEntry::shift_remove_entry"><code>.shift_remove_entry()</code></a> instead.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.swap_remove_entry" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#243-246">source</a><h4 class="code-header">pub fn <a href="#method.swap_remove_entry" class="fn">swap_remove_entry</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.tuple.html">(K, V)</a></h4></section></summary><div class="docblock"><p>Remove and return the key, value pair stored in the map for this entry</p>
|
||
<p>Like <a href="https://doc.rust-lang.org/1.82.0/alloc/vec/struct.Vec.html#method.swap_remove" title="method alloc::vec::Vec::swap_remove"><code>Vec::swap_remove</code></a>, the pair is removed by swapping it with
|
||
the last element of the map and popping it off.
|
||
<strong>This perturbs the position of what used to be the last element!</strong></p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.shift_remove_entry" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#255-258">source</a><h4 class="code-header">pub fn <a href="#method.shift_remove_entry" class="fn">shift_remove_entry</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.tuple.html">(K, V)</a></h4></section></summary><div class="docblock"><p>Remove and return the key, value pair stored in the map for this entry</p>
|
||
<p>Like <a href="https://doc.rust-lang.org/1.82.0/alloc/vec/struct.Vec.html#method.remove" title="method alloc::vec::Vec::remove"><code>Vec::remove</code></a>, the pair is removed by shifting all of the
|
||
elements that follow it, preserving their relative order.
|
||
<strong>This perturbs the index of all of those elements!</strong></p>
|
||
<p>Computes in <strong>O(n)</strong> time (average).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.move_index" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#272-275">source</a><h4 class="code-header">pub fn <a href="#method.move_index" class="fn">move_index</a>(self, to: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Moves the position of the entry to a new index
|
||
by shifting all other entries in-between.</p>
|
||
<p>This is equivalent to <a href="struct.IndexMap.html#method.move_index" title="method indexmap::map::IndexMap::move_index"><code>IndexMap::move_index</code></a>
|
||
coming <code>from</code> the current <a href="struct.OccupiedEntry.html#method.index" title="method indexmap::map::OccupiedEntry::index"><code>.index()</code></a>.</p>
|
||
<ul>
|
||
<li>If <code>self.index() < to</code>, the other pairs will shift down while the targeted pair moves up.</li>
|
||
<li>If <code>self.index() > to</code>, the other pairs will shift up while the targeted pair moves down.</li>
|
||
</ul>
|
||
<p><em><strong>Panics</strong></em> if <code>to</code> is out of bounds.</p>
|
||
<p>Computes in <strong>O(n)</strong> time (average).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.swap_indices" class="method"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#285-288">source</a><h4 class="code-header">pub fn <a href="#method.swap_indices" class="fn">swap_indices</a>(self, other: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Swaps the position of entry with another.</p>
|
||
<p>This is equivalent to <a href="struct.IndexMap.html#method.swap_indices" title="method indexmap::map::IndexMap::swap_indices"><code>IndexMap::swap_indices</code></a>
|
||
with the current <a href="struct.OccupiedEntry.html#method.index" title="method indexmap::map::OccupiedEntry::index"><code>.index()</code></a> as one of the two being swapped.</p>
|
||
<p><em><strong>Panics</strong></em> if the <code>other</code> index is out of bounds.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-OccupiedEntry%3C'_,+K,+V%3E" class="impl"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#291-298">source</a><a href="#impl-Debug-for-OccupiedEntry%3C'_,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, V: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'_, K, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#292-297">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.82.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.82.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CIndexedEntry%3C'a,+K,+V%3E%3E-for-OccupiedEntry%3C'a,+K,+V%3E" class="impl"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#300-314">source</a><a href="#impl-From%3CIndexedEntry%3C'a,+K,+V%3E%3E-for-OccupiedEntry%3C'a,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="struct.IndexedEntry.html" title="struct indexmap::map::IndexedEntry">IndexedEntry</a><'a, K, V>> for <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#301-313">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(other: <a class="struct" href="struct.IndexedEntry.html" title="struct indexmap::map::IndexedEntry">IndexedEntry</a><'a, K, V>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3COccupiedEntry%3C'a,+K,+V%3E%3E-for-IndexedEntry%3C'a,+K,+V%3E" class="impl"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#528-535">source</a><a href="#impl-From%3COccupiedEntry%3C'a,+K,+V%3E%3E-for-IndexedEntry%3C'a,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V>> for <a class="struct" href="struct.IndexedEntry.html" title="struct indexmap::map::IndexedEntry">IndexedEntry</a><'a, K, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="../../src/indexmap/map/core/entry.rs.html#529-534">source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(other: <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><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" class="associatedtype trait-impl"><a class="src rightside" href="../../src/indexmap/map/mutable.rs.html#132">source</a><a href="#associatedtype.Key" class="anchor">§</a><h4 class="code-header">type <a href="trait.MutableEntryKey.html#associatedtype.Key" class="associatedtype">Key</a> = K</h4></section><details class="toggle method-toggle" open><summary><section id="method.key_mut" class="method trait-impl"><a class="src rightside" href="../../src/indexmap/map/mutable.rs.html#133-135">source</a><a href="#method.key_mut" class="anchor">§</a><h4 class="code-header">fn <a href="trait.MutableEntryKey.html#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'>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.</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-OccupiedEntry%3C'a,+K,+V%3E" class="impl"><a href="#impl-Freeze-for-OccupiedEntry%3C'a,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V></h3></section><section id="impl-RefUnwindSafe-for-OccupiedEntry%3C'a,+K,+V%3E" class="impl"><a href="#impl-RefUnwindSafe-for-OccupiedEntry%3C'a,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-OccupiedEntry%3C'a,+K,+V%3E" class="impl"><a href="#impl-Send-for-OccupiedEntry%3C'a,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-OccupiedEntry%3C'a,+K,+V%3E" class="impl"><a href="#impl-Sync-for-OccupiedEntry%3C'a,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
|
||
V: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-OccupiedEntry%3C'a,+K,+V%3E" class="impl"><a href="#impl-Unpin-for-OccupiedEntry%3C'a,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V></h3></section><section id="impl-UnwindSafe-for-OccupiedEntry%3C'a,+K,+V%3E" class="impl"><a href="#impl-UnwindSafe-for-OccupiedEntry%3C'a,+K,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V> !<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/any.rs.html#138">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<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></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/any.rs.html#139">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.82.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.82.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/borrow.rs.html#209">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<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></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/borrow.rs.html#211">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/borrow.rs.html#217">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<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></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/borrow.rs.html#218">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#809">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#794">source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |