<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A view into an occupied entry in a `HashMap`. It is part of the `Entry` enum."><title>OccupiedEntry in hashbrown::hash_map - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="rustdoc-vars"data-root-path="../../"data-static-root-path="../../static.files/"data-current-crate="hashbrown"data-themes=""data-resource-suffix=""data-rustdoc-version="1.77.2 (25ef9e3d8 2024-04-09)"data-channel="1.77.2"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../../hashbrown/index.html">hashbrown</a><spanclass="version">0.14.3</span></h2></div><h2class="location"><ahref="#">OccupiedEntry</a></h2><divclass="sidebar-elems"><section><h3><ahref="#implementations">Methods</a></h3><ulclass="block method"><li><ahref="#method.get">get</a></li><li><ahref="#method.get_mut">get_mut</a></li><li><ahref="#method.insert">insert</a></li><li><ahref="#method.into_mut">into_mut</a></li><li><ahref="#method.key">key</a></li><li><ahref="#method.remove">remove</a></li><li><ahref="#method.remove_entry">remove_entry</a></li><li><ahref="#method.replace_entry">replace_entry</a></li><li><ahref="#method.replace_entry_with">replace_entry_with</a></li><li><ahref="#method.replace_key">replace_key</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block trait-implementation"><li><ahref="#impl-Debug-for-OccupiedEntry%3C'_,+K,+V,+S,+A%3E">Debug</a></li><li><ahref="#impl-Send-for-OccupiedEntry%3C'_,+K,+V,+S,+A%3E">Send</a></li><li><ahref="#impl-Sync-for-OccupiedEntry%3C'_,+K,+V,+S,+A%3E">Sync</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block synthetic-implementation"><li><ahref="#impl-UnwindSafe-for-OccupiedEntry%3C'a,+K,+V,+S,+A%3E">!UnwindSafe</a></li><li><ahref="#impl-RefUnwindSafe-for-OccupiedEntry%3C'a,+K,+V,+S,+A%3E">RefUnwindSafe</a></li><li><ahref="#impl-Unpin-for-OccupiedEntry%3C'a,+K,+V,+S,+A%3E">Unpin</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></h3><ulclass="block blanket-implementation"><li><ahref="#impl-Any-for-T">Any</a></li><li><ahref="#impl-Borrow%3CT%3E-for-T">Borrow<T></a>
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../hashbrown/all.html"title="show sidebar"></a></div><inputclass="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"><divid="help-button"tabindex="-1"><ahref="../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Struct <ahref="../index.html">hashbrown</a>::<wbr><ahref="index.html">hash_map</a>::<wbr><aclass="struct"href="#">OccupiedEntry</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../src/hashbrown/map.rs.html#4250-4255">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct OccupiedEntry<'a, K, V, S = <aclass="enum"href="enum.DefaultHashBuilder.html"title="enum hashbrown::hash_map::DefaultHashBuilder">DefaultHashBuilder</a>, A: Allocator = Global> { <spanclass="comment">/* private fields */</span> }</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A view into an occupied entry in a <code>HashMap</code>.
It is part of the <ahref="enum.Entry.html"><code>Entry</code></a> enum.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.remove_entry"class="method"><aclass="src rightside"href="../../src/hashbrown/map.rs.html#5313-5315">source</a><h4class="code-header">pub fn <ahref="#method.remove_entry"class="fn">remove_entry</a>(self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/core/primitive.tuple.html">(K, V)</a></h4></section></summary><divclass="docblock"><p>Take the ownership of the key and value from the map.
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get"class="method"><aclass="src rightside"href="../../src/hashbrown/map.rs.html#5334-5336">source</a><h4class="code-header">pub fn <ahref="#method.get"class="fn">get</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/core/primitive.reference.html">&V</a></h4></section></summary><divclass="docblock"><p>Gets a reference to the value in the entry.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_mut"class="method"><aclass="src rightside"href="../../src/hashbrown/map.rs.html#5366-5368">source</a><h4class="code-header">pub fn <ahref="#method.get_mut"class="fn">get_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/core/primitive.reference.html">&mut V</a></h4></section></summary><divclass="docblock"><p>Gets a mutable reference to the value in the entry.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.into_mut"class="method"><aclass="src rightside"href="../../src/hashbrown/map.rs.html#5397-5399">source</a><h4class="code-header">pub fn <ahref="#method.into_mut"class="fn">into_mut</a>(self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/core/primitive.reference.html">&'a mut V</a></h4></section></summary><divclass="docblock"><p>Converts the OccupiedEntry into a mutable reference to the value in the entry
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.insert"class="method"><aclass="src rightside"href="../../src/hashbrown/map.rs.html#5419-5421">source</a><h4class="code-header">pub fn <ahref="#method.insert"class="fn">insert</a>(&mut self, value: V) -> V</h4></section></summary><divclass="docblock"><p>Sets the value of the entry, and returns the entry’s old value.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.remove"class="method"><aclass="src rightside"href="../../src/hashbrown/map.rs.html#5447-5449">source</a><h4class="code-header">pub fn <ahref="#method.remove"class="fn">remove</a>(self) -> V</h4></section></summary><divclass="docblock"><p>Takes the value out of the entry, and returns it.
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.replace_entry"class="method"><aclass="src rightside"href="../../src/hashbrown/map.rs.html#5483-5490">source</a><h4class="code-header">pub fn <ahref="#method.replace_entry"class="fn">replace_entry</a>(self, value: V) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/core/primitive.tuple.html">(K, V)</a></h4></section></summary><divclass="docblock"><p>Replaces the entry, returning the old key and value. The new key in the hash map will be
<p>Will panic if this OccupiedEntry was created through <ahref="enum.Entry.html#method.insert"title="method hashbrown::hash_map::Entry::insert"><code>Entry::insert</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.replace_key"class="method"><aclass="src rightside"href="../../src/hashbrown/map.rs.html#5537-5540">source</a><h4class="code-header">pub fn <ahref="#method.replace_key"class="fn">replace_key</a>(self) -> K</h4></section></summary><divclass="docblock"><p>Replaces the key in the hash map with the key used to create this entry.</p>
<p>Will panic if this OccupiedEntry was created through <ahref="enum.Entry.html#method.insert"title="method hashbrown::hash_map::Entry::insert"><code>Entry::insert</code></a>.</p>
F: <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/ops/function/trait.FnOnce.html"title="trait core::ops::function::FnOnce">FnOnce</a>(<aclass="primitive"href="https://doc.rust-lang.org/1.77.2/core/primitive.reference.html">&K</a>, V) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html"title="enum core::option::Option">Option</a><V>,</div></h4></section></summary><divclass="docblock"><p>Provides shared access to the key and owned access to the value of
<code><ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#804-806">source</a><ahref="#impl-TryFrom%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#811">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#789-791">source</a><ahref="#impl-TryInto%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/core/convert/mod.rs.html#796">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
