<!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="Additional methods for RwLocks which support fair unlocking."><meta name="keywords" content="rust, rustlang, rust-lang, RawRwLockFair"><title>RawRwLockFair 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 src="../crates.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 trait"><!--[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="#">RawRwLockFair</a></h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><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><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.bump_exclusive">bump_exclusive</a><a href="#method.bump_shared">bump_shared</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">In <a href="index.html">lock_api</a></h2><div id="sidebar-vars" data-name="RawRwLockFair" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></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"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Trait <a href="index.html">lock_api</a>::<wbr><a class="trait" href="#">RawRwLockFair</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#107-149">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 trait"><code>pub unsafe trait RawRwLockFair: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a> {
unsafe fn <a href="#tymethod.unlock_shared_fair" class="fnname">unlock_shared_fair</a>(&self);
<div class="item-spacer"></div> unsafe fn <a href="#tymethod.unlock_exclusive_fair" class="fnname">unlock_exclusive_fair</a>(&self);
unsafe fn <a href="#method.bump_shared" class="fnname">bump_shared</a>(&self) { ... }
<div class="item-spacer"></div> unsafe fn <a href="#method.bump_exclusive" class="fnname">bump_exclusive</a>(&self) { ... }
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.unlock_shared_fair" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#113">source</a></div><h4 class="code-header">unsafe fn <a href="#tymethod.unlock_shared_fair" class="fnname">unlock_shared_fair</a>(&self)</h4></div></summary><div class="docblock"><p>Releases a shared lock using a fair unlock protocol.</p>
<h5 id="safety" class="section-header"><a href="#safety">Safety</a></h5>
<p>This method may only be called if a shared lock is held in the current context.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.unlock_exclusive_fair" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#120">source</a></div><h4 class="code-header">unsafe fn <a href="#tymethod.unlock_exclusive_fair" class="fnname">unlock_exclusive_fair</a>(&self)</h4></div></summary><div class="docblock"><p>Releases an exclusive lock using a fair unlock protocol.</p>
<h5 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h5>
<p>This method may only be called if an exclusive lock is held in the current context.</p>
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.bump_shared" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#131-134">source</a></div><h4 class="code-header">unsafe fn <a href="#method.bump_shared" class="fnname">bump_shared</a>(&self)</h4></div></summary><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>
<h5 id="safety-2" class="section-header"><a href="#safety-2">Safety</a></h5>
<p>This method may only be called if a shared lock is held in the current context.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.bump_exclusive" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#145-148">source</a></div><h4 class="code-header">unsafe fn <a href="#method.bump_exclusive" class="fnname">bump_exclusive</a>(&self)</h4></div></summary><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>
<h5 id="safety-3" class="section-header"><a href="#safety-3">Safety</a></h5>
<p>This method may only be called if an exclusive lock is held in the current context.</p>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/lock_api/trait.RawRwLockFair.js" async></script></section><section id="search" class="content hidden"></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.60.0-nightly (08df8b81d 2022-01-30)" ></div>
</body></html>