mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-22 16:08:24 +00:00
216 lines
44 KiB
HTML
216 lines
44 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="A sharded slab."><title>Slab in sharded_slab - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="sharded_slab" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../sharded_slab/index.html">sharded_slab</a><span class="version">0.1.7</span></h2></div><h2 class="location"><a href="#">Slab</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Associated Constants</a></h3><ul class="block associatedconstant"><li><a href="#associatedconstant.USED_BITS">USED_BITS</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.contains">contains</a></li><li><a href="#method.get">get</a></li><li><a href="#method.get_owned">get_owned</a></li><li><a href="#method.insert">insert</a></li><li><a href="#method.new">new</a></li><li><a href="#method.new_with_config">new_with_config</a></li><li><a href="#method.remove">remove</a></li><li><a href="#method.take">take</a></li><li><a href="#method.unique_iter">unique_iter</a></li><li><a href="#method.vacant_entry">vacant_entry</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Slab%3CT,+C%3E">Debug</a></li><li><a href="#impl-Default-for-Slab%3CT%3E">Default</a></li><li><a href="#impl-Send-for-Slab%3CT,+C%3E">Send</a></li><li><a href="#impl-Sync-for-Slab%3CT,+C%3E">Sync</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Slab%3CT,+C%3E">!Freeze</a></li><li><a href="#impl-UnwindSafe-for-Slab%3CT,+C%3E">!UnwindSafe</a></li><li><a href="#impl-RefUnwindSafe-for-Slab%3CT,+C%3E">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-Slab%3CT,+C%3E">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li></ul></section><h2><a href="index.html">In crate sharded_slab</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="index.html">sharded_slab</a>::<wbr><a class="struct" href="#">Slab</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/sharded_slab/lib.rs.html#235-238">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Slab<T, C: <a class="trait" href="trait.Config.html" title="trait sharded_slab::Config">Config</a> = <a class="struct" href="struct.DefaultConfig.html" title="struct sharded_slab::DefaultConfig">DefaultConfig</a>> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A sharded slab.</p>
|
||
<p>See the <a href="index.html" title="mod sharded_slab">crate-level documentation</a> for details on using this type.</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Slab%3CT%3E" class="impl"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#375-389">source</a><a href="#impl-Slab%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#377-379">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Returns a new slab with the default configuration parameters.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.new_with_config" class="method"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#382-388">source</a><h4 class="code-header">pub fn <a href="#method.new_with_config" class="fn">new_with_config</a><C: <a class="trait" href="trait.Config.html" title="trait sharded_slab::Config">Config</a>>() -> <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T, C></h4></section></summary><div class="docblock"><p>Returns a new slab with the provided configuration parameters.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Slab%3CT,+C%3E" class="impl"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#391-763">source</a><a href="#impl-Slab%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C: <a class="trait" href="trait.Config.html" title="trait sharded_slab::Config">Config</a>> <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T, C></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedconstant.USED_BITS" class="associatedconstant"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#403">source</a><h4 class="code-header">pub const <a href="#associatedconstant.USED_BITS" class="constant">USED_BITS</a>: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a> = C::USED_BITS</h4></section></summary><div class="docblock"><p>The number of bits in each index which are used by the slab.</p>
|
||
<p>If other data is packed into the <code>usize</code> indices returned by
|
||
<a href="struct.Slab.html#method.insert" title="method sharded_slab::Slab::insert"><code>Slab::insert</code></a>, user code is free to use any bits higher than the
|
||
<code>USED_BITS</code>-th bit freely.</p>
|
||
<p>This is determined by the <a href="trait.Config.html" title="trait sharded_slab::Config"><code>Config</code></a> type that configures the slab’s
|
||
parameters. By default, all bits are used; this can be changed by
|
||
overriding the <a href="trait.Config.html#RESERVED_BITS" title="trait sharded_slab::Config"><code>Config::RESERVED_BITS</code></a> constant.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert" class="method"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#420-430">source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>(&self, value: T) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>></h4></section></summary><div class="docblock"><p>Inserts a value into the slab, returning the integer index at which that
|
||
value was inserted. This index can then be used to access the entry.</p>
|
||
<p>If this function returns <code>None</code>, then the shard for the current thread
|
||
is full and no items can be added until some are removed, or the maximum
|
||
number of shards has been reached.</p>
|
||
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slab = Slab::new();
|
||
|
||
<span class="kw">let </span>key = slab.insert(<span class="string">"hello world"</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(slab.get(key).unwrap(), <span class="string">"hello world"</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.vacant_entry" class="method"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#455-467">source</a><h4 class="code-header">pub fn <a href="#method.vacant_entry" class="fn">vacant_entry</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.VacantEntry.html" title="struct sharded_slab::VacantEntry">VacantEntry</a><'_, T, C>></h4></section></summary><div class="docblock"><p>Return a handle to a vacant entry allowing for further manipulation.</p>
|
||
<p>This function is useful when creating values that must contain their
|
||
slab index. The returned <a href="struct.VacantEntry.html" title="struct sharded_slab::VacantEntry"><code>VacantEntry</code></a> reserves a slot in the slab and
|
||
is able to return the index of the entry.</p>
|
||
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>slab = Slab::new();
|
||
|
||
<span class="kw">let </span>hello = {
|
||
<span class="kw">let </span>entry = slab.vacant_entry().unwrap();
|
||
<span class="kw">let </span>key = entry.key();
|
||
|
||
entry.insert((key, <span class="string">"hello"</span>));
|
||
key
|
||
};
|
||
|
||
<span class="macro">assert_eq!</span>(hello, slab.get(hello).unwrap().<span class="number">0</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"hello"</span>, slab.get(hello).unwrap().<span class="number">1</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove" class="method"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#512-525">source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a>(&self, idx: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Remove the value at the given index in the slab, returning <code>true</code> if a
|
||
value was removed.</p>
|
||
<p>Unlike <a href="struct.Slab.html#method.take" title="method sharded_slab::Slab::take"><code>take</code></a>, this method does <em>not</em> block the current thread until
|
||
the value can be removed. Instead, if another thread is currently
|
||
accessing that value, this marks it to be removed by that thread when it
|
||
finishes accessing the value.</p>
|
||
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slab = sharded_slab::Slab::new();
|
||
<span class="kw">let </span>key = slab.insert(<span class="string">"hello world"</span>).unwrap();
|
||
|
||
<span class="comment">// Remove the item from the slab.
|
||
</span><span class="macro">assert!</span>(slab.remove(key));
|
||
|
||
<span class="comment">// Now, the slot is empty.
|
||
</span><span class="macro">assert!</span>(!slab.contains(key));</code></pre></div>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::sync::Arc;
|
||
|
||
<span class="kw">let </span>slab = Arc::new(sharded_slab::Slab::new());
|
||
<span class="kw">let </span>key = slab.insert(<span class="string">"hello world"</span>).unwrap();
|
||
|
||
<span class="kw">let </span>slab2 = slab.clone();
|
||
<span class="kw">let </span>thread2 = std::thread::spawn(<span class="kw">move </span>|| {
|
||
<span class="comment">// Depending on when this thread begins executing, the item may
|
||
// or may not have already been removed...
|
||
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(item) = slab2.get(key) {
|
||
<span class="macro">assert_eq!</span>(item, <span class="string">"hello world"</span>);
|
||
}
|
||
});
|
||
|
||
<span class="comment">// The item will be removed by thread2 when it finishes accessing it.
|
||
</span><span class="macro">assert!</span>(slab.remove(key));
|
||
|
||
thread2.join().unwrap();
|
||
<span class="macro">assert!</span>(!slab.contains(key));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.take" class="method"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#581-591">source</a><h4 class="code-header">pub fn <a href="#method.take" class="fn">take</a>(&self, idx: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4></section></summary><div class="docblock"><p>Removes the value associated with the given key from the slab, returning
|
||
it.</p>
|
||
<p>If the slab does not contain a value for that key, <code>None</code> is returned
|
||
instead.</p>
|
||
<p>If the value associated with the given key is currently being
|
||
accessed by another thread, this method will block the current thread
|
||
until the item is no longer accessed. If this is not desired, use
|
||
<a href="struct.Slab.html#method.remove" title="method sharded_slab::Slab::remove"><code>remove</code></a> instead.</p>
|
||
<p><strong>Note</strong>: This method blocks the calling thread by spinning until the
|
||
currently outstanding references are released. Spinning for long periods
|
||
of time can result in high CPU time and power consumption. Therefore,
|
||
<code>take</code> should only be called when other references to the slot are
|
||
expected to be dropped soon (e.g., when all accesses are relatively
|
||
short).</p>
|
||
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slab = sharded_slab::Slab::new();
|
||
<span class="kw">let </span>key = slab.insert(<span class="string">"hello world"</span>).unwrap();
|
||
|
||
<span class="comment">// Remove the item from the slab, returning it.
|
||
</span><span class="macro">assert_eq!</span>(slab.take(key), <span class="prelude-val">Some</span>(<span class="string">"hello world"</span>));
|
||
|
||
<span class="comment">// Now, the slot is empty.
|
||
</span><span class="macro">assert!</span>(!slab.contains(key));</code></pre></div>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::sync::Arc;
|
||
|
||
<span class="kw">let </span>slab = Arc::new(sharded_slab::Slab::new());
|
||
<span class="kw">let </span>key = slab.insert(<span class="string">"hello world"</span>).unwrap();
|
||
|
||
<span class="kw">let </span>slab2 = slab.clone();
|
||
<span class="kw">let </span>thread2 = std::thread::spawn(<span class="kw">move </span>|| {
|
||
<span class="comment">// Depending on when this thread begins executing, the item may
|
||
// or may not have already been removed...
|
||
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(item) = slab2.get(key) {
|
||
<span class="macro">assert_eq!</span>(item, <span class="string">"hello world"</span>);
|
||
}
|
||
});
|
||
|
||
<span class="comment">// The item will only be removed when the other thread finishes
|
||
// accessing it.
|
||
</span><span class="macro">assert_eq!</span>(slab.take(key), <span class="prelude-val">Some</span>(<span class="string">"hello world"</span>));
|
||
|
||
thread2.join().unwrap();
|
||
<span class="macro">assert!</span>(!slab.contains(key));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#608-623">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Entry.html" title="struct sharded_slab::Entry">Entry</a><'_, T, C>></h4></section></summary><div class="docblock"><p>Return a reference to the value associated with the given key.</p>
|
||
<p>If the slab does not contain a value for the given key, or if the
|
||
maximum number of concurrent references to the slot has been reached,
|
||
<code>None</code> is returned instead.</p>
|
||
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slab = sharded_slab::Slab::new();
|
||
<span class="kw">let </span>key = slab.insert(<span class="string">"hello world"</span>).unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(slab.get(key).unwrap(), <span class="string">"hello world"</span>);
|
||
<span class="macro">assert!</span>(slab.get(<span class="number">12345</span>).is_none());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_owned" class="method"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#706-721">source</a><h4 class="code-header">pub fn <a href="#method.get_owned" class="fn">get_owned</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>, key: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.OwnedEntry.html" title="struct sharded_slab::OwnedEntry">OwnedEntry</a><T, C>></h4></section></summary><div class="docblock"><p>Return an owned reference to the value at the given index.</p>
|
||
<p>If the slab does not contain a value for the given key, <code>None</code> is
|
||
returned instead.</p>
|
||
<p>Unlike <a href="struct.Slab.html#method.get" title="method sharded_slab::Slab::get"><code>get</code></a>, which borrows the slab, this method <em>clones</em> the <a href="https://doc.rust-lang.org/1.80.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc"><code>Arc</code></a>
|
||
around the slab. This means that the returned <a href="struct.OwnedEntry.html" title="struct sharded_slab::OwnedEntry"><code>OwnedEntry</code></a> can be held
|
||
for an arbitrary lifetime. However, this method requires that the slab
|
||
itself be wrapped in an <code>Arc</code>.</p>
|
||
<h5 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::sync::Arc;
|
||
|
||
<span class="kw">let </span>slab: Arc<Slab<<span class="kw-2">&</span><span class="lifetime">'static </span>str>> = Arc::new(Slab::new());
|
||
<span class="kw">let </span>key = slab.insert(<span class="string">"hello world"</span>).unwrap();
|
||
|
||
<span class="comment">// Look up the created key, returning an `OwnedEntry`.
|
||
</span><span class="kw">let </span>value = slab.clone().get_owned(key).unwrap();
|
||
|
||
<span class="comment">// Now, the original `Arc` clone of the slab may be dropped, but the
|
||
// returned `OwnedEntry` can still access the value.
|
||
</span><span class="macro">assert_eq!</span>(value, <span class="string">"hello world"</span>);</code></pre></div>
|
||
<p>Unlike <a href="struct.Entry.html" title="struct sharded_slab::Entry"><code>Entry</code></a>, an <code>OwnedEntry</code> may be stored in a struct which must live
|
||
for the <code>'static</code> lifetime:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>sharded_slab::OwnedEntry;
|
||
<span class="kw">use </span>std::sync::Arc;
|
||
|
||
<span class="kw">pub struct </span>MyStruct {
|
||
entry: OwnedEntry<<span class="kw-2">&</span><span class="lifetime">'static </span>str>,
|
||
<span class="comment">// ... other fields ...
|
||
</span>}
|
||
|
||
<span class="comment">// Suppose this is some arbitrary function which requires a value that
|
||
// lives for the 'static lifetime...
|
||
</span><span class="kw">fn </span>function_requiring_static<T: <span class="lifetime">'static</span>>(t: <span class="kw-2">&</span>T) {
|
||
<span class="comment">// ... do something extremely important and interesting ...
|
||
</span>}
|
||
|
||
<span class="kw">let </span>slab: Arc<Slab<<span class="kw-2">&</span><span class="lifetime">'static </span>str>> = Arc::new(Slab::new());
|
||
<span class="kw">let </span>key = slab.insert(<span class="string">"hello world"</span>).unwrap();
|
||
|
||
<span class="comment">// Look up the created key, returning an `OwnedEntry`.
|
||
</span><span class="kw">let </span>entry = slab.clone().get_owned(key).unwrap();
|
||
<span class="kw">let </span>my_struct = MyStruct {
|
||
entry,
|
||
<span class="comment">// ...
|
||
</span>};
|
||
|
||
<span class="comment">// We can use `my_struct` anywhere where it is required to have the
|
||
// `'static` lifetime:
|
||
</span>function_requiring_static(<span class="kw-2">&</span>my_struct);</code></pre></div>
|
||
<p><a href="struct.OwnedEntry.html" title="struct sharded_slab::OwnedEntry"><code>OwnedEntry</code></a>s may be sent between threads:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::{thread, sync::Arc};
|
||
|
||
<span class="kw">let </span>slab: Arc<Slab<<span class="kw-2">&</span><span class="lifetime">'static </span>str>> = Arc::new(Slab::new());
|
||
<span class="kw">let </span>key = slab.insert(<span class="string">"hello world"</span>).unwrap();
|
||
|
||
<span class="comment">// Look up the created key, returning an `OwnedEntry`.
|
||
</span><span class="kw">let </span>value = slab.clone().get_owned(key).unwrap();
|
||
|
||
thread::spawn(<span class="kw">move </span>|| {
|
||
<span class="macro">assert_eq!</span>(value, <span class="string">"hello world"</span>);
|
||
<span class="comment">// ...
|
||
</span>}).join().unwrap();</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.contains" class="method"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#736-738">source</a><h4 class="code-header">pub fn <a href="#method.contains" class="fn">contains</a>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the slab contains a value for the given key.</p>
|
||
<h5 id="examples-6"><a class="doc-anchor" href="#examples-6">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slab = sharded_slab::Slab::new();
|
||
|
||
<span class="kw">let </span>key = slab.insert(<span class="string">"hello world"</span>).unwrap();
|
||
<span class="macro">assert!</span>(slab.contains(key));
|
||
|
||
slab.take(key).unwrap();
|
||
<span class="macro">assert!</span>(!slab.contains(key));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.unique_iter" class="method"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#745-762">source</a><h4 class="code-header">pub fn <a href="#method.unique_iter" class="fn">unique_iter</a>(&mut self) -> <a class="struct" href="struct.UniqueIter.html" title="struct sharded_slab::UniqueIter">UniqueIter</a><'_, T, C> <a href="#" class="tooltip" data-notable-ty="UniqueIter<'_, T, C>">ⓘ</a></h4></section></summary><div class="docblock"><p>Returns an iterator over all the items in the slab.</p>
|
||
<p>Because this iterator exclusively borrows the slab (i.e. it holds an
|
||
<code>&mut Slab<T></code>), elements will not be added or removed while the
|
||
iteration is in progress.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Slab%3CT,+C%3E" class="impl"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#771-778">source</a><a href="#impl-Debug-for-Slab%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, C: <a class="trait" href="trait.Config.html" title="trait sharded_slab::Config">Config</a>> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T, C></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#772-777">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.80.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-Slab%3CT%3E" class="impl"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#765-769">source</a><a href="#impl-Default-for-Slab%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#766-768">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><section id="impl-Send-for-Slab%3CT,+C%3E" class="impl"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#780">source</a><a href="#impl-Send-for-Slab%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, C: <a class="trait" href="trait.Config.html" title="trait sharded_slab::Config">Config</a>> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T, C></h3></section><section id="impl-Sync-for-Slab%3CT,+C%3E" class="impl"><a class="src rightside" href="../src/sharded_slab/lib.rs.html#781">source</a><a href="#impl-Sync-for-Slab%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, C: <a class="trait" href="trait.Config.html" title="trait sharded_slab::Config">Config</a>> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T, C></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Slab%3CT,+C%3E" class="impl"><a href="#impl-Freeze-for-Slab%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C = <a class="struct" href="struct.DefaultConfig.html" title="struct sharded_slab::DefaultConfig">DefaultConfig</a>> !<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T, C></h3></section><section id="impl-RefUnwindSafe-for-Slab%3CT,+C%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Slab%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T, C><div class="where">where
|
||
C: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Unpin-for-Slab%3CT,+C%3E" class="impl"><a href="#impl-Unpin-for-Slab%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T, C><div class="where">where
|
||
C: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-Slab%3CT,+C%3E" class="impl"><a href="#impl-UnwindSafe-for-Slab%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C = <a class="struct" href="struct.DefaultConfig.html" title="struct sharded_slab::DefaultConfig">DefaultConfig</a>> !<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Slab.html" title="struct sharded_slab::Slab">Slab</a><T, C></h3></section></div><h2 id="blanket-implementations" class="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-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><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 class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html#tymethod.from" 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-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html#tymethod.into" 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><a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><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-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></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 href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></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 class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></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-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></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 href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></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 class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div><script type="text/json" id="notable-traits-data">{"UniqueIter<'_, T, C>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.UniqueIter.html\" title=\"struct sharded_slab::UniqueIter\">UniqueIter</a><'a, T, C></code></h3><pre><code><div class=\"where\">impl<'a, T, C: <a class=\"trait\" href=\"trait.Config.html\" title=\"trait sharded_slab::Config\">Config</a>> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.UniqueIter.html\" title=\"struct sharded_slab::UniqueIter\">UniqueIter</a><'a, T, C></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.80.0/std/primitive.reference.html\">&'a T</a>;</div>"}</script></section></div></main></body></html> |