| <!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="Entry for an existing key-value pair or a vacant location to insert one."><meta name="keywords" content="rust, rustlang, rust-lang, Entry"><title>Entry in indexmap::map - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc enum"><!--[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="sidebar-logo" href="../../indexmap/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../indexmap/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Entry</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block"><li><a href="#variant.Occupied">Occupied</a></li><li><a href="#variant.Vacant">Vacant</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.and_modify">and_modify</a></li><li><a href="#method.index">index</a></li><li><a href="#method.key">key</a></li><li><a href="#method.or_default">or_default</a></li><li><a href="#method.or_insert">or_insert</a></li><li><a href="#method.or_insert_with">or_insert_with</a></li><li><a href="#method.or_insert_with_key">or_insert_with_key</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-Entry%3C%27_%2C%20K%2C%20V%3E">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Entry%3C%27a%2C%20K%2C%20V%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Entry%3C%27a%2C%20K%2C%20V%3E">Send</a></li><li><a href="#impl-Sync-for-Entry%3C%27a%2C%20K%2C%20V%3E">Sync</a></li><li><a href="#impl-Unpin-for-Entry%3C%27a%2C%20K%2C%20V%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Entry%3C%27a%2C%20K%2C%20V%3E">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Entry%3C%27a%2C%20K%2C%20V%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In indexmap::map</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" 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="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Enum <a href="../index.html">indexmap</a>::<wbr><a href="index.html">map</a>::<wbr><a class="enum" href="#">Entry</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/indexmap/map/core.rs.html#492-497">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust enum"><code>pub enum Entry<'a, K, V> { |
| Occupied(<a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V>), |
| Vacant(<a class="struct" href="struct.VacantEntry.html" title="struct indexmap::map::VacantEntry">VacantEntry</a><'a, K, V>), |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Entry for an existing key-value pair or a vacant location to |
| insert one.</p> |
| </div></details><h2 id="variants" class="variants small-section-header">Variants<a href="#variants" class="anchor"></a></h2><h3 id="variant.Occupied" class="variant small-section-header"><a href="#variant.Occupied" class="anchor field"></a><code>Occupied(<a class="struct" href="struct.OccupiedEntry.html" title="struct indexmap::map::OccupiedEntry">OccupiedEntry</a><'a, K, V>)</code></h3><div class="docblock"><p>Existing slot with equivalent key.</p> |
| </div><h3 id="variant.Vacant" class="variant small-section-header"><a href="#variant.Vacant" class="anchor field"></a><code>Vacant(<a class="struct" href="struct.VacantEntry.html" title="struct indexmap::map::VacantEntry">VacantEntry</a><'a, K, V>)</code></h3><div class="docblock"><p>Vacant slot (no equivalent key in the map).</p> |
| </div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/indexmap/map/core.rs.html#499-587">source</a><a href="#impl-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<'a, K, V> <a class="enum" href="enum.Entry.html" title="enum indexmap::map::Entry">Entry</a><'a, K, V></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.or_insert" class="method has-srclink"><a class="srclink rightside" href="../../src/indexmap/map/core.rs.html#504-509">source</a><h4 class="code-header">pub fn <a href="#method.or_insert" class="fnname">or_insert</a>(self, default: V) -> &'a mut V</h4></section></summary><div class="docblock"><p>Inserts the given default value in the entry if it is vacant and returns a mutable |
| reference to it. Otherwise a mutable reference to an already existent value is returned.</p> |
| <p>Computes in <strong>O(1)</strong> time (amortized average).</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.or_insert_with" class="method has-srclink"><a class="srclink rightside" href="../../src/indexmap/map/core.rs.html#515-523">source</a><h4 class="code-header">pub fn <a href="#method.or_insert_with" class="fnname">or_insert_with</a><F>(self, call: F) -> &'a mut V<span class="where fmt-newline">where<br> F: FnOnce() -> V,</span></h4></section></summary><div class="docblock"><p>Inserts the result of the <code>call</code> function in the entry if it is vacant and returns a mutable |
| reference to it. Otherwise a mutable reference to an already existent value is returned.</p> |
| <p>Computes in <strong>O(1)</strong> time (amortized average).</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.or_insert_with_key" class="method has-srclink"><a class="srclink rightside" href="../../src/indexmap/map/core.rs.html#530-541">source</a><h4 class="code-header">pub fn <a href="#method.or_insert_with_key" class="fnname">or_insert_with_key</a><F>(self, call: F) -> &'a mut V<span class="where fmt-newline">where<br> F: FnOnce(&K) -> V,</span></h4></section></summary><div class="docblock"><p>Inserts the result of the <code>call</code> function with a reference to the entry’s key if it is |
| vacant, and returns a mutable reference to the new value. Otherwise a mutable reference to |
| an already existent value is returned.</p> |
| <p>Computes in <strong>O(1)</strong> time (amortized average).</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.key" class="method has-srclink"><a class="srclink rightside" href="../../src/indexmap/map/core.rs.html#545-550">source</a><h4 class="code-header">pub fn <a href="#method.key" class="fnname">key</a>(&self) -> &K</h4></section></summary><div class="docblock"><p>Gets a 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><details class="rustdoc-toggle method-toggle" open><summary><section id="method.index" class="method has-srclink"><a class="srclink rightside" href="../../src/indexmap/map/core.rs.html#553-558">source</a><h4 class="code-header">pub fn <a href="#method.index" class="fnname">index</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Return the index where the key-value pair exists or will be inserted.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.and_modify" class="method has-srclink"><a class="srclink rightside" href="../../src/indexmap/map/core.rs.html#561-572">source</a><h4 class="code-header">pub fn <a href="#method.and_modify" class="fnname">and_modify</a><F>(self, f: F) -> Self<span class="where fmt-newline">where<br> F: FnOnce(&mut V),</span></h4></section></summary><div class="docblock"><p>Modifies the entry if it is occupied.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.or_default" class="method has-srclink"><a class="srclink rightside" href="../../src/indexmap/map/core.rs.html#578-586">source</a><h4 class="code-header">pub fn <a href="#method.or_default" class="fnname">or_default</a>(self) -> &'a mut V<span class="where fmt-newline">where<br> V: Default,</span></h4></section></summary><div class="docblock"><p>Inserts a default-constructed value in the entry if it is vacant and returns a mutable |
| reference to it. Otherwise a mutable reference to an already existent value is returned.</p> |
| <p>Computes in <strong>O(1)</strong> time (amortized average).</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Entry%3C%27_%2C%20K%2C%20V%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/indexmap/map/core.rs.html#589-596">source</a><a href="#impl-Debug-for-Entry%3C%27_%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<K: Debug, V: Debug> Debug for <a class="enum" href="enum.Entry.html" title="enum indexmap::map::Entry">Entry</a><'_, K, V></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/indexmap/map/core.rs.html#590-595">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></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-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<'a, K, V> RefUnwindSafe for <a class="enum" href="enum.Entry.html" title="enum indexmap::map::Entry">Entry</a><'a, K, V><span class="where fmt-newline">where<br> K: RefUnwindSafe,<br> V: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-Send-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<'a, K, V> Send for <a class="enum" href="enum.Entry.html" title="enum indexmap::map::Entry">Entry</a><'a, K, V><span class="where fmt-newline">where<br> K: Send,<br> V: Send,</span></h3></section><section id="impl-Sync-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-Sync-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<'a, K, V> Sync for <a class="enum" href="enum.Entry.html" title="enum indexmap::map::Entry">Entry</a><'a, K, V><span class="where fmt-newline">where<br> K: Sync,<br> V: Sync,</span></h3></section><section id="impl-Unpin-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<'a, K, V> Unpin for <a class="enum" href="enum.Entry.html" title="enum indexmap::map::Entry">Entry</a><'a, K, V><span class="where fmt-newline">where<br> K: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<'a, K, V> !UnwindSafe for <a class="enum" href="enum.Entry.html" title="enum indexmap::map::Entry">Entry</a><'a, K, V></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="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-Any-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><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="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Entry%3C%27a%2C%20K%2C%20V%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><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="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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><div id="rustdoc-vars" data-root-path="../../" data-current-crate="indexmap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
