148 lines
9.5 KiB
HTML
148 lines
9.5 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="API documentation for the Rust `Entry` struct in crate `slab`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Entry">
|
|||
|
|
|
|||
|
|
<title>slab::Entry - 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">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct Entry</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.replace">replace</a><a href="#method.replace_with">replace_with</a><a href="#method.remove">remove</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.index">index</a></div></div><p class='location'><a href='index.html'>slab</a></p><script>window.sidebarCurrent = {name: 'Entry', 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'>slab</a>::<wbr><a class="struct" href=''>Entry</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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../src/slab/lib.rs.html#22-25' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct Entry<'a, T: 'a, I: 'a> { /* fields omitted */ }</pre><div class='docblock'><p>A handle to an occupied slot in the <code>Slab</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<'a, T, I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>> <a class="struct" href="../slab/struct.Entry.html" title="struct slab::Entry">Entry</a><'a, T, I></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#323-389' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.replace' class="method"><span id='replace.v' class='invisible'><code>pub fn <a href='#method.replace' class='fnname'>replace</a>(&mut self, val: T) -> T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#326-331' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Replace the value stored in the entry</p>
|
|||
|
|
</div><h4 id='method.replace_with' class="method"><span id='replace_with.v' class='invisible'><code>pub fn <a href='#method.replace_with' class='fnname'>replace_with</a><F>(&mut self, f: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(T) -> T, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#335-347' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Apply the function to the current value, replacing it with the result
|
|||
|
|
of the function.</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) -> T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#350-359' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Remove and return the value stored in the entry</p>
|
|||
|
|
</div><h4 id='method.get' class="method"><span id='get.v' class='invisible'><code>pub fn <a href='#method.get' class='fnname'>get</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#362-367' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Get a reference to the value stored 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>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#370-375' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Get a mutable reference to the value stored 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) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#378-383' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Convert the entry handle to a mutable reference</p>
|
|||
|
|
</div><h4 id='method.index' class="method"><span id='index.v' class='invisible'><code>pub fn <a href='#method.index' class='fnname'>index</a>(&self) -> I</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#386-388' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Return the entry index</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>⏎</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 = "slab";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|