176 lines
50 KiB
HTML
176 lines
50 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."><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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.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="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../crossbeam_utils/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Struct ShardedLock</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.get_mut">get_mut</a><a href="#method.into_inner">into_inner</a><a href="#method.is_poisoned">is_poisoned</a><a href="#method.new">new</a><a href="#method.read">read</a><a href="#method.try_read">try_read</a><a href="#method.try_write">try_write</a><a href="#method.write">write</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Unpin">Unpin</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3C!%3E">From<!></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2 class="location">Other items in<br><a href="../index.html">crossbeam_utils</a>::<wbr><a href="index.html">sync</a></h2><div id="sidebar-vars" data-name="ShardedLock" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../crossbeam_utils/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">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></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#76-82" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust struct"><code>pub struct ShardedLock<T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> { /* fields omitted */ }</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="https://doc.rust-lang.org/1.59.0/std/sync/rwlock/struct.RwLock.html"><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.59.0/std/sync/rwlock/struct.RwLock.html"><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" class="section-header"><a href="#poisoning">Poisoning</a></h2>
|
||
<p>A <code>ShardedLock</code>, like <a href="https://doc.rust-lang.org/1.59.0/std/sync/rwlock/struct.RwLock.html"><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" class="section-header"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::sync::ShardedLock</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">lock</span> <span class="op">=</span> <span class="ident">ShardedLock::new</span>(<span class="number">5</span>);
|
||
|
||
<span class="comment">// Any number of read locks can be held at once.</span>
|
||
{
|
||
<span class="kw">let</span> <span class="ident">r1</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">read</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">r2</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">read</span>().<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span><span class="ident">r1</span>, <span class="number">5</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span><span class="ident">r2</span>, <span class="number">5</span>);
|
||
} <span class="comment">// Read locks are dropped at this point.</span>
|
||
|
||
<span class="comment">// However, only one write lock may be held.</span>
|
||
{
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">w</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">write</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw-2">*</span><span class="ident">w</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span><span class="ident">w</span>, <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><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#90-143" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#100-112" title="goto source code">[src]</a></div><a href="#method.new" class="anchor"></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></div></summary><div class="docblock"><p>Creates a new sharded reader-writer lock.</p>
|
||
<h5 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::sync::ShardedLock</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">lock</span> <span class="op">=</span> <span class="ident">ShardedLock::new</span>(<span class="number">5</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_inner" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#133-142" title="goto source code">[src]</a></div><a href="#method.into_inner" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fnname">into_inner</a>(self) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/sync/poison/type.LockResult.html" title="type std::sync::poison::LockResult">LockResult</a><T></h4></div></summary><div class="docblock"><p>Consumes this lock, returning the underlying data.</p>
|
||
<h5 id="errors" class="section-header"><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" class="section-header"><a href="#examples-2">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::sync::ShardedLock</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">lock</span> <span class="op">=</span> <span class="ident">ShardedLock::new</span>(<span class="ident">String::new</span>());
|
||
{
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">write</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw-2">*</span><span class="ident">s</span> <span class="op">=</span> <span class="string">"modified"</span>.<span class="ident">to_owned</span>();
|
||
}
|
||
<span class="macro">assert_eq!</span>(<span class="ident">lock</span>.<span class="ident">into_inner</span>().<span class="ident">unwrap</span>(), <span class="string">"modified"</span>);</code></pre></div>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#145-442" title="goto source code">[src]</a></div><a href="#impl-1" class="anchor"></a><h3 class="code-header in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/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></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.is_poisoned" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#167-169" title="goto source code">[src]</a></div><a href="#method.is_poisoned" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.is_poisoned" class="fnname">is_poisoned</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.bool.html">bool</a></h4></div></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" class="section-header"><a href="#examples-3">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::sync::ShardedLock</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::Arc</span>;
|
||
<span class="kw">use</span> <span class="ident">std::thread</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">lock</span> <span class="op">=</span> <span class="ident">Arc::new</span>(<span class="ident">ShardedLock::new</span>(<span class="number">0</span>));
|
||
<span class="kw">let</span> <span class="ident">c_lock</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">clone</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">thread::spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
|
||
<span class="kw">let</span> <span class="ident">_lock</span> <span class="op">=</span> <span class="ident">c_lock</span>.<span class="ident">write</span>().<span class="ident">unwrap</span>();
|
||
<span class="macro">panic!</span>(); <span class="comment">// the lock gets poisoned</span>
|
||
}).<span class="ident">join</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">lock</span>.<span class="ident">is_poisoned</span>(), <span class="bool-val">true</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.get_mut" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#189-198" title="goto source code">[src]</a></div><a href="#method.get_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fnname">get_mut</a>(&mut self) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/sync/poison/type.LockResult.html" title="type std::sync::poison::LockResult">LockResult</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&mut </a>T></h4></div></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" class="section-header"><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" class="section-header"><a href="#examples-4">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::sync::ShardedLock</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">lock</span> <span class="op">=</span> <span class="ident">ShardedLock::new</span>(<span class="number">0</span>);
|
||
<span class="kw-2">*</span><span class="ident">lock</span>.<span class="ident">get_mut</span>().<span class="ident">unwrap</span>() <span class="op">=</span> <span class="number">10</span>;
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span><span class="ident">lock</span>.<span class="ident">read</span>().<span class="ident">unwrap</span>(), <span class="number">10</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_read" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#224-246" title="goto source code">[src]</a></div><a href="#method.try_read" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_read" class="fnname">try_read</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/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></div></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" class="section-header"><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" class="section-header"><a href="#examples-5">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::sync::ShardedLock</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">lock</span> <span class="op">=</span> <span class="ident">ShardedLock::new</span>(<span class="number">1</span>);
|
||
|
||
<span class="kw">match</span> <span class="ident">lock</span>.<span class="ident">try_read</span>() {
|
||
<span class="prelude-val">Ok</span>(<span class="ident">n</span>) => <span class="macro">assert_eq!</span>(<span class="kw-2">*</span><span class="ident">n</span>, <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><div id="method.read" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#284-302" title="goto source code">[src]</a></div><a href="#method.read" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.read" class="fnname">read</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/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></div></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" class="section-header"><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" class="section-header"><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" class="section-header"><a href="#examples-6">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::sync::ShardedLock</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::Arc</span>;
|
||
<span class="kw">use</span> <span class="ident">std::thread</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">lock</span> <span class="op">=</span> <span class="ident">Arc::new</span>(<span class="ident">ShardedLock::new</span>(<span class="number">1</span>));
|
||
<span class="kw">let</span> <span class="ident">c_lock</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">clone</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">n</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">read</span>().<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span><span class="ident">n</span>, <span class="number">1</span>);
|
||
|
||
<span class="ident">thread::spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
|
||
<span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="ident">c_lock</span>.<span class="ident">read</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">r</span>.<span class="ident">is_ok</span>());
|
||
}).<span class="ident">join</span>().<span class="ident">unwrap</span>();</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_write" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#328-376" title="goto source code">[src]</a></div><a href="#method.try_write" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_write" class="fnname">try_write</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/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></div></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" class="section-header"><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" class="section-header"><a href="#examples-7">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::sync::ShardedLock</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">lock</span> <span class="op">=</span> <span class="ident">ShardedLock::new</span>(<span class="number">1</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">n</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">read</span>().<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span><span class="ident">n</span>, <span class="number">1</span>);
|
||
|
||
<span class="macro">assert!</span>(<span class="ident">lock</span>.<span class="ident">try_write</span>().<span class="ident">is_err</span>());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.write" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#408-441" title="goto source code">[src]</a></div><a href="#method.write" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.write" class="fnname">write</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/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></div></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" class="section-header"><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" class="section-header"><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" class="section-header"><a href="#examples-8">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::sync::ShardedLock</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">lock</span> <span class="op">=</span> <span class="ident">ShardedLock::new</span>(<span class="number">1</span>);
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">n</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">write</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw-2">*</span><span class="ident">n</span> <span class="op">=</span> <span class="number">2</span>;
|
||
|
||
<span class="macro">assert!</span>(<span class="ident">lock</span>.<span class="ident">try_read</span>().<span class="ident">is_err</span>());</code></pre></div>
|
||
</div></details></div></details><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><div id="impl-Debug" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#444-468" title="goto source code">[src]</a></div><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/1.59.0/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></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#445-467" title="goto source code">[src]</a></div><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Default" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#470-474" title="goto source code">[src]</a></div><a href="#impl-Default" class="anchor"></a><h3 class="code-header in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> <a class="trait" href="https://doc.rust-lang.org/1.59.0/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></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.default" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#471-473" title="goto source code">[src]</a></div><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">ShardedLock</a><T></h4></div></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#476-480" title="goto source code">[src]</a></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/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></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#477-479" title="goto source code">[src]</a></div><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> Self</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#88" title="goto source code">[src]</a></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/1.59.0/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></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#84" title="goto source code">[src]</a></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="https://doc.rust-lang.org/1.59.0/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></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#85" title="goto source code">[src]</a></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>> <a class="trait" href="https://doc.rust-lang.org/1.59.0/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></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/crossbeam_utils/sync/sharded_lock.rs.html#87" title="goto source code">[src]</a></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/1.59.0/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></div></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"><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/1.59.0/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> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></h3></div></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" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#132-136" title="goto source code">[src]</a></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#133" title="goto source code">[src]</a></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#209-214" title="goto source code">[src]</a></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#211" title="goto source code">[src]</a></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&</a>T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#218-222" title="goto source code">[src]</a></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#219" title="goto source code">[src]</a></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&mut </a>T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3C!%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#566-570" title="goto source code">[src]</a></div><a href="#impl-From%3C!%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.never.html">!</a>> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#567" title="goto source code">[src]</a></div><a href="#method.from-1" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.never.html">!</a>) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#550-554" title="goto source code">[src]</a></div><a href="#impl-From%3CT%3E-1" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from-2" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#551" title="goto source code">[src]</a></div><a href="#method.from-2" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#538-545" title="goto source code">[src]</a></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#542" title="goto source code">[src]</a></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#588-597" title="goto source code">[src]</a></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#594" title="goto source code">[src]</a></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.59.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.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#574-583" title="goto source code">[src]</a></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#580" title="goto source code">[src]</a></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.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.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section><section id="search" class="content hidden"></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.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |