bstein/rusty_snek_gaem
1
0
Fork 0
mirror of https://github.com/neogeek23/rusty_snek_gaem.git synced 2026-02-04 11:08:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
rusty_snek_gaem/target/doc/parking_lot/struct.RawRwLock.html

44 lines
38 KiB
HTML
Raw Normal View History

first commit
2018-10-28 21:14:05 -05:00
<!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="API documentation for the Rust `RawRwLock` struct in crate `parking_lot`."><meta name="keywords" content="rust, rustlang, rust-lang, RawRwLock"><title>parking_lot::RawRwLock - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><p class='location'>Struct RawRwLock</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-RawRwLockTrait">RawRwLockTrait</a><a href="#impl-RawRwLockFair">RawRwLockFair</a><a href="#impl-RawRwLockDowngrade">RawRwLockDowngrade</a><a href="#impl-RawRwLockTimed">RawRwLockTimed</a><a href="#impl-RawRwLockRecursive">RawRwLockRecursive</a><a href="#impl-RawRwLockRecursiveTimed">RawRwLockRecursiveTimed</a><a href="#impl-RawRwLockUpgrade">RawRwLockUpgrade</a><a href="#impl-RawRwLockUpgradeFair">RawRwLockUpgradeFair</a><a href="#impl-RawRwLockUpgradeDowngrade">RawRwLockUpgradeDowngrade</a><a href="#impl-RawRwLockUpgradeTimed">RawRwLockUpgradeTimed</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>parking_lot</a></p><script>window.sidebarCurrent = {name: 'RawRwLock', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>parking_lot</a>::<wbr><a class="struct" href=''>RawRwLock</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#41-43' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct RawRwLock { /* fields omitted */ }</pre></div><div class='docblock'><p>Raw reader-writer lock type backed by the parking lot.</p>
</div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-RawRwLockTrait' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../lock_api/rwlock/trait.RawRwLock.html" title="trait lock_api::rwlock::RawRwLock">RawRwLockTrait</a> for <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-RawRwLockTrait' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#45-146' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedconstant.INIT' class="associatedconstant"><span id='INIT.v' class='invisible'><code>const <a href='../lock_api/rwlock/trait.RawRwLock.html#associatedconstant.INIT' class="constant"><b>INIT</b></a>: <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code></span></h4>
<div class='docblock'><pre class="rust ">
<span class="ident">INIT</span>: <span class="ident">RawRwLock</span> <span class="op">=</span> <span class="ident">RawRwLock</span>{<span class="ident">state</span>: <span class="ident">ATOMIC_USIZE_INIT</span>,}</pre>
<p>Initial value for an unlocked <code>RwLock</code>.</p>
</div><h4 id='associatedtype.GuardMarker' class="type"><span id='GuardMarker.t' class='invisible'><code>type <a href='../lock_api/rwlock/trait.RawRwLock.html#associatedtype.GuardMarker' class="type">GuardMarker</a> = <a class="struct" href="../lock_api/struct.GuardNoSend.html" title="struct lock_api::GuardNoSend">GuardNoSend</a></code></span></h4>
<div class='docblock'><p>Marker type which determines whether a lock guard should be <code>Send</code>. Use one of the <code>GuardSend</code> or <code>GuardNoSend</code> helper types here. <a href="../lock_api/rwlock/trait.RawRwLock.html#associatedtype.GuardMarker">Read more</a></p>
</div><h4 id='method.lock_exclusive' class="method"><span id='lock_exclusive.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLock.html#tymethod.lock_exclusive' class='fnname'>lock_exclusive</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#53-63' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Acquires an exclusive lock, blocking the current thread until it is able to do so.</p>
</div><h4 id='method.try_lock_exclusive' class="method"><span id='try_lock_exclusive.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLock.html#tymethod.try_lock_exclusive' class='fnname'>try_lock_exclusive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#66-77' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire an exclusive lock without blocking.</p>
</div><h4 id='method.unlock_exclusive' class="method"><span id='unlock_exclusive.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLock.html#tymethod.unlock_exclusive' class='fnname'>unlock_exclusive</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#80-90' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Releases an exclusive lock.</p>
</div><h4 id='method.lock_shared' class="method"><span id='lock_shared.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLock.html#tymethod.lock_shared' class='fnname'>lock_shared</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#93-99' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Acquires a shared lock, blocking the current thread until it is able to do so.</p>
</div><h4 id='method.try_lock_shared' class="method"><span id='try_lock_shared.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLock.html#tymethod.try_lock_shared' class='fnname'>try_lock_shared</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#102-112' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire a shared lock without blocking.</p>
</div><h4 id='method.unlock_shared' class="method"><span id='unlock_shared.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLock.html#tymethod.unlock_shared' class='fnname'>unlock_shared</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#115-145' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Releases a shared lock.</p>
</div></div><h3 id='impl-RawRwLockFair' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../lock_api/rwlock/trait.RawRwLockFair.html" title="trait lock_api::rwlock::RawRwLockFair">RawRwLockFair</a> for <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-RawRwLockFair' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#148-208' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.unlock_shared_fair' class="method"><span id='unlock_shared_fair.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockFair.html#tymethod.unlock_shared_fair' class='fnname'>unlock_shared_fair</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#150-180' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Releases a shared lock using a fair unlock protocol.</p>
</div><h4 id='method.unlock_exclusive_fair' class="method"><span id='unlock_exclusive_fair.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockFair.html#tymethod.unlock_exclusive_fair' class='fnname'>unlock_exclusive_fair</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#183-193' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Releases an exclusive lock using a fair unlock protocol.</p>
</div><h4 id='method.bump_shared' class="method"><span id='bump_shared.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockFair.html#method.bump_shared' class='fnname'>bump_shared</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#196-200' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Temporarily yields a shared lock to a waiting thread if there is one. <a href="../lock_api/rwlock/trait.RawRwLockFair.html#method.bump_shared">Read more</a></p>
</div><h4 id='method.bump_exclusive' class="method"><span id='bump_exclusive.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockFair.html#method.bump_exclusive' class='fnname'>bump_exclusive</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#203-207' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Temporarily yields an exclusive lock to a waiting thread if there is one. <a href="../lock_api/rwlock/trait.RawRwLockFair.html#method.bump_exclusive">Read more</a></p>
</div></div><h3 id='impl-RawRwLockDowngrade' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../lock_api/rwlock/trait.RawRwLockDowngrade.html" title="trait lock_api::rwlock::RawRwLockDowngrade">RawRwLockDowngrade</a> for <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-RawRwLockDowngrade' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#210-222' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.downgrade' class="method"><span id='downgrade.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockDowngrade.html#tymethod.downgrade' class='fnname'>downgrade</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#212-221' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Atomically downgrades an exclusive lock into a shared lock without allowing any thread to take an exclusive lock in the meantime. <a href="../lock_api/rwlock/trait.RawRwLockDowngrade.html#tymethod.downgrade">Read more</a></p>
</div></div><h3 id='impl-RawRwLockTimed' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../lock_api/rwlock/trait.RawRwLockTimed.html" title="trait lock_api::rwlock::RawRwLockTimed">RawRwLockTimed</a> for <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-RawRwLockTimed' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#224-287' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Duration' class="type"><span id='Duration.t' class='invisible'><code>type <a href='../lock_api/rwlock/trait.RawRwLockTimed.html#associatedtype.Duration' class="type">Duration</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a></code></span></h4>
<div class='docblock'><p>Duration type used for <code>try_lock_for</code>.</p>
</div><h4 id='associatedtype.Instant' class="type"><span id='Instant.t' class='invisible'><code>type <a href='../lock_api/rwlock/trait.RawRwLockTimed.html#associatedtype.Instant' class="type">Instant</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a></code></span></h4>
<div class='docblock'><p>Instant type used for <code>try_lock_until</code>.</p>
</div><h4 id='method.try_lock_shared_for' class="method"><span id='try_lock_shared_for.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockTimed.html#tymethod.try_lock_shared_for' class='fnname'>try_lock_shared_for</a>(&amp;self, timeout: Self::<a class="type" href="../lock_api/rwlock/trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::rwlock::RawRwLockTimed::Duration">Duration</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#229-239' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire a shared lock until a timeout is reached.</p>
</div><h4 id='method.try_lock_shared_until' class="method"><span id='try_lock_shared_until.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockTimed.html#tymethod.try_lock_shared_until' class='fnname'>try_lock_shared_until</a>(&amp;self, timeout: Self::<a class="type" href="../lock_api/rwlock/trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::rwlock::RawRwLockTimed::Instant">Instant</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#242-252' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire a shared lock until a timeout is reached.</p>
</div><h4 id='method.try_lock_exclusive_for' class="method"><span id='try_lock_exclusive_for.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockTimed.html#tymethod.try_lock_exclusive_for' class='fnname'>try_lock_exclusive_for</a>(&amp;self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#255-269' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire an exclusive lock until a timeout is reached.</p>
</div><h4 id='method.try_lock_exclusive_until' class="method"><span id='try_lock_exclusive_until.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockTimed.html#tymethod.try_lock_exclusive_until' class='fnname'>try_lock_exclusive_until</a>(&amp;self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#272-286' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire an exclusive lock until a timeout is reached.</p>
</div></div><h3 id='impl-RawRwLockRecursive' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../lock_api/rwlock/trait.RawRwLockRecursive.html" title="trait lock_api::rwlock::RawRwLockRecursive">RawRwLockRecursive</a> for <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-RawRwLockRecursive' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#289-311' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.lock_shared_recursive' class="method"><span id='lock_shared_recursive.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockRecursive.html#tymethod.lock_shared_recursive' class='fnname'>lock_shared_recursive</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#291-297' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Acquires a shared lock without deadlocking in case of a recursive lock.</p>
</div><h4 id='method.try_lock_shared_recursive' class="method"><span id='try_lock_shared_recursive.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockRecursive.html#tymethod.try_lock_shared_recursive' class='fnname'>try_lock_shared_recursive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#300-310' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire a shared lock without deadlocking in case of a recursive lock.</p>
</div></div><h3 id='impl-RawRwLockRecursiveTimed' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../lock_api/rwlock/trait.RawRwLockRecursiveTimed.html" title="trait lock_api::rwlock::RawRwLockRecursiveTimed">RawRwLockRecursiveTimed</a> for <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-RawRwLockRecursiveTimed' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#313-339' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.try_lock_shared_recursive_for' class="method"><span id='try_lock_shared_recursive_for.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockRecursiveTimed.html#tymethod.try_lock_shared_recursive_for' class='fnname'>try_lock_shared_recursive_for</a>(&amp;self, timeout: Self::<a class="type" href="../lock_api/rwlock/trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::rwlock::RawRwLockTimed::Duration">Duration</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#315-325' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire a shared lock until a timeout is reached, without deadlocking in case of a recursive lock. <a href="../lock_api/rwlock/trait.RawRwLockRecursiveTimed.html#tymethod.try_lock_shared_recursive_for">Read more</a></p>
</div><h4 id='method.try_lock_shared_recursive_until' class="method"><span id='try_lock_shared_recursive_until.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockRecursiveTimed.html#tymethod.try_lock_shared_recursive_until' class='fnname'>try_lock_shared_recursive_until</a>(&amp;self, timeout: Self::<a class="type" href="../lock_api/rwlock/trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::rwlock::RawRwLockTimed::Instant">Instant</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#328-338' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire a shared lock until a timeout is reached, without deadlocking in case of a recursive lock. <a href="../lock_api/rwlock/trait.RawRwLockRecursiveTimed.html#tymethod.try_lock_shared_recursive_until">Read more</a></p>
</div></div><h3 id='impl-RawRwLockUpgrade' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../lock_api/rwlock/trait.RawRwLockUpgrade.html" title="trait lock_api::rwlock::RawRwLockUpgrade">RawRwLockUpgrade</a> for <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-RawRwLockUpgrade' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#341-410' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.lock_upgradable' class="method"><span id='lock_upgradable.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgrade.html#tymethod.lock_upgradable' class='fnname'>lock_upgradable</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#343-349' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Acquires an upgradable lock, blocking the current thread until it is able to do so.</p>
</div><h4 id='method.try_lock_upgradable' class="method"><span id='try_lock_upgradable.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgrade.html#tymethod.try_lock_upgradable' class='fnname'>try_lock_upgradable</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#352-362' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire an upgradable lock without blocking.</p>
</div><h4 id='method.unlock_upgradable' class="method"><span id='unlock_upgradable.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgrade.html#tymethod.unlock_upgradable' class='fnname'>unlock_upgradable</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#365-375' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Releases an upgradable lock.</p>
</div><h4 id='method.upgrade' class="method"><span id='upgrade.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgrade.html#tymethod.upgrade' class='fnname'>upgrade</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#378-392' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Upgrades an upgradable lock to an exclusive lock.</p>
</div><h4 id='method.try_upgrade' class="method"><span id='try_upgrade.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgrade.html#tymethod.try_upgrade' class='fnname'>try_upgrade</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#394-409' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to upgrade an upgradable lock to an exclusive lock without blocking. <a href="../lock_api/rwlock/trait.RawRwLockUpgrade.html#tymethod.try_upgrade">Read more</a></p>
</div></div><h3 id='impl-RawRwLockUpgradeFair' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../lock_api/rwlock/trait.RawRwLockUpgradeFair.html" title="trait lock_api::rwlock::RawRwLockUpgradeFair">RawRwLockUpgradeFair</a> for <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-RawRwLockUpgradeFair' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#412-432' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.unlock_upgradable_fair' class="method"><span id='unlock_upgradable_fair.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgradeFair.html#tymethod.unlock_upgradable_fair' class='fnname'>unlock_upgradable_fair</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#414-424' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Releases an upgradable lock using a fair unlock protocol.</p>
</div><h4 id='method.bump_upgradable' class="method"><span id='bump_upgradable.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgradeFair.html#method.bump_upgradable' class='fnname'>bump_upgradable</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#427-431' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Temporarily yields an upgradable lock to a waiting thread if there is one. <a href="../lock_api/rwlock/trait.RawRwLockUpgradeFair.html#method.bump_upgradable">Read more</a></p>
</div></div><h3 id='impl-RawRwLockUpgradeDowngrade' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../lock_api/rwlock/trait.RawRwLockUpgradeDowngrade.html" title="trait lock_api::rwlock::RawRwLockUpgradeDowngrade">RawRwLockUpgradeDowngrade</a> for <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-RawRwLockUpgradeDowngrade' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#434-458' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.downgrade_upgradable' class="method"><span id='downgrade_upgradable.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgradeDowngrade.html#tymethod.downgrade_upgradable' class='fnname'>downgrade_upgradable</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#436-445' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Downgrades an upgradable lock to a shared lock.</p>
</div><h4 id='method.downgrade_to_upgradable' class="method"><span id='downgrade_to_upgradable.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgradeDowngrade.html#tymethod.downgrade_to_upgradable' class='fnname'>downgrade_to_upgradable</a>(&amp;self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#448-457' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Downgrades an exclusive lock to an upgradable lock.</p>
</div></div><h3 id='impl-RawRwLockUpgradeTimed' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../lock_api/rwlock/trait.RawRwLockUpgradeTimed.html" title="trait lock_api::rwlock::RawRwLockUpgradeTimed">RawRwLockUpgradeTimed</a> for <a class="struct" href="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-RawRwLockUpgradeTimed' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#460-522' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.try_lock_upgradable_until' class="method"><span id='try_lock_upgradable_until.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgradeTimed.html#tymethod.try_lock_upgradable_until' class='fnname'>try_lock_upgradable_until</a>(&amp;self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#462-472' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire an upgradable lock until a timeout is reached.</p>
</div><h4 id='method.try_lock_upgradable_for' class="method"><span id='try_lock_upgradable_for.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgradeTimed.html#tymethod.try_lock_upgradable_for' class='fnname'>try_lock_upgradable_for</a>(&amp;self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#475-485' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to acquire an upgradable lock until a timeout is reached.</p>
</div><h4 id='method.try_upgrade_until' class="method"><span id='try_upgrade_until.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgradeTimed.html#tymethod.try_upgrade_until' class='fnname'>try_upgrade_until</a>(&amp;self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#488-503' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to upgrade an upgradable lock to an exclusive lock until a timeout is reached. <a href="../lock_api/rwlock/trait.RawRwLockUpgradeTimed.html#tymethod.try_upgrade_until">Read more</a></p>
</div><h4 id='method.try_upgrade_for' class="method"><span id='try_upgrade_for.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../lock_api/rwlock/trait.RawRwLockUpgradeTimed.html#tymethod.try_upgrade_for' class='fnname'>try_upgrade_for</a>(&amp;self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/parking_lot/raw_rwlock.rs.html#506-521' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to upgrade an upgradable lock to an exclusive lock until a timeout is reached. <a href="../lock_api/rwlock/trait.RawRwLockUpgradeTimed.html#tymethod.try_upgrade_for">Read more</a></p>
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <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="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <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="../parking_lot/struct.RawRwLock.html" title="struct parking_lot::RawRwLock">RawRwLock</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "parking_lot";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
Reference in New Issue Copy Permalink