| <!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 reader-writer lock."><meta name="keywords" content="rust, rustlang, rust-lang, ShardedLock"><title>ShardedLock in crossbeam_utils::sync - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc 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><a class="sidebar-logo" href="../../crossbeam_utils/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../crossbeam_utils/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ShardedLock</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.get_mut">get_mut</a></li><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.is_poisoned">is_poisoned</a></li><li><a href="#method.new">new</a></li><li><a href="#method.read">read</a></li><li><a href="#method.try_read">try_read</a></li><li><a href="#method.try_write">try_write</a></li><li><a href="#method.write">write</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-ShardedLock%3CT%3E">Debug</a></li><li><a href="#impl-Default-for-ShardedLock%3CT%3E">Default</a></li><li><a href="#impl-From%3CT%3E-for-ShardedLock%3CT%3E">From<T></a></li><li><a href="#impl-RefUnwindSafe-for-ShardedLock%3CT%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ShardedLock%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-ShardedLock%3CT%3E">Sync</a></li><li><a href="#impl-UnwindSafe-for-ShardedLock%3CT%3E">UnwindSafe</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Unpin-for-ShardedLock%3CT%3E">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-ShardedLock%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ShardedLock%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ShardedLock%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3C!%3E-for-ShardedLock%3CT%3E">From<!></a></li><li><a href="#impl-From%3CT%3E-for-ShardedLock%3CT%3E-1">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ShardedLock%3CT%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-ShardedLock%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ShardedLock%3CT%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In crossbeam_utils::sync</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">crossbeam_utils</a>::<wbr><a href="index.html">sync</a>::<wbr><a class="struct" href="#">ShardedLock</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#76-82">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct ShardedLock<T: ?Sized> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A sharded reader-writer lock.</p> |
| <p>This lock is equivalent to <a href="std::sync::RwLock"><code>RwLock</code></a>, except read operations are faster and write operations |
| are slower.</p> |
| <p>A <code>ShardedLock</code> is internally made of a list of <em>shards</em>, each being a <a href="std::sync::RwLock"><code>RwLock</code></a> occupying a |
| single cache line. Read operations will pick one of the shards depending on the current thread |
| and lock it. Write operations need to lock all shards in succession.</p> |
| <p>By splitting the lock into shards, concurrent read operations will in most cases choose |
| different shards and thus update different cache lines, which is good for scalability. However, |
| write operations need to do more work and are therefore slower than usual.</p> |
| <p>The priority policy of the lock is dependent on the underlying operating system’s |
| implementation, and this type does not guarantee that any particular policy will be used.</p> |
| <h2 id="poisoning"><a href="#poisoning">Poisoning</a></h2> |
| <p>A <code>ShardedLock</code>, like <a href="std::sync::RwLock"><code>RwLock</code></a>, will become poisoned on a panic. Note that it may only be |
| poisoned if a panic occurs while a write operation is in progress. If a panic occurs in any |
| read operation, the lock will not be poisoned.</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>crossbeam_utils::sync::ShardedLock; |
| |
| <span class="kw">let </span>lock = ShardedLock::new(<span class="number">5</span>); |
| |
| <span class="comment">// Any number of read locks can be held at once. |
| </span>{ |
| <span class="kw">let </span>r1 = lock.read().unwrap(); |
| <span class="kw">let </span>r2 = lock.read().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>r1, <span class="number">5</span>); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>r2, <span class="number">5</span>); |
| } <span class="comment">// Read locks are dropped at this point. |
| |
| // However, only one write lock may be held. |
| </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>w = lock.write().unwrap(); |
| <span class="kw-2">*</span>w += <span class="number">1</span>; |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>w, <span class="number">6</span>); |
| } <span class="comment">// Write lock is dropped here.</span></code></pre></div> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ShardedLock%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#90-143">source</a><a href="#impl-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#100-112">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(value: T) -> <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h4></section></summary><div class="docblock"><p>Creates a new sharded reader-writer lock.</p> |
| <h5 id="examples-1"><a href="#examples-1">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::sync::ShardedLock; |
| |
| <span class="kw">let </span>lock = ShardedLock::new(<span class="number">5</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_inner" class="method has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#133-142">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fnname">into_inner</a>(self) -> LockResult<T></h4></section></summary><div class="docblock"><p>Consumes this lock, returning the underlying data.</p> |
| <h5 id="errors"><a href="#errors">Errors</a></h5> |
| <p>This method will return an error if the lock is poisoned. A lock gets poisoned when a write |
| operation panics.</p> |
| <h5 id="examples-2"><a href="#examples-2">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::sync::ShardedLock; |
| |
| <span class="kw">let </span>lock = ShardedLock::new(String::new()); |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>s = lock.write().unwrap(); |
| <span class="kw-2">*</span>s = <span class="string">"modified"</span>.to_owned(); |
| } |
| <span class="macro">assert_eq!</span>(lock.into_inner().unwrap(), <span class="string">"modified"</span>);</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ShardedLock%3CT%3E-1" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#145-442">source</a><a href="#impl-ShardedLock%3CT%3E-1" class="anchor"></a><h3 class="code-header">impl<T: ?Sized> <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_poisoned" class="method has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#167-169">source</a><h4 class="code-header">pub fn <a href="#method.is_poisoned" class="fnname">is_poisoned</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the lock is poisoned.</p> |
| <p>If another thread can still access the lock, it may become poisoned at any time. A <code>false</code> |
| result should not be trusted without additional synchronization.</p> |
| <h5 id="examples-3"><a href="#examples-3">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::sync::ShardedLock; |
| <span class="kw">use </span>std::sync::Arc; |
| <span class="kw">use </span>std::thread; |
| |
| <span class="kw">let </span>lock = Arc::new(ShardedLock::new(<span class="number">0</span>)); |
| <span class="kw">let </span>c_lock = lock.clone(); |
| |
| <span class="kw">let _ </span>= thread::spawn(<span class="kw">move </span>|| { |
| <span class="kw">let </span>_lock = c_lock.write().unwrap(); |
| <span class="macro">panic!</span>(); <span class="comment">// the lock gets poisoned |
| </span>}).join(); |
| <span class="macro">assert_eq!</span>(lock.is_poisoned(), <span class="bool-val">true</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#189-198">source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fnname">get_mut</a>(&mut self) -> LockResult<&mut T></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the underlying data.</p> |
| <p>Since this call borrows the lock mutably, no actual locking needs to take place.</p> |
| <h5 id="errors-1"><a href="#errors-1">Errors</a></h5> |
| <p>This method will return an error if the lock is poisoned. A lock gets poisoned when a write |
| operation panics.</p> |
| <h5 id="examples-4"><a href="#examples-4">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::sync::ShardedLock; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>lock = ShardedLock::new(<span class="number">0</span>); |
| <span class="kw-2">*</span>lock.get_mut().unwrap() = <span class="number">10</span>; |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>lock.read().unwrap(), <span class="number">10</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_read" class="method has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#224-246">source</a><h4 class="code-header">pub fn <a href="#method.try_read" class="fnname">try_read</a>(&self) -> TryLockResult<<a class="struct" href="struct.ShardedLockReadGuard.html" title="struct crossbeam_utils::sync::ShardedLockReadGuard">ShardedLockReadGuard</a><'_, T>></h4></section></summary><div class="docblock"><p>Attempts to acquire this lock with shared read access.</p> |
| <p>If the access could not be granted at this time, an error is returned. Otherwise, a guard |
| is returned which will release the shared access when it is dropped. This method does not |
| provide any guarantees with respect to the ordering of whether contentious readers or |
| writers will acquire the lock first.</p> |
| <h5 id="errors-2"><a href="#errors-2">Errors</a></h5> |
| <p>This method will return an error if the lock is poisoned. A lock gets poisoned when a write |
| operation panics.</p> |
| <h5 id="examples-5"><a href="#examples-5">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::sync::ShardedLock; |
| |
| <span class="kw">let </span>lock = ShardedLock::new(<span class="number">1</span>); |
| |
| <span class="kw">match </span>lock.try_read() { |
| <span class="prelude-val">Ok</span>(n) => <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>n, <span class="number">1</span>), |
| <span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="macro">unreachable!</span>(), |
| };</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read" class="method has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#284-302">source</a><h4 class="code-header">pub fn <a href="#method.read" class="fnname">read</a>(&self) -> LockResult<<a class="struct" href="struct.ShardedLockReadGuard.html" title="struct crossbeam_utils::sync::ShardedLockReadGuard">ShardedLockReadGuard</a><'_, T>></h4></section></summary><div class="docblock"><p>Locks with shared read access, blocking the current thread until it can be acquired.</p> |
| <p>The calling thread will be blocked until there are no more writers which hold the lock. |
| There may be other readers currently inside the lock when this method returns. This method |
| does not provide any guarantees with respect to the ordering of whether contentious readers |
| or writers will acquire the lock first.</p> |
| <p>Returns a guard which will release the shared access when dropped.</p> |
| <h5 id="errors-3"><a href="#errors-3">Errors</a></h5> |
| <p>This method will return an error if the lock is poisoned. A lock gets poisoned when a write |
| operation panics.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>This method might panic when called if the lock is already held by the current thread.</p> |
| <h5 id="examples-6"><a href="#examples-6">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::sync::ShardedLock; |
| <span class="kw">use </span>std::sync::Arc; |
| <span class="kw">use </span>std::thread; |
| |
| <span class="kw">let </span>lock = Arc::new(ShardedLock::new(<span class="number">1</span>)); |
| <span class="kw">let </span>c_lock = lock.clone(); |
| |
| <span class="kw">let </span>n = lock.read().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>n, <span class="number">1</span>); |
| |
| thread::spawn(<span class="kw">move </span>|| { |
| <span class="kw">let </span>r = c_lock.read(); |
| <span class="macro">assert!</span>(r.is_ok()); |
| }).join().unwrap();</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_write" class="method has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#328-376">source</a><h4 class="code-header">pub fn <a href="#method.try_write" class="fnname">try_write</a>(&self) -> TryLockResult<<a class="struct" href="struct.ShardedLockWriteGuard.html" title="struct crossbeam_utils::sync::ShardedLockWriteGuard">ShardedLockWriteGuard</a><'_, T>></h4></section></summary><div class="docblock"><p>Attempts to acquire this lock with exclusive write access.</p> |
| <p>If the access could not be granted at this time, an error is returned. Otherwise, a guard |
| is returned which will release the exclusive access when it is dropped. This method does |
| not provide any guarantees with respect to the ordering of whether contentious readers or |
| writers will acquire the lock first.</p> |
| <h5 id="errors-4"><a href="#errors-4">Errors</a></h5> |
| <p>This method will return an error if the lock is poisoned. A lock gets poisoned when a write |
| operation panics.</p> |
| <h5 id="examples-7"><a href="#examples-7">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::sync::ShardedLock; |
| |
| <span class="kw">let </span>lock = ShardedLock::new(<span class="number">1</span>); |
| |
| <span class="kw">let </span>n = lock.read().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>n, <span class="number">1</span>); |
| |
| <span class="macro">assert!</span>(lock.try_write().is_err());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write" class="method has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#408-441">source</a><h4 class="code-header">pub fn <a href="#method.write" class="fnname">write</a>(&self) -> LockResult<<a class="struct" href="struct.ShardedLockWriteGuard.html" title="struct crossbeam_utils::sync::ShardedLockWriteGuard">ShardedLockWriteGuard</a><'_, T>></h4></section></summary><div class="docblock"><p>Locks with exclusive write access, blocking the current thread until it can be acquired.</p> |
| <p>The calling thread will be blocked until there are no more writers which hold the lock. |
| There may be other readers currently inside the lock when this method returns. This method |
| does not provide any guarantees with respect to the ordering of whether contentious readers |
| or writers will acquire the lock first.</p> |
| <p>Returns a guard which will release the exclusive access when dropped.</p> |
| <h5 id="errors-5"><a href="#errors-5">Errors</a></h5> |
| <p>This method will return an error if the lock is poisoned. A lock gets poisoned when a write |
| operation panics.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>This method might panic when called if the lock is already held by the current thread.</p> |
| <h5 id="examples-8"><a href="#examples-8">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::sync::ShardedLock; |
| |
| <span class="kw">let </span>lock = ShardedLock::new(<span class="number">1</span>); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>n = lock.write().unwrap(); |
| <span class="kw-2">*</span>n = <span class="number">2</span>; |
| |
| <span class="macro">assert!</span>(lock.try_read().is_err());</code></pre></div> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ShardedLock%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#444-468">source</a><a href="#impl-Debug-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + Debug> Debug for <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#445-467">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-ShardedLock%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#470-474">source</a><a href="#impl-Default-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: Default> Default for <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#471-473">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a class="fnname">default</a>() -> <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CT%3E-for-ShardedLock%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#476-480">source</a><a href="#impl-From%3CT%3E-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#477-479">source</a><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><section id="impl-RefUnwindSafe-for-ShardedLock%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#88">source</a><a href="#impl-RefUnwindSafe-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized> RefUnwindSafe for <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></section><section id="impl-Send-for-ShardedLock%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#84">source</a><a href="#impl-Send-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + Send> Send for <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></section><section id="impl-Sync-for-ShardedLock%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#85">source</a><a href="#impl-Sync-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + Send + Sync> Sync for <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></section><section id="impl-UnwindSafe-for-ShardedLock%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#87">source</a><a href="#impl-UnwindSafe-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized> UnwindSafe for <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-Unpin-for-ShardedLock%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized> Unpin for <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T><span class="where fmt-newline">where<br> T: Unpin,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ShardedLock%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ShardedLock%3CT%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ShardedLock%3CT%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3C!%3E-for-ShardedLock%3CT%3E" class="impl has-srclink"><a href="#impl-From%3C!%3E-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<!> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from-2" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: !) -> T</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ShardedLock%3CT%3E-1" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-ShardedLock%3CT%3E-1" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ShardedLock%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ShardedLock%3CT%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ShardedLock%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-ShardedLock%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="crossbeam_utils" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
