mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 11:59:33 +01:00
40 lines
12 KiB
HTML
40 lines
12 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."><title>RawRwLock 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-b0742ba02757f159.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.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-0111fcff984fae8f.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 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" 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><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">RawRw<wbr>Lock</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li></ul><h3><a href="#required-associated-consts">Required Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.INIT" title="INIT">INIT</a></li></ul><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.GuardMarker" title="GuardMarker">GuardMarker</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.lock_exclusive" title="lock_exclusive">lock_exclusive</a></li><li><a href="#tymethod.lock_shared" title="lock_shared">lock_shared</a></li><li><a href="#tymethod.try_lock_exclusive" title="try_lock_exclusive">try_lock_exclusive</a></li><li><a href="#tymethod.try_lock_shared" title="try_lock_shared">try_lock_shared</a></li><li><a href="#tymethod.unlock_exclusive" title="unlock_exclusive">unlock_exclusive</a></li><li><a href="#tymethod.unlock_shared" title="unlock_shared">unlock_shared</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.is_locked" title="is_locked">is_locked</a></li><li><a href="#method.is_locked_exclusive" title="is_locked_exclusive">is_locked_exclusive</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate lock_<wbr>api</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">lock_api</a></span><h1>Trait <span class="trait">RawRwLock</span><button id="copy-path" title="Copy item path to clipboard">C
|
|||
|
|
type <a href="#associatedtype.GuardMarker" class="associatedtype">GuardMarker</a>;
|
|||
|
|
|
|||
|
|
const <a href="#associatedconstant.INIT" class="constant">INIT</a>: Self;
|
|||
|
|
|
|||
|
|
// Required methods
|
|||
|
|
fn <a href="#tymethod.lock_shared" class="fn">lock_shared</a>(&self);
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.try_lock_shared" class="fn">try_lock_shared</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a>;
|
|||
|
|
<span class="item-spacer"></span> unsafe fn <a href="#tymethod.unlock_shared" class="fn">unlock_shared</a>(&self);
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.lock_exclusive" class="fn">lock_exclusive</a>(&self);
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.try_lock_exclusive" class="fn">try_lock_exclusive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a>;
|
|||
|
|
<span class="item-spacer"></span> unsafe fn <a href="#tymethod.unlock_exclusive" class="fn">unlock_exclusive</a>(&self);
|
|||
|
|
|
|||
|
|
// Provided methods
|
|||
|
|
fn <a href="#method.is_locked" class="fn">is_locked</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a> { ... }
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#method.is_locked_exclusive" class="fn">is_locked_exclusive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a> { ... }
|
|||
|
|
}</code></pre><details class="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"><a class="doc-anchor" href="#safety">§</a>Safety</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="required-associated-consts" class="section-header">Required Associated Constants<a href="#required-associated-consts" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedconstant.INIT" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#43">source</a><h4 class="code-header">const <a href="#associatedconstant.INIT" class="constant">INIT</a>: Self</h4></section></summary><div class="docblock"><p>Initial value for an unlocked <code>RwLock</code>.</p>
|
|||
|
|
</div></details></div><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.GuardMarker" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#47">source</a><h4 class="code-header">type <a href="#associatedtype.GuardMarker" class="associatedtype">GuardMarker</a></h4></section></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="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.lock_shared" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#50">source</a><h4 class="code-header">fn <a href="#tymethod.lock_shared" class="fn">lock_shared</a>(&self)</h4></section></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="toggle method-toggle" open><summary><section id="tymethod.try_lock_shared" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#53">source</a><h4 class="code-header">fn <a href="#tymethod.try_lock_shared" class="fn">try_lock_shared</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Attempts to acquire a shared lock without blocking.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.unlock_shared" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#60">source</a><h4 class="code-header">unsafe fn <a href="#tymethod.unlock_shared" class="fn">unlock_shared</a>(&self)</h4></section></summary><div class="docblock"><p>Releases a shared lock.</p>
|
|||
|
|
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
|
|||
|
|
<p>This method may only be called if a shared lock is held in the current context.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.lock_exclusive" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#63">source</a><h4 class="code-header">fn <a href="#tymethod.lock_exclusive" class="fn">lock_exclusive</a>(&self)</h4></section></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="toggle method-toggle" open><summary><section id="tymethod.try_lock_exclusive" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#66">source</a><h4 class="code-header">fn <a href="#tymethod.try_lock_exclusive" class="fn">try_lock_exclusive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Attempts to acquire an exclusive lock without blocking.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.unlock_exclusive" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#73">source</a><h4 class="code-header">unsafe fn <a href="#tymethod.unlock_exclusive" class="fn">unlock_exclusive</a>(&self)</h4></section></summary><div class="docblock"><p>Releases an exclusive lock.</p>
|
|||
|
|
<h5 id="safety-2"><a class="doc-anchor" href="#safety-2">§</a>Safety</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="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.is_locked" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#77-86">source</a><h4 class="code-header">fn <a href="#method.is_locked" class="fn">is_locked</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if this <code>RwLock</code> is currently locked in any way.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_locked_exclusive" class="method"><a class="src rightside" href="../src/lock_api/rwlock.rs.html#89-98">source</a><h4 class="code-header">fn <a href="#method.is_locked_exclusive" class="fn">is_locked_exclusive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Check if this <code>RwLock</code> is currently exclusively locked.</p>
|
|||
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.83.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/lock_api/rwlock/trait.RawRwLock.js" async></script></section></div></main></body></html>
|