|
|
|
|
|
<!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 `RawRwLockFair` trait in crate `lock_api`."><meta name="keywords" content="rust, rustlang, rust-lang, RawRwLockFair"><title>lock_api::RawRwLockFair - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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">☰</div><a href='../lock_api/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait RawRwLockFair</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.unlock_exclusive_fair">unlock_exclusive_fair</a><a href="#tymethod.unlock_shared_fair">unlock_shared_fair</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.bump_exclusive">bump_exclusive</a><a href="#method.bump_shared">bump_shared</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>lock_api</a></p><script>window.sidebarCurrent = {name: 'RawRwLockFair', ty: 'trait', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/lock_api/rwlock.rs.html#61-87' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>lock_api</a>::<wbr><a class="trait" href=''>RawRwLockFair</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait RawRwLockFair: <a class="trait" href="../lock_api/trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a> {
|
|
|
|
|
|
fn <a href='#tymethod.unlock_shared_fair' class='fnname'>unlock_shared_fair</a>(&self);
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.unlock_exclusive_fair' class='fnname'>unlock_exclusive_fair</a>(&self);
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.bump_shared' class='fnname'>bump_shared</a>(&self) { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.bump_exclusive' class='fnname'>bump_exclusive</a>(&self) { ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Additional methods for RwLocks which support fair unlocking.</p>
|
|
|
|
|
|
<p>Fair unlocking means that a lock is handed directly over to the next waiting
|
|
|
|
|
|
thread if there is one, without giving other threads the opportunity to
|
|
|
|
|
|
"steal" the lock in the meantime. This is typically slower than unfair
|
|
|
|
|
|
unlocking, but may be necessary in certain circumstances.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.unlock_shared_fair' class='method'><code id='unlock_shared_fair.v'>fn <a href='#tymethod.unlock_shared_fair' class='fnname'>unlock_shared_fair</a>(&self)</code></h3><div class='docblock'><p>Releases a shared lock using a fair unlock protocol.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.unlock_exclusive_fair' class='method'><code id='unlock_exclusive_fair.v'>fn <a href='#tymethod.unlock_exclusive_fair' class='fnname'>unlock_exclusive_fair</a>(&self)</code></h3><div class='docblock'><p>Releases an exclusive lock using a fair unlock protocol.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.bump_shared' class='method'><code id='bump_shared.v'>fn <a href='#method.bump_shared' class='fnname'>bump_shared</a>(&self)</code></h3><div class='docblock'><p>Temporarily yields a shared lock to a waiting thread if there is one.</p>
|
|
|
|
|
|
<p>This method is functionally equivalent to calling <code>unlock_shared_fair</code> followed
|
|
|
|
|
|
by <code>lock_shared</code>, however it can be much more efficient in the case where there
|
|
|
|
|
|
are no waiting threads.</p>
|
|
|
|
|
|
</div><h3 id='method.bump_exclusive' class='method'><code id='bump_exclusive.v'>fn <a href='#method.bump_exclusive' class='fnname'>bump_exclusive</a>(&self)</code></h3><div class='docblock'><p>Temporarily yields an exclusive lock to a waiting thread if there is one.</p>
|
|
|
|
|
|
<p>This method is functionally equivalent to calling <code>unlock_exclusive_fair</code> followed
|
|
|
|
|
|
by <code>lock_exclusive</code>, however it can be much more efficient in the case where there
|
|
|
|
|
|
are no waiting threads.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
|
|
|
src="../implementors/lock_api/trait.RawRwLockFair.js">
|
|
|
|
|
|
</script></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>⏎</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 = "lock_api";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
