41 lines
14 KiB
HTML
41 lines
14 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="Basic operations for a reader-writer lock."><meta name="keywords" content="rust, rustlang, rust-lang, RawRwLock"><title>RawRwLock 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="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../lock_api/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Trait RawRwLock</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#associated-types">Associated Types</a></h3><div class="sidebar-links"><a href="#associatedtype.GuardMarker">GuardMarker</a></div><h3 class="sidebar-title"><a href="#associated-const">Associated Constants</a></h3><div class="sidebar-links"><a href="#associatedconstant.INIT">INIT</a></div><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.lock_exclusive">lock_exclusive</a><a href="#tymethod.lock_shared">lock_shared</a><a href="#tymethod.try_lock_exclusive">try_lock_exclusive</a><a href="#tymethod.try_lock_shared">try_lock_shared</a><a href="#tymethod.unlock_exclusive">unlock_exclusive</a><a href="#tymethod.unlock_shared">unlock_shared</a></div><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.is_locked">is_locked</a><a href="#method.is_locked_exclusive">is_locked_exclusive</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="RawRwLock" 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.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" 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 width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">lock_api</a>::<wbr><a class="trait" href="#">RawRwLock</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><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#38-99" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub unsafe trait RawRwLock {
|
||
type <a href="#associatedtype.GuardMarker" class="associatedtype">GuardMarker</a>;
|
||
|
||
const <a href="#associatedconstant.INIT" class="constant">INIT</a>: Self;
|
||
|
||
fn <a href="#tymethod.lock_shared" class="fnname">lock_shared</a>(&self);
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.try_lock_shared" class="fnname">try_lock_shared</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/core/primitive.bool.html">bool</a>;
|
||
<div class="item-spacer"></div> unsafe fn <a href="#tymethod.unlock_shared" class="fnname">unlock_shared</a>(&self);
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.lock_exclusive" class="fnname">lock_exclusive</a>(&self);
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.try_lock_exclusive" class="fnname">try_lock_exclusive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/core/primitive.bool.html">bool</a>;
|
||
<div class="item-spacer"></div> unsafe fn <a href="#tymethod.unlock_exclusive" class="fnname">unlock_exclusive</a>(&self);
|
||
|
||
fn <a href="#method.is_locked" class="fnname">is_locked</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/core/primitive.bool.html">bool</a> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.is_locked_exclusive" class="fnname">is_locked_exclusive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/core/primitive.bool.html">bool</a> { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Basic operations for a reader-writer lock.</p>
|
||
<p>Types implementing this trait can be used by <code>RwLock</code> to form a safe and
|
||
fully-functioning <code>RwLock</code> type.</p>
|
||
<h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
|
||
<p>Implementations of this trait must ensure that the <code>RwLock</code> is actually
|
||
exclusive: an exclusive lock can’t be acquired while an exclusive or shared
|
||
lock exists, and a shared lock can’t be acquire while an exclusive lock
|
||
exists.</p>
|
||
</div></details><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedtype.GuardMarker" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#47" title="goto source code">[src]</a></div><h4 class="code-header">type <a href="#associatedtype.GuardMarker" class="associatedtype">GuardMarker</a></h4></div></summary><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.</p>
|
||
</div></details></div><h2 id="associated-const" class="small-section-header">Associated Constants<a href="#associated-const" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedconstant.INIT" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#43" title="goto source code">[src]</a></div><h4 class="code-header">const <a href="#associatedconstant.INIT" class="constant">INIT</a>: Self</h4></div></summary><div class="docblock"><p>Initial value for an unlocked <code>RwLock</code>.</p>
|
||
</div></details></div><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_shared" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#50" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.lock_shared" class="fnname">lock_shared</a>(&self)</h4></div></summary><div class="docblock"><p>Acquires a shared 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_shared" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#53" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.try_lock_shared" class="fnname">try_lock_shared</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/core/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Attempts to acquire a shared lock without blocking.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.unlock_shared" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#60" title="goto source code">[src]</a></div><h4 class="code-header">unsafe fn <a href="#tymethod.unlock_shared" class="fnname">unlock_shared</a>(&self)</h4></div></summary><div class="docblock"><p>Releases a shared lock.</p>
|
||
<h5 id="safety-1" class="section-header"><a href="#safety-1">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.lock_exclusive" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#63" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.lock_exclusive" class="fnname">lock_exclusive</a>(&self)</h4></div></summary><div class="docblock"><p>Acquires an exclusive 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_exclusive" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#66" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.try_lock_exclusive" class="fnname">try_lock_exclusive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/core/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Attempts to acquire an exclusive lock without blocking.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.unlock_exclusive" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#73" title="goto source code">[src]</a></div><h4 class="code-header">unsafe fn <a href="#tymethod.unlock_exclusive" class="fnname">unlock_exclusive</a>(&self)</h4></div></summary><div class="docblock"><p>Releases an exclusive lock.</p>
|
||
<h5 id="safety-2" class="section-header"><a href="#safety-2">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.is_locked" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#77-86" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.is_locked" class="fnname">is_locked</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/core/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Checks if this <code>RwLock</code> is currently locked in any way.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.is_locked_exclusive" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/rwlock.rs.html#89-98" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.is_locked_exclusive" class="fnname">is_locked_exclusive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/core/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Check if this <code>RwLock</code> is currently exclusively locked.</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.RawRwLock.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.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |