mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-12-25 19:39:32 +01:00
Code Issues Projects Releases Packages Wiki Activity
rtic/1/api/lock_api/struct.RwLock.html
korken89 d2b764a7c5 deploy: 1a1237690c
2024-12-06 13:35:18 +00:00

229 lines
No EOL
66 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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"><title>RwLock in lock_api - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="lock_api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../lock_api/index.html">lock_<wbr>api</a><span class="version">0.4.12</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">RwLock</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.const_new" title="const_new">const_new</a></li><li><a href="#method.data_ptr" title="data_ptr">data_ptr</a></li><li><a href="#method.force_unlock_read" title="force_unlock_read">force_unlock_read</a></li><li><a href="#method.force_unlock_read_fair" title="force_unlock_read_fair">force_unlock_read_fair</a></li><li><a href="#method.force_unlock_write" title="force_unlock_write">force_unlock_write</a></li><li><a href="#method.force_unlock_write_fair" title="force_unlock_write_fair">force_unlock_write_fair</a></li><li><a href="#method.from_raw" title="from_raw">from_raw</a></li><li><a href="#method.get_mut" title="get_mut">get_mut</a></li><li><a href="#method.into_inner" title="into_inner">into_inner</a></li><li><a href="#method.is_locked" title="is_locked">is_locked</a></li><li><a href="#method.is_locked_exclusive" title="is_locked_exclusive">is_locked_exclusive</a></li><li><a href="#method.make_read_guard_unchecked" title="make_read_guard_unchecked">make_read_guard_unchecked</a></li><li><a href="#method.make_upgradable_guard_unchecked" title="make_upgradable_guard_unchecked">make_upgradable_guard_unchecked</a></li><li><a href="#method.make_write_guard_unchecked" title="make_write_guard_unchecked">make_write_guard_unchecked</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.raw" title="raw">raw</a></li><li><a href="#method.read" title="read">read</a></li><li><a href="#method.read_recursive" title="read_recursive">read_recursive</a></li><li><a href="#method.try_read" title="try_read">try_read</a></li><li><a href="#method.try_read_for" title="try_read_for">try_read_for</a></li><li><a href="#method.try_read_recursive" title="try_read_recursive">try_read_recursive</a></li><li><a href="#method.try_read_recursive_for" title="try_read_recursive_for">try_read_recursive_for</a></li><li><a href="#method.try_read_recursive_until" title="try_read_recursive_until">try_read_recursive_until</a></li><li><a href="#method.try_read_until" title="try_read_until">try_read_until</a></li><li><a href="#method.try_upgradable_read" title="try_upgradable_read">try_upgradable_read</a></li><li><a href="#method.try_upgradable_read_for" title="try_upgradable_read_for">try_upgradable_read_for</a></li><li><a href="#method.try_upgradable_read_until" title="try_upgradable_read_until">try_upgradable_read_until</a></li><li><a href="#method.try_write" title="try_write">try_write</a></li><li><a href="#method.try_write_for" title="try_write_for">try_write_for</a></li><li><a href="#method.try_write_until" title="try_write_until">try_write_until</a></li><li><a href="#method.upgradable_read" title="upgradable_read">upgradable_read</a></li><li><a href="#method.write" title="write">write</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-RwLock%3CR,+T%3E" title="Debug">Debug</a></li><li><a href="#impl-Default-for-RwLock%3CR,+T%3E" title="Default">Default</a></li><li><a href="#impl-From%3CT%3E-for-RwLock%3CR,+T%3E" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Send-for-RwLock%3CR,+T%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-RwLock%3CR,+T%3E" title="Sync">Sync</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-RwLock%3CR,+T%3E" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-RwLock%3CR,+T%3E" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-RwLock%3CR,+T%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-RwLock%3CR,+T%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-From%3C!%3E-for-T" title="From&#60;!&#62;">From&#60;!&#62;</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate lock_<wbr>api</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">lock_api</a></span><h1>Struct <span class="struct">RwLock</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/lock_api/rwlock.rs.html#330-333">source</a> </span></div><pre class="rust item-decl"><code>pub struct RwLock&lt;R, T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A 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="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-RwLock%3CR,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#367-394">source</a><a href="#impl-RwLock%3CR,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;R: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#371-376">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>(val: T) -&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h4></section></summary><div class="docblock"><p>Creates a new instance of an <code>RwLock&lt;T&gt;</code> which is unlocked.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_inner" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#391-393">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fn">into_inner</a>(self) -&gt; T</h4></section></summary><div class="docblock"><p>Consumes this <code>RwLock</code>, returning the underlying data.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-RwLock%3CR,+T%3E-1" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#396-418">source</a><a href="#impl-RwLock%3CR,+T%3E-1" class="anchor">§</a><h3 class="code-header">impl&lt;R, T&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_raw" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#400-405">source</a><h4 class="code-header">pub const fn <a href="#method.from_raw" class="fn">from_raw</a>(raw_rwlock: R, val: T) -&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h4></section></summary><div class="docblock"><p>Creates a new new instance of an <code>RwLock&lt;T&gt;</code> based on a pre-existing
<code>RawRwLock&lt;T&gt;</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.const_new" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#415-417">source</a><h4 class="code-header">pub const fn <a href="#method.const_new" class="fn">const_new</a>(raw_rwlock: R, val: T) -&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h4></section></summary><div class="docblock"><p>Creates a new new instance of an <code>RwLock&lt;T&gt;</code> based on a pre-existing
<code>RawRwLock&lt;T&gt;</code>.</p>
<p>This allows creating a <code>RwLock&lt;T&gt;</code> in a constant context on stable
Rust.</p>
<p>This method is a legacy alias for <a href="struct.RwLock.html#method.from_raw" title="associated function lock_api::RwLock::from_raw"><code>from_raw</code></a>.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-RwLock%3CR,+T%3E-2" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#420-694">source</a><a href="#impl-RwLock%3CR,+T%3E-2" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.make_read_guard_unchecked" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#431-436">source</a><h4 class="code-header">pub unsafe fn <a href="#method.make_read_guard_unchecked" class="fn">make_read_guard_unchecked</a>(&amp;self) -&gt; <a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a>&lt;'_, R, T&gt;</h4></section></summary><div class="docblock"><p>Creates a new <code>RwLockReadGuard</code> without checking if the lock is held.</p>
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
<p>This method must only be called if the thread logically holds a read lock.</p>
<p>This function does not increment the read count of the lock. Calling this function when a
guard has already been produced is undefined behaviour unless the guard was forgotten
with <code>mem::forget</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.make_write_guard_unchecked" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#447-452">source</a><h4 class="code-header">pub unsafe fn <a href="#method.make_write_guard_unchecked" class="fn">make_write_guard_unchecked</a>(&amp;self) -&gt; <a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a>&lt;'_, R, T&gt;</h4></section></summary><div class="docblock"><p>Creates a new <code>RwLockReadGuard</code> without checking if the lock is held.</p>
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
<p>This method must only be called if the thread logically holds a write lock.</p>
<p>Calling this function when a guard has already been produced is undefined behaviour unless
the guard was forgotten with <code>mem::forget</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.read" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#467-471">source</a><h4 class="code-header">pub fn <a href="#method.read" class="fn">read</a>(&amp;self) -&gt; <a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a>&lt;'_, R, T&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.try_read" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#481-488">source</a><h4 class="code-header">pub fn <a href="#method.try_read" class="fn">try_read</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.write" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#499-503">source</a><h4 class="code-header">pub fn <a href="#method.write" class="fn">write</a>(&amp;self) -&gt; <a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a>&lt;'_, R, T&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.try_write" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#513-520">source</a><h4 class="code-header">pub fn <a href="#method.try_write" class="fn">try_write</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#527-529">source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fn">get_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the underlying data.</p>
<p>Since this call borrows the <code>RwLock</code> mutably, no actual locking needs to
take place—the mutable borrow statically guarantees no locks exist.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_locked" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#533-535">source</a><h4 class="code-header">pub fn <a href="#method.is_locked" class="fn">is_locked</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks whether this <code>RwLock</code> is currently locked in any way.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_locked_exclusive" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#539-541">source</a><h4 class="code-header">pub fn <a href="#method.is_locked_exclusive" class="fn">is_locked_exclusive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Check if this <code>RwLock</code> is currently exclusively locked.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.force_unlock_read" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#555-557">source</a><h4 class="code-header">pub unsafe fn <a href="#method.force_unlock_read" class="fn">force_unlock_read</a>(&amp;self)</h4></section></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>
<h5 id="safety-2"><a class="doc-anchor" href="#safety-2">§</a>Safety</h5>
<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="toggle method-toggle" open><summary><section id="method.force_unlock_write" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#571-573">source</a><h4 class="code-header">pub unsafe fn <a href="#method.force_unlock_write" class="fn">force_unlock_write</a>(&amp;self)</h4></section></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>
<h5 id="safety-3"><a class="doc-anchor" href="#safety-3">§</a>Safety</h5>
<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="toggle method-toggle" open><summary><section id="method.raw" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#585-587">source</a><h4 class="code-header">pub unsafe fn <a href="#method.raw" class="fn">raw</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;R</a></h4></section></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>
<h5 id="safety-4"><a class="doc-anchor" href="#safety-4">§</a>Safety</h5>
<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="toggle method-toggle" open><summary><section id="method.data_ptr" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#602-604">source</a><h4 class="code-header">pub fn <a href="#method.data_ptr" class="fn">data_ptr</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.pointer.html">*mut T</a></h4></section></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>
<h5 id="safety-5"><a class="doc-anchor" href="#safety-5">§</a>Safety</h5>
<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="toggle implementors-toggle" open><summary><section id="impl-RwLock%3CR,+T%3E-3" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#696-728">source</a><a href="#impl-RwLock%3CR,+T%3E-3" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.force_unlock_read_fair" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#709-711">source</a><h4 class="code-header">pub unsafe fn <a href="#method.force_unlock_read_fair" class="fn">force_unlock_read_fair</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Forcibly unlocks a read lock using a fair unlock protocol.</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>
<h5 id="safety-6"><a class="doc-anchor" href="#safety-6">§</a>Safety</h5>
<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="toggle method-toggle" open><summary><section id="method.force_unlock_write_fair" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#725-727">source</a><h4 class="code-header">pub unsafe fn <a href="#method.force_unlock_write_fair" class="fn">force_unlock_write_fair</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Forcibly unlocks a write lock using a fair unlock protocol.</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>
<h5 id="safety-7"><a class="doc-anchor" href="#safety-7">§</a>Safety</h5>
<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="toggle implementors-toggle" open><summary><section id="impl-RwLock%3CR,+T%3E-4" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#730-866">source</a><a href="#impl-RwLock%3CR,+T%3E-4" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.try_read_for" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#738-745">source</a><h4 class="code-header">pub fn <a href="#method.try_read_for" class="fn">try_read_for</a>(
&amp;self,
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.try_read_until" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#754-761">source</a><h4 class="code-header">pub fn <a href="#method.try_read_until" class="fn">try_read_until</a>(
&amp;self,
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.try_write_for" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#770-777">source</a><h4 class="code-header">pub fn <a href="#method.try_write_for" class="fn">try_write_for</a>(
&amp;self,
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.try_write_until" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#786-793">source</a><h4 class="code-header">pub fn <a href="#method.try_write_until" class="fn">try_write_until</a>(
&amp;self,
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle implementors-toggle" open><summary><section id="impl-RwLock%3CR,+T%3E-5" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#868-937">source</a><a href="#impl-RwLock%3CR,+T%3E-5" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.read_recursive" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#885-889">source</a><h4 class="code-header">pub fn <a href="#method.read_recursive" class="fn">read_recursive</a>(&amp;self) -&gt; <a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a>&lt;'_, R, T&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.try_read_recursive" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#902-909">source</a><h4 class="code-header">pub fn <a href="#method.try_read_recursive" class="fn">try_read_recursive</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle implementors-toggle" open><summary><section id="impl-RwLock%3CR,+T%3E-6" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#939-1017">source</a><a href="#impl-RwLock%3CR,+T%3E-6" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.try_read_recursive_for" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#951-961">source</a><h4 class="code-header">pub fn <a href="#method.try_read_recursive_for" class="fn">try_read_recursive_for</a>(
&amp;self,
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.try_read_recursive_until" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#970-980">source</a><h4 class="code-header">pub fn <a href="#method.try_read_recursive_until" class="fn">try_read_recursive_until</a>(
&amp;self,
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle implementors-toggle" open><summary><section id="impl-RwLock%3CR,+T%3E-7" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1019-1116">source</a><a href="#impl-RwLock%3CR,+T%3E-7" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.make_upgradable_guard_unchecked" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1030-1035">source</a><h4 class="code-header">pub unsafe fn <a href="#method.make_upgradable_guard_unchecked" class="fn">make_upgradable_guard_unchecked</a>(
&amp;self,
) -&gt; <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a>&lt;'_, R, T&gt;</h4></section></summary><div class="docblock"><p>Creates a new <code>RwLockUpgradableReadGuard</code> without checking if the lock is held.</p>
<h5 id="safety-8"><a class="doc-anchor" href="#safety-8">§</a>Safety</h5>
<p>This method must only be called if the thread logically holds an upgradable read lock.</p>
<p>This function does not increment the read count of the lock. Calling this function when a
guard has already been produced is undefined behaviour unless the guard was forgotten
with <code>mem::forget</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.upgradable_read" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1047-1051">source</a><h4 class="code-header">pub fn <a href="#method.upgradable_read" class="fn">upgradable_read</a>(&amp;self) -&gt; <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a>&lt;'_, R, T&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.try_upgradable_read" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1061-1068">source</a><h4 class="code-header">pub fn <a href="#method.try_upgradable_read" class="fn">try_upgradable_read</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle implementors-toggle" open><summary><section id="impl-RwLock%3CR,+T%3E-8" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1118-1192">source</a><a href="#impl-RwLock%3CR,+T%3E-8" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.try_upgradable_read_for" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1126-1136">source</a><h4 class="code-header">pub fn <a href="#method.try_upgradable_read_for" class="fn">try_upgradable_read_for</a>(
&amp;self,
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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="toggle method-toggle" open><summary><section id="method.try_upgradable_read_until" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1145-1155">source</a><h4 class="code-header">pub fn <a href="#method.try_upgradable_read_until" class="fn">try_upgradable_read_until</a>(
&amp;self,
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a>&lt;'_, R, T&gt;&gt;</h4></section></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></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-RwLock%3CR,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1208-1220">source</a><a href="#impl-Debug-for-RwLock%3CR,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1209-1219">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.83.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-RwLock%3CR,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1194-1199">source</a><a href="#impl-Default-for-RwLock%3CR,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1196-1198">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CT%3E-for-RwLock%3CR,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1201-1206">source</a><a href="#impl-From%3CT%3E-for-RwLock%3CR,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;R: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1203-1205">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><section id="impl-Send-for-RwLock%3CR,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#364">source</a><a href="#impl-Send-for-RwLock%3CR,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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>&lt;R, T&gt;</h3></section><section id="impl-Sync-for-RwLock%3CR,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#365">source</a><a href="#impl-Sync-for-RwLock%3CR,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;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.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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>&lt;R, T&gt;</h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-RwLock%3CR,+T%3E" class="impl"><a href="#impl-Freeze-for-RwLock%3CR,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;R, T&gt; !<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section><section id="impl-RefUnwindSafe-for-RwLock%3CR,+T%3E" class="impl"><a href="#impl-RefUnwindSafe-for-RwLock%3CR,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;R, T&gt; !<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;</h3></section><section id="impl-Unpin-for-RwLock%3CR,+T%3E" class="impl"><a href="#impl-Unpin-for-RwLock%3CR,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;R, T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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>&lt;R, T&gt;<div class="where">where
R: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section><section id="impl-UnwindSafe-for-RwLock%3CR,+T%3E" class="impl"><a href="#impl-UnwindSafe-for-RwLock%3CR,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;R, T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a>&lt;R, T&gt;<div class="where">where
R: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/any.rs.html#138">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/any.rs.html#139">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#209">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#211">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#217">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#218">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3C!%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#782">source</a><a href="#impl-From%3C!%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.never.html">!</a>&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#783">source</a><a href="#method.from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.never.html">!</a>) -&gt; T</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#809">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#794">source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink