mirror of
https://github.com/rust-embedded/heapless.git
synced 2025-10-02 14:54:30 +00:00
26 lines
8.3 KiB
HTML
26 lines
8.3 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="Additional methods for RwLocks which support atomically upgrading a shared lock to an exclusive lock."><meta name="keywords" content="rust, rustlang, rust-lang, RawRwLockUpgrade"><title>RawRwLockUpgrade in lock_api - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../lock_api/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Trait RawRwLockUpgrade</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.lock_upgradable">lock_upgradable</a><a href="#tymethod.try_lock_upgradable">try_lock_upgradable</a><a href="#tymethod.try_upgrade">try_upgrade</a><a href="#tymethod.unlock_upgradable">unlock_upgradable</a><a href="#tymethod.upgrade">upgrade</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">lock_api</a></h2><div id="sidebar-vars" data-name="RawRwLockUpgrade" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">lock_api</a>::<wbr><a class="trait" href="#">RawRwLockUpgrade</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></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">−</span>]</a></span><a class="srclink" href="../src/lock_api/rwlock.rs.html#200-228" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub unsafe trait RawRwLockUpgrade: <a class="trait" href="trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a> {
|
||
fn <a href="#tymethod.lock_upgradable" class="fnname">lock_upgradable</a>(&self);
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.try_lock_upgradable" class="fnname">try_lock_upgradable</a>(&self) -> bool;
|
||
<div class="item-spacer"></div> unsafe fn <a href="#tymethod.unlock_upgradable" class="fnname">unlock_upgradable</a>(&self);
|
||
<div class="item-spacer"></div> unsafe fn <a href="#tymethod.upgrade" class="fnname">upgrade</a>(&self);
|
||
<div class="item-spacer"></div> unsafe fn <a href="#tymethod.try_upgrade" class="fnname">try_upgrade</a>(&self) -> bool;
|
||
}</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 atomically upgrading a shared
|
||
lock to an exclusive lock.</p>
|
||
<p>This requires acquiring a special “upgradable read lock” instead of a
|
||
normal shared lock. There may only be one upgradable lock at any time,
|
||
otherwise deadlocks could occur when upgrading.</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.lock_upgradable" class="method has-srclink"><h4 class="code-header">fn <a href="#tymethod.lock_upgradable" class="fnname">lock_upgradable</a>(&self)</h4><a class="srclink" href="../src/lock_api/rwlock.rs.html#202" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Acquires an upgradable lock, blocking the current thread until it is able to do so.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.try_lock_upgradable" class="method has-srclink"><h4 class="code-header">fn <a href="#tymethod.try_lock_upgradable" class="fnname">try_lock_upgradable</a>(&self) -> bool</h4><a class="srclink" href="../src/lock_api/rwlock.rs.html#205" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Attempts to acquire an upgradable lock without blocking.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.unlock_upgradable" class="method has-srclink"><h4 class="code-header">unsafe fn <a href="#tymethod.unlock_upgradable" class="fnname">unlock_upgradable</a>(&self)</h4><a class="srclink" href="../src/lock_api/rwlock.rs.html#212" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Releases an upgradable lock.</p>
|
||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||
<p>This method may only be called if an upgradable lock is held in the current context.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.upgrade" class="method has-srclink"><h4 class="code-header">unsafe fn <a href="#tymethod.upgrade" class="fnname">upgrade</a>(&self)</h4><a class="srclink" href="../src/lock_api/rwlock.rs.html#219" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Upgrades an upgradable lock to an exclusive lock.</p>
|
||
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
|
||
<p>This method may only be called if an upgradable lock is held in the current context.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.try_upgrade" class="method has-srclink"><h4 class="code-header">unsafe fn <a href="#tymethod.try_upgrade" class="fnname">try_upgrade</a>(&self) -> bool</h4><a class="srclink" href="../src/lock_api/rwlock.rs.html#227" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Attempts to upgrade an upgradable lock to an exclusive lock without
|
||
blocking.</p>
|
||
<h1 id="safety-2" class="section-header"><a href="#safety-2">Safety</a></h1>
|
||
<p>This method may only be called if an upgradable 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.RawRwLockUpgrade.js" async></script></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="lock_api" data-search-index-js="../search-index.js" data-search-js="../search.js"></div><script src="../main.js"></script></body></html> |