mirror of
https://github.com/rust-embedded/heapless.git
synced 2025-10-02 06:50:32 +00:00
183 lines
62 KiB
HTML
183 lines
62 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 reader-writer lock"><meta name="keywords" content="rust, rustlang, rust-lang, RwLock"><title>RwLock in lock_api - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg"><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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 href='../lock_api/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Struct RwLock</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.const_new">const_new</a><a href="#method.data_ptr">data_ptr</a><a href="#method.force_unlock_read">force_unlock_read</a><a href="#method.force_unlock_read_fair">force_unlock_read_fair</a><a href="#method.force_unlock_write">force_unlock_write</a><a href="#method.force_unlock_write_fair">force_unlock_write_fair</a><a href="#method.get_mut">get_mut</a><a href="#method.into_inner">into_inner</a><a href="#method.is_locked">is_locked</a><a href="#method.new">new</a><a href="#method.raw">raw</a><a href="#method.read">read</a><a href="#method.read_recursive">read_recursive</a><a href="#method.try_read">try_read</a><a href="#method.try_read_for">try_read_for</a><a href="#method.try_read_recursive">try_read_recursive</a><a href="#method.try_read_recursive_for">try_read_recursive_for</a><a href="#method.try_read_recursive_until">try_read_recursive_until</a><a href="#method.try_read_until">try_read_until</a><a href="#method.try_upgradable_read">try_upgradable_read</a><a href="#method.try_upgradable_read_for">try_upgradable_read_for</a><a href="#method.try_upgradable_read_until">try_upgradable_read_until</a><a href="#method.try_write">try_write</a><a href="#method.try_write_for">try_write_for</a><a href="#method.try_write_until">try_write_until</a><a href="#method.upgradable_read">upgradable_read</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-Send">Send</a><a href="#impl-Sync">Sync</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">lock_api</a></h2><div id="sidebar-vars" data-name="RwLock" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><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><nav class="sub"><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" disabled 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><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">lock_api</a>::<wbr><a class="struct" href="#">RwLock</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></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/lock_api/rwlock.rs.html#318-321" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust struct">pub struct RwLock<R, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> { /* fields omitted */ }</pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A reader-writer lock</p>
|
||
<p>This type of lock allows a number of readers or at most one writer at any
|
||
point in time. The write portion of this lock typically allows modification
|
||
of the underlying data (exclusive access) and the read portion of this lock
|
||
typically allows for read-only access (shared access).</p>
|
||
<p>The type parameter <code>T</code> represents the data that this lock protects. It is
|
||
required that <code>T</code> satisfies <code>Send</code> to be shared across threads and <code>Sync</code> to
|
||
allow concurrent access through readers. The RAII guards returned from the
|
||
locking methods implement <code>Deref</code> (and <code>DerefMut</code> for the <code>write</code> methods)
|
||
to allow access to the contained of the lock.</p>
|
||
</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/lock_api/rwlock.rs.html#355-382" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, 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/lock_api/rwlock.rs.html#369-374" 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>(val: T) -> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h4></div></summary><div class="docblock"><p>Creates a new instance of an <code>RwLock<T></code> which is unlocked.</p>
|
||
</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/lock_api/rwlock.rs.html#379-381" 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) -> T</h4></div></summary><div class="docblock"><p>Consumes this <code>RwLock</code>, returning the underlying data.</p>
|
||
</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/lock_api/rwlock.rs.html#384-397" title="goto source code">[src]</a></div><a href="#impl-1" class="anchor"></a><h3 class="code-header in-band">impl<R, T> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.const_new" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#391-396" title="goto source code">[src]</a></div><a href="#method.const_new" class="anchor"></a><h4 class="code-header">pub const fn <a href="#method.const_new" class="fnname">const_new</a>(raw_rwlock: R, val: T) -> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h4></div></summary><div class="docblock"><p>Creates a new new instance of an <code>RwLock<T></code> based on a pre-existing
|
||
<code>RawRwLock<T></code>.</p>
|
||
<p>This allows creating a <code>RwLock<T></code> in a constant context on stable
|
||
Rust.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-2" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#399-645" title="goto source code">[src]</a></div><a href="#impl-2" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.read" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#435-439" 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="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><'_, R, T></h4></div></summary><div class="docblock"><p>Locks this <code>RwLock</code> 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.</p>
|
||
<p>Note that attempts to recursively acquire a read lock on a <code>RwLock</code> when
|
||
the current thread already holds one may result in a deadlock.</p>
|
||
<p>Returns an RAII guard which will release this thread’s shared access
|
||
once it is dropped.</p>
|
||
</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/lock_api/rwlock.rs.html#449-456" 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="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with shared read access.</p>
|
||
<p>If the access could not be granted at this time, then <code>None</code> is returned.
|
||
Otherwise, an RAII guard is returned which will release the shared access
|
||
when it is dropped.</p>
|
||
<p>This function does not block.</p>
|
||
</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/lock_api/rwlock.rs.html#467-471" 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="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><'_, R, T></h4></div></summary><div class="docblock"><p>Locks this <code>RwLock</code> with exclusive write access, blocking the current
|
||
thread until it can be acquired.</p>
|
||
<p>This function will not return while other writers or other readers
|
||
currently have access to the lock.</p>
|
||
<p>Returns an RAII guard which will drop the write access of this <code>RwLock</code>
|
||
when dropped.</p>
|
||
</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/lock_api/rwlock.rs.html#481-488" 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="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to lock this <code>RwLock</code> with exclusive write access.</p>
|
||
<p>If the lock could not be acquired at this time, then <code>None</code> is returned.
|
||
Otherwise, an RAII guard is returned which will release the lock when
|
||
it is dropped.</p>
|
||
<p>This function does not block.</p>
|
||
</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/lock_api/rwlock.rs.html#495-497" 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) -> &mut T</h4></div></summary><div class="docblock"><p>Returns a mutable reference to the underlying data.</p>
|
||
<p>Since this call borrows the <code>RwLock</code> mutably, no actual locking needs to
|
||
take place—the mutable borrow statically guarantees no locks exist.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.is_locked" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#501-503" title="goto source code">[src]</a></div><a href="#method.is_locked" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.is_locked" class="fnname">is_locked</a>(&self) -> bool</h4></div></summary><div class="docblock"><p>Checks whether this <code>RwLock</code> is currently locked in any way.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.force_unlock_read" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#517-519" title="goto source code">[src]</a></div><a href="#method.force_unlock_read" class="anchor"></a><h4 class="code-header">pub unsafe fn <a href="#method.force_unlock_read" class="fnname">force_unlock_read</a>(&self)</h4></div></summary><div class="docblock"><p>Forcibly unlocks a read lock.</p>
|
||
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
||
the need to maintain a <code>RwLockReadGuard</code> object alive, for example when
|
||
dealing with FFI.</p>
|
||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||
<p>This method must only be called if the current thread logically owns a
|
||
<code>RwLockReadGuard</code> but that guard has be discarded using <code>mem::forget</code>.
|
||
Behavior is undefined if a rwlock is read-unlocked when not read-locked.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.force_unlock_write" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#533-535" title="goto source code">[src]</a></div><a href="#method.force_unlock_write" class="anchor"></a><h4 class="code-header">pub unsafe fn <a href="#method.force_unlock_write" class="fnname">force_unlock_write</a>(&self)</h4></div></summary><div class="docblock"><p>Forcibly unlocks a write lock.</p>
|
||
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
||
the need to maintain a <code>RwLockWriteGuard</code> object alive, for example when
|
||
dealing with FFI.</p>
|
||
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
|
||
<p>This method must only be called if the current thread logically owns a
|
||
<code>RwLockWriteGuard</code> but that guard has be discarded using <code>mem::forget</code>.
|
||
Behavior is undefined if a rwlock is write-unlocked when not write-locked.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.raw" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#547-549" title="goto source code">[src]</a></div><a href="#method.raw" class="anchor"></a><h4 class="code-header">pub unsafe fn <a href="#method.raw" class="fnname">raw</a>(&self) -> &R</h4></div></summary><div class="docblock"><p>Returns the underlying raw reader-writer lock object.</p>
|
||
<p>Note that you will most likely need to import the <code>RawRwLock</code> trait from
|
||
<code>lock_api</code> to be able to call functions on the raw
|
||
reader-writer lock.</p>
|
||
<h1 id="safety-2" class="section-header"><a href="#safety-2">Safety</a></h1>
|
||
<p>This method is unsafe because it allows unlocking a mutex while
|
||
still holding a reference to a lock guard.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.data_ptr" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#564-566" title="goto source code">[src]</a></div><a href="#method.data_ptr" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.data_ptr" class="fnname">data_ptr</a>(&self) -> *mut T</h4></div></summary><div class="docblock"><p>Returns a raw pointer to the underlying data.</p>
|
||
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
||
the need to maintain a <code>RwLockReadGuard</code> or <code>RwLockWriteGuard</code> object
|
||
alive, for example when dealing with FFI.</p>
|
||
<h1 id="safety-3" class="section-header"><a href="#safety-3">Safety</a></h1>
|
||
<p>You must ensure that there are no data races when dereferencing the
|
||
returned pointer, for example if the current thread logically owns a
|
||
<code>RwLockReadGuard</code> or <code>RwLockWriteGuard</code> but that guard has been discarded
|
||
using <code>mem::forget</code>.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-3" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#647-679" title="goto source code">[src]</a></div><a href="#impl-3" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLockFair.html" title="trait lock_api::RawRwLockFair">RawRwLockFair</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.force_unlock_read_fair" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#660-662" title="goto source code">[src]</a></div><a href="#method.force_unlock_read_fair" class="anchor"></a><h4 class="code-header">pub unsafe fn <a href="#method.force_unlock_read_fair" class="fnname">force_unlock_read_fair</a>(&self)</h4></div></summary><div class="docblock"><p>Forcibly unlocks a read lock using a fair unlock procotol.</p>
|
||
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
||
the need to maintain a <code>RwLockReadGuard</code> object alive, for example when
|
||
dealing with FFI.</p>
|
||
<h1 id="safety-4" class="section-header"><a href="#safety-4">Safety</a></h1>
|
||
<p>This method must only be called if the current thread logically owns a
|
||
<code>RwLockReadGuard</code> but that guard has be discarded using <code>mem::forget</code>.
|
||
Behavior is undefined if a rwlock is read-unlocked when not read-locked.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.force_unlock_write_fair" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#676-678" title="goto source code">[src]</a></div><a href="#method.force_unlock_write_fair" class="anchor"></a><h4 class="code-header">pub unsafe fn <a href="#method.force_unlock_write_fair" class="fnname">force_unlock_write_fair</a>(&self)</h4></div></summary><div class="docblock"><p>Forcibly unlocks a write lock using a fair unlock procotol.</p>
|
||
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
||
the need to maintain a <code>RwLockWriteGuard</code> object alive, for example when
|
||
dealing with FFI.</p>
|
||
<h1 id="safety-5" class="section-header"><a href="#safety-5">Safety</a></h1>
|
||
<p>This method must only be called if the current thread logically owns a
|
||
<code>RwLockWriteGuard</code> but that guard has be discarded using <code>mem::forget</code>.
|
||
Behavior is undefined if a rwlock is write-unlocked when not write-locked.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-4" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#681-805" title="goto source code">[src]</a></div><a href="#impl-4" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLockTimed.html" title="trait lock_api::RawRwLockTimed">RawRwLockTimed</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_read_for" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#689-696" title="goto source code">[src]</a></div><a href="#method.try_read_for" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_read_for" class="fnname">try_read_for</a>(<br> &self, <br> timeout: R::<a class="type" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with shared read access until a timeout
|
||
is reached.</p>
|
||
<p>If the access could not be granted before the timeout expires, then
|
||
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
||
release the shared access when it is dropped.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_read_until" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#705-712" title="goto source code">[src]</a></div><a href="#method.try_read_until" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_read_until" class="fnname">try_read_until</a>(<br> &self, <br> timeout: R::<a class="type" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with shared read access until a timeout
|
||
is reached.</p>
|
||
<p>If the access could not be granted before the timeout expires, then
|
||
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
||
release the shared access when it is dropped.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_write_for" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#721-728" title="goto source code">[src]</a></div><a href="#method.try_write_for" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_write_for" class="fnname">try_write_for</a>(<br> &self, <br> timeout: R::<a class="type" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with exclusive write access until a
|
||
timeout is reached.</p>
|
||
<p>If the access could not be granted before the timeout expires, then
|
||
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
||
release the exclusive access when it is dropped.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_write_until" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#737-744" title="goto source code">[src]</a></div><a href="#method.try_write_until" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_write_until" class="fnname">try_write_until</a>(<br> &self, <br> timeout: R::<a class="type" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with exclusive write access until a
|
||
timeout is reached.</p>
|
||
<p>If the access could not be granted before the timeout expires, then
|
||
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
||
release the exclusive access when it is dropped.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-5" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#807-876" title="goto source code">[src]</a></div><a href="#impl-5" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLockRecursive.html" title="trait lock_api::RawRwLockRecursive">RawRwLockRecursive</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.read_recursive" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#824-828" title="goto source code">[src]</a></div><a href="#method.read_recursive" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.read_recursive" class="fnname">read_recursive</a>(&self) -> <a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><'_, R, T></h4></div></summary><div class="docblock"><p>Locks this <code>RwLock</code> 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.</p>
|
||
<p>Unlike <code>read</code>, this method is guaranteed to succeed without blocking if
|
||
another read lock is held at the time of the call. This allows a thread
|
||
to recursively lock a <code>RwLock</code>. However using this method can cause
|
||
writers to starve since readers no longer block if a writer is waiting
|
||
for the lock.</p>
|
||
<p>Returns an RAII guard which will release this thread’s shared access
|
||
once it is dropped.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_read_recursive" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#841-848" title="goto source code">[src]</a></div><a href="#method.try_read_recursive" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_read_recursive" class="fnname">try_read_recursive</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with shared read access.</p>
|
||
<p>If the access could not be granted at this time, then <code>None</code> is returned.
|
||
Otherwise, an RAII guard is returned which will release the shared access
|
||
when it is dropped.</p>
|
||
<p>This method is guaranteed to succeed if another read lock is held at the
|
||
time of the call. See the documentation for <code>read_recursive</code> for details.</p>
|
||
<p>This function does not block.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-6" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#878-950" title="goto source code">[src]</a></div><a href="#impl-6" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLockRecursiveTimed.html" title="trait lock_api::RawRwLockRecursiveTimed">RawRwLockRecursiveTimed</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_read_recursive_for" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#890-900" title="goto source code">[src]</a></div><a href="#method.try_read_recursive_for" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_read_recursive_for" class="fnname">try_read_recursive_for</a>(<br> &self, <br> timeout: R::<a class="type" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with shared read access until a timeout
|
||
is reached.</p>
|
||
<p>If the access could not be granted before the timeout expires, then
|
||
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
||
release the shared access when it is dropped.</p>
|
||
<p>This method is guaranteed to succeed without blocking if another read
|
||
lock is held at the time of the call. See the documentation for
|
||
<code>read_recursive</code> for details.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_read_recursive_until" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#909-919" title="goto source code">[src]</a></div><a href="#method.try_read_recursive_until" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_read_recursive_until" class="fnname">try_read_recursive_until</a>(<br> &self, <br> timeout: R::<a class="type" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with shared read access until a timeout
|
||
is reached.</p>
|
||
<p>If the access could not be granted before the timeout expires, then
|
||
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
||
release the shared access when it is dropped.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-7" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#952-1035" title="goto source code">[src]</a></div><a href="#impl-7" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLockUpgrade.html" title="trait lock_api::RawRwLockUpgrade">RawRwLockUpgrade</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.upgradable_read" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#974-978" title="goto source code">[src]</a></div><a href="#method.upgradable_read" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.upgradable_read" class="fnname">upgradable_read</a>(&self) -> <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'_, R, T></h4></div></summary><div class="docblock"><p>Locks this <code>RwLock</code> with upgradable 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 or other
|
||
upgradable reads which hold the lock. There may be other readers currently
|
||
inside the lock when this method returns.</p>
|
||
<p>Returns an RAII guard which will release this thread’s shared access
|
||
once it is dropped.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_upgradable_read" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#988-995" title="goto source code">[src]</a></div><a href="#method.try_upgradable_read" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_upgradable_read" class="fnname">try_upgradable_read</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with upgradable read access.</p>
|
||
<p>If the access could not be granted at this time, then <code>None</code> is returned.
|
||
Otherwise, an RAII guard is returned which will release the shared access
|
||
when it is dropped.</p>
|
||
<p>This function does not block.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-8" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1037-1111" title="goto source code">[src]</a></div><a href="#impl-8" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLockUpgradeTimed.html" title="trait lock_api::RawRwLockUpgradeTimed">RawRwLockUpgradeTimed</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_upgradable_read_for" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1045-1055" title="goto source code">[src]</a></div><a href="#method.try_upgradable_read_for" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_upgradable_read_for" class="fnname">try_upgradable_read_for</a>(<br> &self, <br> timeout: R::<a class="type" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with upgradable read access until a timeout
|
||
is reached.</p>
|
||
<p>If the access could not be granted before the timeout expires, then
|
||
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
||
release the shared access when it is dropped.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_upgradable_read_until" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1064-1074" title="goto source code">[src]</a></div><a href="#method.try_upgradable_read_until" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_upgradable_read_until" class="fnname">try_upgradable_read_until</a>(<br> &self, <br> timeout: R::<a class="type" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'_, R, T>></h4></div></summary><div class="docblock"><p>Attempts to acquire this <code>RwLock</code> with upgradable read access until a timeout
|
||
is reached.</p>
|
||
<p>If the access could not be granted before the timeout expires, then
|
||
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
||
release the shared access when it is dropped.</p>
|
||
</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/lock_api/rwlock.rs.html#1127-1145" title="goto source code">[src]</a></div><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, 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/lock_api/rwlock.rs.html#1128-1144" 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.55.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.55.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.55.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.55.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/lock_api/rwlock.rs.html#1113-1118" title="goto source code">[src]</a></div><a href="#impl-Default" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, 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/lock_api/rwlock.rs.html#1115-1117" 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.55.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h4></div></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.55.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/lock_api/rwlock.rs.html#1120-1125" title="goto source code">[src]</a></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T> <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, 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/lock_api/rwlock.rs.html#1122-1124" 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.55.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><div id="impl-Send" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#352" title="goto source code">[src]</a></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a> + <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#353" title="goto source code">[src]</a></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl<R: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a> + <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>> <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, 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<R, T: ?<a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,<br> T: <a class="trait" href="https://doc.rust-lang.org/1.55.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.55.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.55.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.55.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.55.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.55.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.55.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.55.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.55.0/src/core/borrow.rs.html#208-213" 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.55.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.55.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.55.0/src/core/borrow.rs.html#210" 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.55.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> &T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.55.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.55.0/src/core/borrow.rs.html#216-220" 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.55.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.55.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.55.0/src/core/borrow.rs.html#217" 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.55.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.55.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.55.0/src/core/convert/mod.rs.html#561-565" 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.55.0/core/convert/trait.From.html" title="trait core::convert::From">From</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.55.0/src/core/convert/mod.rs.html#562" 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.55.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(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-From%3CT%3E-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.55.0/src/core/convert/mod.rs.html#546-550" 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.55.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.55.0/src/core/convert/mod.rs.html#547" 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.55.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.55.0/src/core/convert/mod.rs.html#535-542" 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.55.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.55.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.55.0/src/core/convert/mod.rs.html#539" 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.55.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.55.0/src/core/convert/mod.rs.html#583-592" 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.55.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.55.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" 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.55.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.55.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.55.0/src/core/convert/mod.rs.html#589" 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.55.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.55.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.55.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/1.55.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.55.0/src/core/convert/mod.rs.html#569-578" 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.55.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.55.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-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.55.0/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/1.55.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.55.0/src/core/convert/mod.rs.html#575" 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.55.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.55.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.55.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/1.55.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 id="rustdoc-vars" data-root-path="../" data-current-crate="lock_api" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||
<script src="../main.js"></script>
|
||
</body></html> |