mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 15:04:32 +01:00
110 lines
48 KiB
HTML
110 lines
48 KiB
HTML
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="RAII structure used to release the upgradable read access of a lock when dropped."><title>RwLockUpgradableReadGuard in lock_api - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="lock_api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../lock_api/index.html">lock_<wbr>api</a><span class="version">0.4.12</span></h2></div><h2 class="location"><a href="#">RwLock<wbr>Upgradable<wbr>Read<wbr>Guard</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.bump">bump</a></li><li><a href="#method.downgrade">downgrade</a></li><li><a href="#method.rwlock">rwlock</a></li><li><a href="#method.try_upgrade">try_upgrade</a></li><li><a href="#method.try_upgrade_for">try_upgrade_for</a></li><li><a href="#method.try_upgrade_until">try_upgrade_until</a></li><li><a href="#method.try_with_upgraded">try_with_upgraded</a></li><li><a href="#method.try_with_upgraded_for">try_with_upgraded_for</a></li><li><a href="#method.try_with_upgraded_until">try_with_upgraded_until</a></li><li><a href="#method.unlock_fair">unlock_fair</a></li><li><a href="#method.unlocked">unlocked</a></li><li><a href="#method.unlocked_fair">unlocked_fair</a></li><li><a href="#method.upgrade">upgrade</a></li><li><a href="#method.with_upgraded">with_upgraded</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E">Debug</a></li><li><a href="#impl-Deref-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E">Deref</a></li><li><a href="#impl-Display-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E">Display</a></li><li><a href="#impl-Drop-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E">Drop</a></li><li><a href="#impl-Sync-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E">Sync</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E">Freeze</a></li><li><a href="
|
|||
|
|
dropped.</p>
|
|||
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1918-1972">source</a><a href="#impl-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, R: <a class="trait" href="trait.RawRwLockUpgrade.html" title="trait lock_api::RawRwLockUpgrade">RawRwLockUpgrade</a> + 'a, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a> <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.rwlock" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1920-1922">source</a><h4 class="code-header">pub fn <a href="#method.rwlock" class="fn">rwlock</a>(s: &Self) -> &'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 a reference to the original reader-writer lock object.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.unlocked" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1929-1939">source</a><h4 class="code-header">pub fn <a href="#method.unlocked" class="fn">unlocked</a><F, U>(s: &mut Self, f: F) -> U<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> U,</div></h4></section></summary><div class="docblock"><p>Temporarily unlocks the <code>RwLock</code> to execute the given function.</p>
|
|||
|
|
<p>This is safe because <code>&mut</code> guarantees that there exist no other
|
|||
|
|
references to the data protected by the <code>RwLock</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.upgrade" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1943-1954">source</a><h4 class="code-header">pub fn <a href="#method.upgrade" class="fn">upgrade</a>(s: Self) -> <a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><'a, R, T></h4></section></summary><div class="docblock"><p>Atomically upgrades an upgradable read lock lock into an exclusive write lock,
|
|||
|
|
blocking the current thread until it can be acquired.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_upgrade" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1959-1971">source</a><h4 class="code-header">pub fn <a href="#method.try_upgrade" class="fn">try_upgrade</a>(s: Self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><'a, R, T>, Self></h4></section></summary><div class="docblock"><p>Tries to atomically upgrade an upgradable read lock into an exclusive write lock.</p>
|
|||
|
|
<p>If the access could not be granted at this time, then the current guard is returned.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-RwLockUpgradableReadGuard%3C'a,+R,+T%3E-1" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1974-2027">source</a><a href="#impl-RwLockUpgradableReadGuard%3C'a,+R,+T%3E-1" class="anchor">§</a><h3 class="code-header">impl<'a, R: <a class="trait" href="trait.RawRwLockUpgradeFair.html" title="trait lock_api::RawRwLockUpgradeFair">RawRwLockUpgradeFair</a> + 'a, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a> <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.unlock_fair" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#1988-1994">source</a><h4 class="code-header">pub fn <a href="#method.unlock_fair" class="fn">unlock_fair</a>(s: Self)</h4></section></summary><div class="docblock"><p>Unlocks the <code>RwLock</code> using a fair unlock protocol.</p>
|
|||
|
|
<p>By default, <code>RwLock</code> is unfair and allow the current thread to re-lock
|
|||
|
|
the <code>RwLock</code> before another has the chance to acquire the lock, even if
|
|||
|
|
that thread has been blocked on the <code>RwLock</code> for a long time. This is
|
|||
|
|
the default because it allows much higher throughput as it avoids
|
|||
|
|
forcing a context switch on every <code>RwLock</code> unlock. This can result in one
|
|||
|
|
thread acquiring a <code>RwLock</code> many more times than other threads.</p>
|
|||
|
|
<p>However in some cases it can be beneficial to ensure fairness by forcing
|
|||
|
|
the lock to pass on to a waiting thread if there is one. This is done by
|
|||
|
|
using this method instead of dropping the <code>RwLockUpgradableReadGuard</code> normally.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.unlocked_fair" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2003-2013">source</a><h4 class="code-header">pub fn <a href="#method.unlocked_fair" class="fn">unlocked_fair</a><F, U>(s: &mut Self, f: F) -> U<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> U,</div></h4></section></summary><div class="docblock"><p>Temporarily unlocks the <code>RwLock</code> to execute the given function.</p>
|
|||
|
|
<p>The <code>RwLock</code> is unlocked a fair unlock protocol.</p>
|
|||
|
|
<p>This is safe because <code>&mut</code> guarantees that there exist no other
|
|||
|
|
references to the data protected by the <code>RwLock</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bump" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2021-2026">source</a><h4 class="code-header">pub fn <a href="#method.bump" class="fn">bump</a>(s: &mut Self)</h4></section></summary><div class="docblock"><p>Temporarily yields the <code>RwLock</code> to a waiting thread if there is one.</p>
|
|||
|
|
<p>This method is functionally equivalent to calling <code>unlock_fair</code> followed
|
|||
|
|
by <code>upgradable_read</code>, however it can be much more efficient in the case where there
|
|||
|
|
are no waiting threads.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-RwLockUpgradableReadGuard%3C'a,+R,+T%3E-2" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2029-2099">source</a><a href="#impl-RwLockUpgradableReadGuard%3C'a,+R,+T%3E-2" class="anchor">§</a><h3 class="code-header">impl<'a, R: <a class="trait" href="trait.RawRwLockUpgradeDowngrade.html" title="trait lock_api::RawRwLockUpgradeDowngrade">RawRwLockUpgradeDowngrade</a> + 'a, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a> <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.downgrade" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2037-2048">source</a><h4 class="code-header">pub fn <a href="#method.downgrade" class="fn">downgrade</a>(s: Self) -> <a class="struct" href="struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><'a, R, T></h4></section></summary><div class="docblock"><p>Atomically downgrades an upgradable read lock lock into a shared read lock
|
|||
|
|
without allowing any writers to take exclusive access of the lock in the
|
|||
|
|
meantime.</p>
|
|||
|
|
<p>Note that if there are any writers currently waiting to take the lock
|
|||
|
|
then other readers may not be able to acquire the lock even if it was
|
|||
|
|
downgraded.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_upgraded" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2060-2073">source</a><h4 class="code-header">pub fn <a href="#method.with_upgraded" class="fn">with_upgraded</a><Ret, F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&mut T</a>) -> Ret>(&mut self, f: F) -> Ret</h4></section></summary><div class="docblock"><p>First, atomically upgrades an upgradable read lock lock into an exclusive write lock,
|
|||
|
|
blocking the current thread until it can be acquired.</p>
|
|||
|
|
<p>Then, calls the provided closure with an exclusive reference to the lock’s data.</p>
|
|||
|
|
<p>Finally, atomically downgrades the lock back to an upgradable read lock.
|
|||
|
|
The closure’s return value is wrapped in <code>Some</code> and returned.</p>
|
|||
|
|
<p>This function only requires a mutable reference to the guard, unlike
|
|||
|
|
<code>upgrade</code> which takes the guard by value.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_with_upgraded" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2085-2098">source</a><h4 class="code-header">pub fn <a href="#method.try_with_upgraded" class="fn">try_with_upgraded</a><Ret, F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&mut T</a>) -> Ret>(
|
|||
|
|
&mut self,
|
|||
|
|
f: F,
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Ret></h4></section></summary><div class="docblock"><p>First, tries to atomically upgrade an upgradable read lock into an exclusive write lock.</p>
|
|||
|
|
<p>If the access could not be granted at this time, then <code>None</code> is returned.</p>
|
|||
|
|
<p>Otherwise, calls the provided closure with an exclusive reference to the lock’s data,
|
|||
|
|
and finally downgrades the lock back to an upgradable read lock.
|
|||
|
|
The closure’s return value is wrapped in <code>Some</code> and returned.</p>
|
|||
|
|
<p>This function only requires a mutable reference to the guard, unlike
|
|||
|
|
<code>try_upgrade</code> which takes the guard by value.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-RwLockUpgradableReadGuard%3C'a,+R,+T%3E-3" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2101-2146">source</a><a href="#impl-RwLockUpgradableReadGuard%3C'a,+R,+T%3E-3" class="anchor">§</a><h3 class="code-header">impl<'a, R: <a class="trait" href="trait.RawRwLockUpgradeTimed.html" title="trait lock_api::RawRwLockUpgradeTimed">RawRwLockUpgradeTimed</a> + 'a, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a> <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.try_upgrade_for" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2107-2122">source</a><h4 class="code-header">pub fn <a href="#method.try_upgrade_for" class="fn">try_upgrade_for</a>(
|
|||
|
|
s: Self,
|
|||
|
|
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a>,
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><'a, R, T>, Self></h4></section></summary><div class="docblock"><p>Tries to atomically upgrade an upgradable read lock into an exclusive
|
|||
|
|
write lock, until a timeout is reached.</p>
|
|||
|
|
<p>If the access could not be granted before the timeout expires, then
|
|||
|
|
the current guard is returned.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_upgrade_until" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2130-2145">source</a><h4 class="code-header">pub fn <a href="#method.try_upgrade_until" class="fn">try_upgrade_until</a>(
|
|||
|
|
s: Self,
|
|||
|
|
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a>,
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><'a, R, T>, Self></h4></section></summary><div class="docblock"><p>Tries to atomically upgrade an upgradable read lock into an exclusive
|
|||
|
|
write lock, until a timeout is reached.</p>
|
|||
|
|
<p>If the access could not be granted before the timeout expires, then
|
|||
|
|
the current guard is returned.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-RwLockUpgradableReadGuard%3C'a,+R,+T%3E-4" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2148-2212">source</a><a href="#impl-RwLockUpgradableReadGuard%3C'a,+R,+T%3E-4" class="anchor">§</a><h3 class="code-header">impl<'a, R: <a class="trait" href="trait.RawRwLockUpgradeTimed.html" title="trait lock_api::RawRwLockUpgradeTimed">RawRwLockUpgradeTimed</a> + <a class="trait" href="trait.RawRwLockUpgradeDowngrade.html" title="trait lock_api::RawRwLockUpgradeDowngrade">RawRwLockUpgradeDowngrade</a> + 'a, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a> <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.try_with_upgraded_for" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2163-2180">source</a><h4 class="code-header">pub fn <a href="#method.try_with_upgraded_for" class="fn">try_with_upgraded_for</a><Ret, F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&mut T</a>) -> Ret>(
|
|||
|
|
&mut self,
|
|||
|
|
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a>,
|
|||
|
|
f: F,
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Ret></h4></section></summary><div class="docblock"><p>Tries to atomically upgrade an upgradable read lock into an exclusive
|
|||
|
|
write lock, until a timeout is reached.</p>
|
|||
|
|
<p>If the access could not be granted before the timeout expires, then
|
|||
|
|
<code>None</code> is returned.</p>
|
|||
|
|
<p>Otherwise, calls the provided closure with an exclusive reference to the lock’s data,
|
|||
|
|
and finally downgrades the lock back to an upgradable read lock.
|
|||
|
|
The closure’s return value is wrapped in <code>Some</code> and returned.</p>
|
|||
|
|
<p>This function only requires a mutable reference to the guard, unlike
|
|||
|
|
<code>try_upgrade_for</code> which takes the guard by value.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_with_upgraded_until" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2194-2211">source</a><h4 class="code-header">pub fn <a href="#method.try_with_upgraded_until" class="fn">try_with_upgraded_until</a><Ret, F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&mut T</a>) -> Ret>(
|
|||
|
|
&mut self,
|
|||
|
|
timeout: R::<a class="associatedtype" href="trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a>,
|
|||
|
|
f: F,
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Ret></h4></section></summary><div class="docblock"><p>Tries to atomically upgrade an upgradable read lock into an exclusive
|
|||
|
|
write lock, until a timeout is reached.</p>
|
|||
|
|
<p>If the access could not be granted before the timeout expires, then
|
|||
|
|
<code>None</code> is returned.</p>
|
|||
|
|
<p>Otherwise, calls the provided closure with an exclusive reference to the lock’s data,
|
|||
|
|
and finally downgrades the lock back to an upgradable read lock.
|
|||
|
|
The closure’s return value is wrapped in <code>Some</code> and returned.</p>
|
|||
|
|
<p>This function only requires a mutable reference to the guard, unlike
|
|||
|
|
<code>try_upgrade_until</code> which takes the guard by value.</p>
|
|||
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2232-2238">source</a><a href="#impl-Debug-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, R: <a class="trait" href="trait.RawRwLockUpgrade.html" title="trait lock_api::RawRwLockUpgrade">RawRwLockUpgrade</a> + 'a, T: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2235-2237">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.82.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.82.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Deref-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2214-2220">source</a><a href="#impl-Deref-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, R: <a class="trait" href="trait.RawRwLockUpgrade.html" title="trait lock_api::RawRwLockUpgrade">RawRwLockUpgrade</a> + 'a, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2215">source</a><a href="#associatedtype.Target" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.82.0/core/ops/deref/trait.Deref.html#associatedtype.Target" class="associatedtype">Target</a> = T</h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#2217-2219">source</a><a href="#method.deref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/ops/deref/trait.Deref.html#tymethod.deref" class="fn">deref</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.refer
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="impl"><a href="#impl-RefUnwindSafe-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, R, T> !<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T></h3></section><section id="impl-Send-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="impl"><a href="#impl-Send-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, R, T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T><div class="where">where
|
|||
|
|
R: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|||
|
|
<R as <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>>::<a class="associatedtype" href="trait.RawRwLock.html#associatedtype.GuardMarker" title="type lock_api::RawRwLock::GuardMarker">GuardMarker</a>: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Unpin-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="impl"><a href="#impl-Unpin-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, R, T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T><div class="where">where
|
|||
|
|
<R as <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>>::<a class="associatedtype" href="trait.RawRwLock.html#associatedtype.GuardMarker" title="type lock_api::RawRwLock::GuardMarker">GuardMarker</a>: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section><section id="impl-UnwindSafe-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="impl"><a href="#impl-UnwindSafe-for-RwLockUpgradableReadGuard%3C'a,+R,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, R, T> !<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><'a, R, T></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/any.rs.html#138">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|||
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/any.rs.html#139">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.82.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.82.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/borrow.rs.html#209">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/borrow.rs.html#211">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/borrow.rs.html#217">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/borrow.rs.html#218">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.Into.html#tymethod.into" class="fn">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/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#809">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#794">source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
|