162 lines
44 KiB
HTML
162 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 reader-writer lock."><title>ShardedLock in crossbeam_utils::sync - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="crossbeam_utils" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">ShardedLock</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../crossbeam_utils/index.html">crossbeam_<wbr>utils</a><span class="version">0.8.21</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Sharded<wbr>Lock</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#poisoning" title="Poisoning">Poisoning</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.get_mut" title="get_mut">get_mut</a></li><li><a href="#method.into_inner" title="into_inner">into_inner</a></li><li><a href="#method.is_poisoned" title="is_poisoned">is_poisoned</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.read" title="read">read</a></li><li><a href="#method.try_read" title="try_read">try_read</a></li><li><a href="#method.try_write" title="try_write">try_write</a></li><li><a href="#method.write" title="write">write</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-ShardedLock%3CT%3E" title="Debug">Debug</a></li><li><a href="#impl-Default-for-ShardedLock%3CT%3E" title="Default">Default</a></li><li><a href="#impl-From%3CT%3E-for-ShardedLock%3CT%3E" title="From<T>">From<T></a></li><li><a href="#impl-RefUnwindSafe-for-ShardedLock%3CT%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ShardedLock%3CT%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-ShardedLock%3CT%3E" title="Sync">Sync</a></li><li><a href="#impl-UnwindSafe-for-ShardedLock%3CT%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-ShardedLock%3CT%3E" title="!Freeze">!Freeze</a></li><li><a href="#impl-Unpin-for-ShardedLock%3CT%3E" title="Unpin">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" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3C!%3E-for-T" title="From<!>">From<!></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In crossbeam_<wbr>utils::<wbr>sync</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">crossbeam_utils</a>::<wbr><a href="index.html">sync</a></div><h1>Struct <span class="struct">Sharded<wbr>Lock</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#78-84">Source</a> </span></div><pre class="rust item-decl"><code>pub struct ShardedLock<T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</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 reader-writer lock.</p>
|
||
<p>This lock is equivalent to <a href="https://doc.rust-lang.org/1.93.1/std/sync/poison/rwlock/struct.RwLock.html" title="struct std::sync::poison::rwlock::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="https://doc.rust-lang.org/1.93.1/std/sync/poison/rwlock/struct.RwLock.html" title="struct std::sync::poison::rwlock::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 class="doc-anchor" href="#poisoning">§</a>Poisoning</h2>
|
||
<p>A <code>ShardedLock</code>, like <a href="https://doc.rust-lang.org/1.93.1/std/sync/poison/rwlock/struct.RwLock.html" title="struct std::sync::poison::rwlock::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 class="doc-anchor" href="#examples">§</a>Examples</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="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ShardedLock%3CT%3E" class="impl"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#92-145">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="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#102-114">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">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 class="doc-anchor" href="#examples-1">§</a>Examples</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="toggle method-toggle" open><summary><section id="method.into_inner" class="method"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#135-144">Source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fn">into_inner</a>(self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/sync/poison/type.LockResult.html" title="type std::sync::poison::LockResult">LockResult</a><T></h4></section></summary><div class="docblock"><p>Consumes this lock, returning the underlying data.</p>
|
||
<h5 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</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 class="doc-anchor" href="#examples-2">§</a>Examples</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="toggle implementors-toggle" open><summary><section id="impl-ShardedLock%3CT%3E-1" class="impl"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#147-444">Source</a><a href="#impl-ShardedLock%3CT%3E-1" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <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="toggle method-toggle" open><summary><section id="method.is_poisoned" class="method"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#169-171">Source</a><h4 class="code-header">pub fn <a href="#method.is_poisoned" class="fn">is_poisoned</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></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 class="doc-anchor" href="#examples-3">§</a>Examples</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="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#191-200">Source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fn">get_mut</a>(&mut self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/sync/poison/type.LockResult.html" title="type std::sync::poison::LockResult">LockResult</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut T</a>></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 class="doc-anchor" href="#errors-1">§</a>Errors</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 class="doc-anchor" href="#examples-4">§</a>Examples</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="toggle method-toggle" open><summary><section id="method.try_read" class="method"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#226-248">Source</a><h4 class="code-header">pub fn <a href="#method.try_read" class="fn">try_read</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/sync/poison/type.TryLockResult.html" title="type std::sync::poison::TryLockResult">TryLockResult</a><<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 class="doc-anchor" href="#errors-2">§</a>Errors</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 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>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="toggle method-toggle" open><summary><section id="method.read" class="method"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#286-304">Source</a><h4 class="code-header">pub fn <a href="#method.read" class="fn">read</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/sync/poison/type.LockResult.html" title="type std::sync::poison::LockResult">LockResult</a><<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 class="doc-anchor" href="#errors-3">§</a>Errors</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 class="doc-anchor" href="#panics">§</a>Panics</h5>
|
||
<p>This method might panic when called if the lock is already held by the current thread.</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">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="toggle method-toggle" open><summary><section id="method.try_write" class="method"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#330-378">Source</a><h4 class="code-header">pub fn <a href="#method.try_write" class="fn">try_write</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/sync/poison/type.TryLockResult.html" title="type std::sync::poison::TryLockResult">TryLockResult</a><<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 class="doc-anchor" href="#errors-4">§</a>Errors</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 class="doc-anchor" href="#examples-7">§</a>Examples</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="toggle method-toggle" open><summary><section id="method.write" class="method"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#410-443">Source</a><h4 class="code-header">pub fn <a href="#method.write" class="fn">write</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/sync/poison/type.LockResult.html" title="type std::sync::poison::LockResult">LockResult</a><<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 class="doc-anchor" href="#errors-5">§</a>Errors</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 class="doc-anchor" href="#panics-1">§</a>Panics</h5>
|
||
<p>This method might panic when called if the lock is already held by the current thread.</p>
|
||
<h5 id="examples-8"><a class="doc-anchor" href="#examples-8">§</a>Examples</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="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-ShardedLock%3CT%3E" class="impl"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#446-470">Source</a><a href="#impl-Debug-for-ShardedLock%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> 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="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#447-469">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/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.93.1/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-ShardedLock%3CT%3E" class="impl"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#472-476">Source</a><a href="#impl-Default-for-ShardedLock%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html" title="trait core::default::Default">Default</a> 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="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#473-475">Source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html#tymethod.default" class="fn">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 href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CT%3E-for-ShardedLock%3CT%3E" class="impl"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#478-482">Source</a><a href="#impl-From%3CT%3E-for-ShardedLock%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><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="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#479-481">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">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"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#90">Source</a><a href="#impl-RefUnwindSafe-for-ShardedLock%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> 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"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#86">Source</a><a href="#impl-Send-for-ShardedLock%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> 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"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#87">Source</a><a href="#impl-Sync-for-ShardedLock%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> 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"><a class="src rightside" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#89">Source</a><a href="#impl-UnwindSafe-for-ShardedLock%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> 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="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-ShardedLock%3CT%3E" class="impl"><a href="#impl-Freeze-for-ShardedLock%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> !<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></section><section id="impl-Unpin-for-ShardedLock%3CT%3E" class="impl"><a href="#impl-Unpin-for-ShardedLock%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></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.93.1/src/core/any.rs.html#138">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.93.1/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.93.1/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.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/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.93.1/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.93.1/src/core/borrow.rs.html#212">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.93.1/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.93.1/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.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/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.93.1/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.93.1/src/core/borrow.rs.html#221">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.93.1/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.93.1/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.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/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.93.1/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.93.1/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%3C!%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#802">Source</a><a href="#impl-From%3C!%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.never.html">!</a>> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#803">Source</a><a href="#method.from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.never.html">!</a>) -> T</h4></section></summary><div class='docblock'>Converts to this type from the input type.</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.93.1/src/core/convert/mod.rs.html#785">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.93.1/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-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/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.93.1/src/core/convert/mod.rs.html#767-769">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.93.1/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.93.1/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.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/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.93.1/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.93.1/src/core/convert/mod.rs.html#827-829">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.93.1/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.93.1/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-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/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.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/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.93.1/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.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/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.93.1/src/core/convert/mod.rs.html#811-813">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.93.1/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.93.1/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" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/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.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/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.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/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> |