27 lines
No EOL
18 KiB
HTML
27 lines
No EOL
18 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="An occupied entry which can be manipulated"><title>OccupiedEntry in heapless - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="heapless" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0-nightly (2bbb61989 2023-10-04)" data-channel="nightly" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">☰</button><a class="logo-container" href="../heapless/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../heapless/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">OccupiedEntry</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.get">get</a></li><li><a href="#method.get_mut">get_mut</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.remove">remove</a></li><li><a href="#method.remove_entry">remove_entry</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-UnwindSafe-for-OccupiedEntry%3C'a,+K,+V,+N%3E">!UnwindSafe</a></li><li><a href="#impl-RefUnwindSafe-for-OccupiedEntry%3C'a,+K,+V,+N%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-OccupiedEntry%3C'a,+K,+V,+N%3E">Send</a></li><li><a href="#impl-Sync-for-OccupiedEntry%3C'a,+K,+V,+N%3E">Sync</a></li><li><a href="#impl-Unpin-for-OccupiedEntry%3C'a,+K,+V,+N%3E">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-OccupiedEntry%3C'a,+K,+V,+N%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In heapless</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="index.html">heapless</a>::<wbr><a class="struct" href="#">OccupiedEntry</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/heapless/indexmap.rs.html#328-333">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, const N: usize> { /* private fields */ }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An occupied entry which can be manipulated</p>
|
||
</div></details><h2 id="implementations" class="small-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,+N%3E" class="impl"><a class="src rightside" href="../src/heapless/indexmap.rs.html#335-386">source</a><a href="#impl-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, const N: usize> <a class="struct" href="struct.OccupiedEntry.html" title="struct heapless::OccupiedEntry">OccupiedEntry</a><'a, K, V, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.key" class="method"><a class="src rightside" href="../src/heapless/indexmap.rs.html#340-342">source</a><h4 class="code-header">pub fn <a href="#method.key" class="fn">key</a>(&self) -> &K</h4></section></summary><div class="docblock"><p>Gets a reference to the key that this entity corresponds to</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove_entry" class="method"><a class="src rightside" href="../src/heapless/indexmap.rs.html#345-347">source</a><h4 class="code-header">pub fn <a href="#method.remove_entry" class="fn">remove_entry</a>(self) -> (K, V)</h4></section></summary><div class="docblock"><p>Removes this entry from the map and yields its corresponding key and value</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../src/heapless/indexmap.rs.html#350-354">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>(&self) -> &V</h4></section></summary><div class="docblock"><p>Gets a reference to the value associated with this entry</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><a class="src rightside" href="../src/heapless/indexmap.rs.html#357-361">source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fn">get_mut</a>(&mut self) -> &mut V</h4></section></summary><div class="docblock"><p>Gets a mutable reference to the value associated with this entry</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_mut" class="method"><a class="src rightside" href="../src/heapless/indexmap.rs.html#364-368">source</a><h4 class="code-header">pub fn <a href="#method.into_mut" class="fn">into_mut</a>(self) -> &'a mut V</h4></section></summary><div class="docblock"><p>Consumes this entry and yields a reference to the underlying value</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert" class="method"><a class="src rightside" href="../src/heapless/indexmap.rs.html#371-380">source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>(self, value: V) -> V</h4></section></summary><div class="docblock"><p>Overwrites the underlying map’s value with this entry’s value</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove" class="method"><a class="src rightside" href="../src/heapless/indexmap.rs.html#383-385">source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a>(self) -> V</h4></section></summary><div class="docblock"><p>Removes this entry from the map and yields its value</p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-RefUnwindSafe-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, const N: usize> RefUnwindSafe for <a class="struct" href="struct.OccupiedEntry.html" title="struct heapless::OccupiedEntry">OccupiedEntry</a><'a, K, V, N><span class="where fmt-newline">where
|
||
K: RefUnwindSafe,
|
||
V: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-Send-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, const N: usize> Send for <a class="struct" href="struct.OccupiedEntry.html" title="struct heapless::OccupiedEntry">OccupiedEntry</a><'a, K, V, N><span class="where fmt-newline">where
|
||
K: Send,
|
||
V: Send,</span></h3></section><section id="impl-Sync-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-Sync-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, const N: usize> Sync for <a class="struct" href="struct.OccupiedEntry.html" title="struct heapless::OccupiedEntry">OccupiedEntry</a><'a, K, V, N><span class="where fmt-newline">where
|
||
K: Sync,
|
||
V: Sync,</span></h3></section><section id="impl-Unpin-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-Unpin-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, const N: usize> Unpin for <a class="struct" href="struct.OccupiedEntry.html" title="struct heapless::OccupiedEntry">OccupiedEntry</a><'a, K, V, N><span class="where fmt-newline">where
|
||
K: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-UnwindSafe-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, const N: usize> !UnwindSafe for <a class="struct" href="struct.OccupiedEntry.html" title="struct heapless::OccupiedEntry">OccupiedEntry</a><'a, K, V, N></h3></section></div><h2 id="blanket-implementations" class="small-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-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-Any-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where
|
||
T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a class="fn">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-Borrow%3CT%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where
|
||
T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a class="fn">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-BorrowMut%3CT%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where
|
||
T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a class="fn">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-From%3CT%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a 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-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-Into%3CU%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where
|
||
U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a 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>[From]<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-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-TryFrom%3CU%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where
|
||
U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</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 href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></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-OccupiedEntry%3C'a,+K,+V,+N%3E" class="impl"><a href="#impl-TryInto%3CU%3E-for-OccupiedEntry%3C'a,+K,+V,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where
|
||
U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</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 href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |