mentat/linked_hash_map/struct.OccupiedEntry.html
2018-08-22 17:04:13 +00:00

154 lines
No EOL
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="API documentation for the Rust `OccupiedEntry` struct in crate `linked_hash_map`.">
<meta name="keywords" content="rust, rustlang, rust-lang, OccupiedEntry">
<title>linked_hash_map::OccupiedEntry - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../dark.css">
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
<script src="../storage.js"></script>
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Struct OccupiedEntry</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.key">key</a><a href="#method.get">get</a><a href="#method.get_mut">get_mut</a><a href="#method.into_mut">into_mut</a><a href="#method.insert">insert</a><a href="#method.remove">remove</a></div></div><p class='location'><a href='index.html'>linked_hash_map</a></p><script>window.sidebarCurrent = {name: 'OccupiedEntry', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>linked_hash_map</a>::<wbr><a class="struct" href=''>OccupiedEntry</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/linked_hash_map/lib.rs.html#1160-1164' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct OccupiedEntry&lt;'a, K:&nbsp;'a, V:&nbsp;'a, S:&nbsp;'a&nbsp;=&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.RandomState.html" title="struct std::collections::hash::map::RandomState">RandomState</a>&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A view into a single occupied location in a <code>LinkedHashMap</code>.</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;'a, K:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>, V, S:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>&gt; <a class="struct" href="../linked_hash_map/struct.OccupiedEntry.html" title="struct linked_hash_map::OccupiedEntry">OccupiedEntry</a>&lt;'a, K, V, S&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/linked_hash_map/lib.rs.html#1210-1263' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.key' class="method"><span id='key.v' class='invisible'><code>pub fn <a href='#method.key' class='fnname'>key</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>K</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/linked_hash_map/lib.rs.html#1223-1225' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Gets a reference to the entry key</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">linked_hash_map</span>::<span class="ident">LinkedHashMap</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">LinkedHashMap</span>::<span class="ident">new</span>();
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">&quot;foo&quot;</span>.<span class="ident">to_string</span>(), <span class="number">1</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">&quot;foo&quot;</span>, <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">&quot;foo&quot;</span>.<span class="ident">to_string</span>()).<span class="ident">key</span>());</pre>
</div><h4 id='method.get' class="method"><span id='get.v' class='invisible'><code>pub fn <a href='#method.get' class='fnname'>get</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>V</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/linked_hash_map/lib.rs.html#1228-1230' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Gets a reference to the value in the entry.</p>
</div><h4 id='method.get_mut' class="method"><span id='get_mut.v' class='invisible'><code>pub fn <a href='#method.get_mut' class='fnname'>get_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>V</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/linked_hash_map/lib.rs.html#1233-1235' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Gets a mutable reference to the value in the entry.</p>
</div><h4 id='method.into_mut' class="method"><span id='into_mut.v' class='invisible'><code>pub fn <a href='#method.into_mut' class='fnname'>into_mut</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>V</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/linked_hash_map/lib.rs.html#1239-1241' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Converts the OccupiedEntry into a mutable reference to the value in the entry
with a lifetime bound to the map itself</p>
</div><h4 id='method.insert' class="method"><span id='insert.v' class='invisible'><code>pub fn <a href='#method.insert' class='fnname'>insert</a>(&amp;mut self, value: V) -&gt; V</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/linked_hash_map/lib.rs.html#1244-1257' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Sets the value of the entry, and returns the entry's old value</p>
</div><h4 id='method.remove' class="method"><span id='remove.v' class='invisible'><code>pub fn <a href='#method.remove' class='fnname'>remove</a>(self) -&gt; V</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/linked_hash_map/lib.rs.html#1260-1262' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Takes the value out of the entry, and returns it</p>
</div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "linked_hash_map";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>