mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 08:28:24 +00:00
186 lines
42 KiB
HTML
186 lines
42 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="An owned guard that allows exclusive, mutable access to an object in a pool."><title>OwnedRefMut in sharded_slab::pool - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">☰</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="#">OwnedRefMut</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.downgrade">downgrade</a></li><li><a href="#method.key">key</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-OwnedRefMut%3CT,+C%3E">Debug</a></li><li><a href="#impl-__Deref-for-OwnedRefMut%3CT,+C%3E">Deref</a></li><li><a href="#impl-DerefMut-for-OwnedRefMut%3CT,+C%3E">DerefMut</a></li><li><a href="#impl-Drop-for-OwnedRefMut%3CT,+C%3E">Drop</a></li><li><a href="#impl-PartialEq%3CT%3E-for-OwnedRefMut%3CT,+C%3E">PartialEq<T></a></li><li><a href="#impl-Send-for-OwnedRefMut%3CT,+C%3E">Send</a></li><li><a href="#impl-Sync-for-OwnedRefMut%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-RefUnwindSafe-for-OwnedRefMut%3CT,+C%3E">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-OwnedRefMut%3CT,+C%3E">!UnwindSafe</a></li><li><a href="#impl-Unpin-for-OwnedRefMut%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 sharded_slab::pool</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../sharded_slab/all.html" title="show sidebar"></a></div><input class="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"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">sharded_slab</a>::<wbr><a href="index.html">pool</a>::<wbr><a class="struct" href="#">OwnedRefMut</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/sharded_slab/pool.rs.html#371-379">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct OwnedRefMut<T, C = <a class="struct" href="../struct.DefaultConfig.html" title="struct sharded_slab::DefaultConfig">DefaultConfig</a>><div class="where">where
|
||
T: <a class="trait" href="../trait.Clear.html" title="trait sharded_slab::Clear">Clear</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
|
||
C: <a class="trait" href="../trait.Config.html" title="trait sharded_slab::Config">Config</a>,</div>{ <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>An owned guard that allows exclusive, mutable access to an object in a pool.</p>
|
||
<p>An <code>OwnedRefMut<T></code> functions more or less identically to an owned
|
||
<code>Box<T></code>: it can be passed to functions, stored in structure fields, and
|
||
borrowed mutably or immutably, and can be owned for arbitrary lifetimes.
|
||
The difference is that, unlike a <code>Box<T></code>, the memory allocation for the
|
||
<code>T</code> lives in the <code>Pool</code>; when an <code>OwnedRefMut</code> is created, it may reuse
|
||
memory that was allocated for a previous pooled object that has been
|
||
cleared. Additionally, the <code>OwnedRefMut</code> may be <a href="struct.OwnedRefMut.html#method.downgrade" title="method sharded_slab::pool::OwnedRefMut::downgrade">downgraded</a> to an
|
||
<a href="struct.OwnedRef.html" title="struct sharded_slab::pool::OwnedRef"><code>OwnedRef</code></a> which may be shared freely, essentially turning the <code>Box</code>
|
||
into an <code>Arc</code>.</p>
|
||
<p>This is returned by <a href="../struct.Pool.html#method.create_owned" title="method sharded_slab::Pool::create_owned"><code>Pool::create_owned</code></a>.</p>
|
||
<p>While the guard exists, it indicates to the pool that the item the guard
|
||
references is currently being accessed. If the item is removed from the pool
|
||
while the guard exists, theremoval will be deferred until all guards are
|
||
dropped.</p>
|
||
<p>Unlike <a href="struct.RefMut.html" title="struct sharded_slab::pool::RefMut"><code>RefMut</code></a>, which borrows the pool, an <code>OwnedRefMut</code> clones the <code>Arc</code>
|
||
around the pool. Therefore, it keeps the pool from being dropped until all
|
||
such guards have been dropped. This means that an <code>OwnedRefMut</code> may be held for
|
||
an arbitrary lifetime.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::sync::Arc;
|
||
|
||
<span class="kw">let </span>pool: Arc<Pool<String>> = Arc::new(Pool::new());
|
||
|
||
<span class="comment">// Create a new pooled item, returning an owned guard that allows mutable
|
||
// access to the new item.
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>item = pool.clone().create_owned().unwrap();
|
||
<span class="comment">// Return a key that allows indexing the created item once the guard
|
||
// has been dropped.
|
||
</span><span class="kw">let </span>key = item.key();
|
||
|
||
<span class="comment">// Mutate the item.
|
||
</span>item.push_str(<span class="string">"Hello"</span>);
|
||
<span class="comment">// Drop the guard, releasing mutable access to the new item.
|
||
</span>drop(item);
|
||
|
||
<span class="doccomment">/// Other threads may now (immutably) access the item using the returned key.
|
||
</span>thread::spawn(<span class="kw">move </span>|| {
|
||
<span class="macro">assert_eq!</span>(pool.get(key).unwrap(), String::from(<span class="string">"Hello"</span>));
|
||
}).join().unwrap();</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>pool: Arc<Pool<String>> = Arc::new(Pool::new());
|
||
|
||
<span class="comment">// Create a new item, returning an owned, mutable guard.
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>value = pool.clone().create_owned().unwrap();
|
||
|
||
<span class="comment">// Now, the original `Arc` clone of the pool may be dropped, but the
|
||
// returned `OwnedRefMut` can still access the value.
|
||
</span>drop(pool);
|
||
|
||
value.push_str(<span class="string">"hello world"</span>);
|
||
<span class="macro">assert_eq!</span>(value, String::from(<span class="string">"hello world"</span>));</code></pre></div>
|
||
<p>Unlike <a href="struct.RefMut.html" title="struct sharded_slab::pool::RefMut"><code>RefMut</code></a>, an <code>OwnedRefMut</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::pool::OwnedRefMut;
|
||
<span class="kw">use </span>std::sync::Arc;
|
||
|
||
<span class="kw">pub struct </span>MyStruct {
|
||
pool_ref: OwnedRefMut<String>,
|
||
<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>pool: Arc<Pool<String>> = Arc::new(Pool::new());
|
||
|
||
<span class="comment">// Create a new item, returning a mutable owned reference.
|
||
</span><span class="kw">let </span>pool_ref = pool.clone().create_owned().unwrap();
|
||
|
||
<span class="kw">let </span>my_struct = MyStruct {
|
||
pool_ref,
|
||
<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><code>OwnedRefMut</code>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>pool: Arc<Pool<String>> = Arc::new(Pool::new());
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>value = pool.clone().create_owned().unwrap();
|
||
<span class="kw">let </span>key = value.key();
|
||
|
||
thread::spawn(<span class="kw">move </span>|| {
|
||
value.push_str(<span class="string">"hello world"</span>);
|
||
<span class="comment">// ...
|
||
</span>}).join().unwrap();
|
||
|
||
<span class="comment">// Once the `OwnedRefMut` has been dropped by the other thread, we may
|
||
// now access the value immutably on this thread.
|
||
|
||
</span><span class="macro">assert_eq!</span>(pool.get(key).unwrap(), String::from(<span class="string">"hello world"</span>));</code></pre></div>
|
||
<p>Downgrading from a mutable to an immutable reference:</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>pool: Arc<Pool<String>> = Arc::new(Pool::new());
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>value = pool.clone().create_owned().unwrap();
|
||
<span class="kw">let </span>key = value.key();
|
||
value.push_str(<span class="string">"hello world"</span>);
|
||
|
||
<span class="comment">// Downgrade the mutable owned ref to an immutable owned ref.
|
||
</span><span class="kw">let </span>value = value.downgrade();
|
||
|
||
<span class="comment">// Once the `OwnedRefMut` has been downgraded, other threads may
|
||
// immutably access the pooled value:
|
||
</span>thread::spawn(<span class="kw">move </span>|| {
|
||
<span class="macro">assert_eq!</span>(pool.get(key).unwrap(), String::from(<span class="string">"hello world"</span>));
|
||
}).join().unwrap();
|
||
|
||
<span class="comment">// This thread can still access the pooled value through the
|
||
// immutable owned ref:
|
||
</span><span class="macro">assert_eq!</span>(value, String::from(<span class="string">"hello world"</span>));</code></pre></div>
|
||
</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-OwnedRefMut%3CT,+C%3E" class="impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1182-1253">source</a><a href="#impl-OwnedRefMut%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</a><T, C><div class="where">where
|
||
T: <a class="trait" href="../trait.Clear.html" title="trait sharded_slab::Clear">Clear</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
|
||
C: <a class="trait" href="../trait.Config.html" title="trait sharded_slab::Config">Config</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.key" class="method"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1188-1190">source</a><h4 class="code-header">pub fn <a href="#method.key" class="fn">key</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the key used to access this guard</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.downgrade" class="method"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1227-1234">source</a><h4 class="code-header">pub fn <a href="#method.downgrade" class="fn">downgrade</a>(self) -> <a class="struct" href="struct.OwnedRef.html" title="struct sharded_slab::pool::OwnedRef">OwnedRef</a><T, C></h4></section></summary><div class="docblock"><p>Downgrades the owned mutable guard to an owned immutable guard, allowing
|
||
access to the pooled value from other threads.</p>
|
||
<h6 id="examples-1"><a href="#examples-1">Examples</a></h6>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>pool = Arc::new(Pool::<String>::new());
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>guard_mut = pool.clone().create_owned().unwrap();
|
||
<span class="kw">let </span>key = guard_mut.key();
|
||
guard_mut.push_str(<span class="string">"Hello"</span>);
|
||
|
||
<span class="comment">// The pooled string is currently borrowed mutably, so other threads
|
||
// may not access it.
|
||
</span><span class="kw">let </span>pool2 = pool.clone();
|
||
thread::spawn(<span class="kw">move </span>|| {
|
||
<span class="macro">assert!</span>(pool2.get(key).is_none())
|
||
}).join().unwrap();
|
||
|
||
<span class="comment">// Downgrade the guard to an immutable reference.
|
||
</span><span class="kw">let </span>guard = guard_mut.downgrade();
|
||
|
||
<span class="comment">// Now, other threads may also access the pooled value.
|
||
</span><span class="kw">let </span>pool2 = pool.clone();
|
||
thread::spawn(<span class="kw">move </span>|| {
|
||
<span class="kw">let </span>guard = pool2.get(key)
|
||
.expect(<span class="string">"the item may now be referenced by other threads"</span>);
|
||
<span class="macro">assert_eq!</span>(guard, String::from(<span class="string">"Hello"</span>));
|
||
}).join().unwrap();
|
||
|
||
<span class="comment">// We can still access the value immutably through the downgraded guard.
|
||
</span><span class="macro">assert_eq!</span>(guard, String::from(<span class="string">"Hello"</span>));</code></pre></div>
|
||
</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-OwnedRefMut%3CT,+C%3E" class="impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1310-1318">source</a><a href="#impl-Debug-for-OwnedRefMut%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</a><T, C><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="../trait.Clear.html" title="trait sharded_slab::Clear">Clear</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
|
||
C: <a class="trait" href="../trait.Config.html" title="trait sharded_slab::Config">Config</a>,</div></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/pool.rs.html#1315-1317">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.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.76.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-DerefMut-for-OwnedRefMut%3CT,+C%3E" class="impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1267-1282">source</a><a href="#impl-DerefMut-for-OwnedRefMut%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</a><T, C><div class="where">where
|
||
T: <a class="trait" href="../trait.Clear.html" title="trait sharded_slab::Clear">Clear</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
|
||
C: <a class="trait" href="../trait.Config.html" title="trait sharded_slab::Config">Config</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.deref_mut" class="method trait-impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1272-1281">source</a><a href="#method.deref_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut" class="fn">deref_mut</a>(&mut self) -> &mut Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></h4></section></summary><div class='docblock'>Mutably dereferences the value.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Drop-for-OwnedRefMut%3CT,+C%3E" class="impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1284-1308">source</a><a href="#impl-Drop-for-OwnedRefMut%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</a><T, C><div class="where">where
|
||
T: <a class="trait" href="../trait.Clear.html" title="trait sharded_slab::Clear">Clear</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
|
||
C: <a class="trait" href="../trait.Config.html" title="trait sharded_slab::Config">Config</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1289-1307">source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.76.0/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CT%3E-for-OwnedRefMut%3CT,+C%3E" class="impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1320-1328">source</a><a href="#impl-PartialEq%3CT%3E-for-OwnedRefMut%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><T> for <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</a><T, C><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><T> + <a class="trait" href="../trait.Clear.html" title="trait sharded_slab::Clear">Clear</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
|
||
C: <a class="trait" href="../trait.Config.html" title="trait sharded_slab::Config">Config</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1325-1327">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||
by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/cmp.rs.html#242">source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
|
||
sufficient, and should not be overridden without very good reason.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-__Deref-for-OwnedRefMut%3CT,+C%3E" class="impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1255-1265">source</a><a href="#impl-__Deref-for-OwnedRefMut%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</a><T, C><div class="where">where
|
||
T: <a class="trait" href="../trait.Clear.html" title="trait sharded_slab::Clear">Clear</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
|
||
C: <a class="trait" href="../trait.Config.html" title="trait sharded_slab::Config">Config</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl"><a href="#associatedtype.Target" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html#associatedtype.Target" class="associatedtype">Target</a> = T</h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1262-1264">source</a><a href="#method.deref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html#tymethod.deref" class="fn">deref</a>(&self) -> &Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></h4></section></summary><div class='docblock'>Dereferences the value.</div></details></div></details><section id="impl-Send-for-OwnedRefMut%3CT,+C%3E" class="impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1337-1342">source</a><a href="#impl-Send-for-OwnedRefMut%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</a><T, C><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="../trait.Clear.html" title="trait sharded_slab::Clear">Clear</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
|
||
C: <a class="trait" href="../trait.Config.html" title="trait sharded_slab::Config">Config</a>,</div></h3></section><section id="impl-Sync-for-OwnedRefMut%3CT,+C%3E" class="impl"><a class="src rightside" href="../../src/sharded_slab/pool.rs.html#1330-1335">source</a><a href="#impl-Sync-for-OwnedRefMut%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</a><T, C><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="../trait.Clear.html" title="trait sharded_slab::Clear">Clear</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
|
||
C: <a class="trait" href="../trait.Config.html" title="trait sharded_slab::Config">Config</a>,</div></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-RefUnwindSafe-for-OwnedRefMut%3CT,+C%3E" class="impl"><a href="#impl-RefUnwindSafe-for-OwnedRefMut%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.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</a><T, C></h3></section><section id="impl-Unpin-for-OwnedRefMut%3CT,+C%3E" class="impl"><a href="#impl-Unpin-for-OwnedRefMut%3CT,+C%3E" class="anchor">§</a><h3 class="code-header">impl<T, C> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</a><T, C></h3></section><section id="impl-UnwindSafe-for-OwnedRefMut%3CT,+C%3E" class="impl"><a href="#impl-UnwindSafe-for-OwnedRefMut%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.76.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.OwnedRefMut.html" title="struct sharded_slab::pool::OwnedRefMut">OwnedRefMut</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.76.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.76.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.76.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.76.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.76.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.76.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.76.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.76.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.76.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.76.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.76.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.76.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.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.76.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.76.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.76.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.76.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.76.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.76.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.76.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.76.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.76.0/src/core/convert/mod.rs.html#763">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.76.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.76.0/src/core/convert/mod.rs.html#766">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#747-749">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.76.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.76.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.76.0/src/core/convert/mod.rs.html#756">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.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.76.0/src/core/convert/mod.rs.html#803-805">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.76.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.76.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.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#810">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.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.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#788-790">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.76.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.76.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.76.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#795">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.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.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.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></section></div></main></body></html> |