forked from diesel-rs/diesel
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathstruct.RwLock.html
More file actions
192 lines (192 loc) · 66.9 KB
/
Copy pathstruct.RwLock.html
File metadata and controls
192 lines (192 loc) · 66.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<!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="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../lock_api/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../lock_api/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">RwLock</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.const_new">const_new</a></li><li><a href="#method.data_ptr">data_ptr</a></li><li><a href="#method.force_unlock_read">force_unlock_read</a></li><li><a href="#method.force_unlock_read_fair">force_unlock_read_fair</a></li><li><a href="#method.force_unlock_write">force_unlock_write</a></li><li><a href="#method.force_unlock_write_fair">force_unlock_write_fair</a></li><li><a href="#method.get_mut">get_mut</a></li><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.is_locked">is_locked</a></li><li><a href="#method.is_locked_exclusive">is_locked_exclusive</a></li><li><a href="#method.new">new</a></li><li><a href="#method.raw">raw</a></li><li><a href="#method.read">read</a></li><li><a href="#method.read_recursive">read_recursive</a></li><li><a href="#method.try_read">try_read</a></li><li><a href="#method.try_read_for">try_read_for</a></li><li><a href="#method.try_read_recursive">try_read_recursive</a></li><li><a href="#method.try_read_recursive_for">try_read_recursive_for</a></li><li><a href="#method.try_read_recursive_until">try_read_recursive_until</a></li><li><a href="#method.try_read_until">try_read_until</a></li><li><a href="#method.try_upgradable_read">try_upgradable_read</a></li><li><a href="#method.try_upgradable_read_for">try_upgradable_read_for</a></li><li><a href="#method.try_upgradable_read_until">try_upgradable_read_until</a></li><li><a href="#method.try_write">try_write</a></li><li><a href="#method.try_write_for">try_write_for</a></li><li><a href="#method.try_write_until">try_write_until</a></li><li><a href="#method.upgradable_read">upgradable_read</a></li><li><a href="#method.write">write</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-Debug">Debug</a></li><li><a href="#impl-Default">Default</a></li><li><a href="#impl-From%3CT%3E">From<T></a></li><li><a href="#impl-Send">Send</a></li><li><a href="#impl-Sync">Sync</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe">UnwindSafe</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><ul><li><a href="#impl-Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3C!%3E">From<!></a></li><li><a href="#impl-From%3CT%3E-1">From<T></a></li><li><a href="#impl-Into%3CU%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In lock_api</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../lock_api/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1">
<a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div>
</div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<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 item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/lock_api/rwlock.rs.html#330-333">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust struct"><code>pub struct RwLock<R, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A 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><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#367-394">source</a></span><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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#371-376">source</a></span><a href="#method.new" class="anchor"></a><h4 class="code-header">pub const 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></section></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><section id="method.into_inner" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#391-393">source</a></span><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></section></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><section id="impl-1" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#396-409">source</a></span><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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.const_new" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#403-408">source</a></span><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></section></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><section id="impl-2" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#411-663">source</a></span><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/nightly/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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#447-451">source</a></span><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></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="rustdoc-toggle method-toggle" open><summary><section id="method.try_read" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#461-468">source</a></span><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/nightly/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></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="rustdoc-toggle method-toggle" open><summary><section id="method.write" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#479-483">source</a></span><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></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="rustdoc-toggle method-toggle" open><summary><section id="method.try_write" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#493-500">source</a></span><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/nightly/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></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="rustdoc-toggle method-toggle" open><summary><section id="method.get_mut" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#507-509">source</a></span><a href="#method.get_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fnname">get_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&mut </a>T</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="rustdoc-toggle method-toggle" open><summary><section id="method.is_locked" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#513-515">source</a></span><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) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/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="rustdoc-toggle method-toggle" open><summary><section id="method.is_locked_exclusive" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#519-521">source</a></span><a href="#method.is_locked_exclusive" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.is_locked_exclusive" class="fnname">is_locked_exclusive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/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="rustdoc-toggle method-toggle" open><summary><section id="method.force_unlock_read" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#535-537">source</a></span><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></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"><a href="#safety">Safety</a></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="rustdoc-toggle method-toggle" open><summary><section id="method.force_unlock_write" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#551-553">source</a></span><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></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-1"><a href="#safety-1">Safety</a></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="rustdoc-toggle method-toggle" open><summary><section id="method.raw" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#565-567">source</a></span><a href="#method.raw" class="anchor"></a><h4 class="code-header">pub unsafe fn <a href="#method.raw" class="fnname">raw</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&</a>R</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-2"><a href="#safety-2">Safety</a></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="rustdoc-toggle method-toggle" open><summary><section id="method.data_ptr" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#582-584">source</a></span><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) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/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-3"><a href="#safety-3">Safety</a></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="rustdoc-toggle implementors-toggle" open><summary><section id="impl-3" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#665-697">source</a></span><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/nightly/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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.force_unlock_read_fair" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#678-680">source</a></span><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></section></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>
<h5 id="safety-4"><a href="#safety-4">Safety</a></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="rustdoc-toggle method-toggle" open><summary><section id="method.force_unlock_write_fair" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#694-696">source</a></span><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></section></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>
<h5 id="safety-5"><a href="#safety-5">Safety</a></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="rustdoc-toggle implementors-toggle" open><summary><section id="impl-4" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#699-835">source</a></span><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/nightly/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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_read_for" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#707-714">source</a></span><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="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/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></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="rustdoc-toggle method-toggle" open><summary><section id="method.try_read_until" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#723-730">source</a></span><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="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/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></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="rustdoc-toggle method-toggle" open><summary><section id="method.try_write_for" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#739-746">source</a></span><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="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/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></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="rustdoc-toggle method-toggle" open><summary><section id="method.try_write_until" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#755-762">source</a></span><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="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/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></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="rustdoc-toggle implementors-toggle" open><summary><section id="impl-5" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#837-906">source</a></span><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/nightly/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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_recursive" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#854-858">source</a></span><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></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="rustdoc-toggle method-toggle" open><summary><section id="method.try_read_recursive" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#871-878">source</a></span><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/nightly/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></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="rustdoc-toggle implementors-toggle" open><summary><section id="impl-6" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#908-986">source</a></span><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/nightly/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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_read_recursive_for" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#920-930">source</a></span><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="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/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></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="rustdoc-toggle method-toggle" open><summary><section id="method.try_read_recursive_until" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#939-949">source</a></span><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="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/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></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="rustdoc-toggle implementors-toggle" open><summary><section id="impl-7" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#988-1071">source</a></span><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/nightly/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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.upgradable_read" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1010-1014">source</a></span><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></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="rustdoc-toggle method-toggle" open><summary><section id="method.try_upgradable_read" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1024-1031">source</a></span><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/nightly/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></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="rustdoc-toggle implementors-toggle" open><summary><section id="impl-8" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1073-1147">source</a></span><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/nightly/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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_upgradable_read_for" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1081-1091">source</a></span><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="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/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></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="rustdoc-toggle method-toggle" open><summary><section id="method.try_upgradable_read_until" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1100-1110">source</a></span><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="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/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></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="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1163-1181">source</a></span><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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1164-1180">source</a></span><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1149-1154">source</a></span><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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1151-1153">source</a></span><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/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></section></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CT%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1156-1161">source</a></span><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/nightly/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></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#1158-1160">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/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></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
</div></details></div></details><section id="impl-Send" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#364">source</a></span><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/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/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></section><section id="impl-Sync" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#365">source</a></span><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/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/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></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe" class="impl has-srclink"><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl<R, T> !<a class="trait" href="https://doc.rust-lang.org/nightly/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><R, T></h3></section><section id="impl-Unpin" class="impl has-srclink"><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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></h3></section><section id="impl-UnwindSafe" class="impl has-srclink"><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl<R, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/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><R, T> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>, </span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#203">source</a></span><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#204">source</a></span><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#209">source</a></span><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/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218">source</a></span><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/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3C!%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574">source</a></span><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/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.never.html">!</a>> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#575">source</a></span><a href="#method.from-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.never.html">!</a>) -> T</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-1" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#557">source</a></span><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/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#559">source</a></span><a href="#method.from-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#541">source</a></span><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/nightly/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/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#549">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#598">source</a></span><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/nightly/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/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></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><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#604">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#583">source</a></span><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/nightly/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/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></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><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#589">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="lock_api" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0-nightly (495b21669 2022-07-03)" ></div>
</body></html>