mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-26 05:29:38 +01:00
30 lines
9.3 KiB
HTML
30 lines
9.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="Basic operations for a mutex."><title>RawMutex 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-492a78a4a87dcc01.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.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.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><h2 class="location"><a href="#">RawMutex</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.GuardMarker">GuardMarker</a></li></ul><h3><a href="#required-associated-consts">Required Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.INIT">INIT</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.lock">lock</a></li><li><a href="#tymethod.try_lock">try_lock</a></li><li><a href="#tymethod.unlock">unlock</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.is_locked">is_locked</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate lock_<wbr>api</a></h2></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"><h1>Trait <a href="index.html">lock_api</a>::<wbr><a class="trait" href="#">RawMutex</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/lock_api/mutex.rs.html#36-79">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub unsafe trait RawMutex {
|
|||
|
|
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" class="fn">lock</a>(&self);
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.try_lock" class="fn">try_lock</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a>;
|
|||
|
|
<span class="item-spacer"></span> unsafe fn <a href="#tymethod.unlock" class="fn">unlock</a>(&self);
|
|||
|
|
|
|||
|
|
// Provided method
|
|||
|
|
fn <a href="#method.is_locked" class="fn">is_locked</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.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 mutex.</p>
|
|||
|
|
<p>Types implementing this trait can be used by <code>Mutex</code> to form a safe and
|
|||
|
|
fully-functioning mutex type.</p>
|
|||
|
|
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
|||
|
|
<p>Implementations of this trait must ensure that the mutex is actually
|
|||
|
|
exclusive: a lock can’t be acquired while the mutex is already locked.</p>
|
|||
|
|
</div></details><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/mutex.rs.html#45">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-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/mutex.rs.html#41">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 mutex.</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" class="method"><a class="src rightside" href="../src/lock_api/mutex.rs.html#48">source</a><h4 class="code-header">fn <a href="#tymethod.lock" class="fn">lock</a>(&self)</h4></section></summary><div class="docblock"><p>Acquires this mutex, 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" class="method"><a class="src rightside" href="../src/lock_api/mutex.rs.html#52">source</a><h4 class="code-header">fn <a href="#tymethod.try_lock" class="fn">try_lock</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Attempts to acquire this mutex without blocking. Returns <code>true</code>
|
|||
|
|
if the lock was successfully acquired and <code>false</code> otherwise.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.unlock" class="method"><a class="src rightside" href="../src/lock_api/mutex.rs.html#65">source</a><h4 class="code-header">unsafe fn <a href="#tymethod.unlock" class="fn">unlock</a>(&self)</h4></section></summary><div class="docblock"><p>Unlocks this mutex.</p>
|
|||
|
|
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
|
|||
|
|
<p>This method may only be called if the mutex is held in the current context, i.e. it must
|
|||
|
|
be paired with a successful call to <a href="trait.RawMutex.html#tymethod.lock" title="method lock_api::RawMutex::lock"><code>lock</code></a>, <a href="trait.RawMutex.html#tymethod.try_lock" title="method lock_api::RawMutex::try_lock"><code>try_lock</code></a>, <a href="trait.RawMutexTimed.html#tymethod.try_lock_for" title="method lock_api::RawMutexTimed::try_lock_for"><code>try_lock_for</code></a> or <a href="trait.RawMutexTimed.html#tymethod.try_lock_until" title="method lock_api::RawMutexTimed::try_lock_until"><code>try_lock_until</code></a>.</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/mutex.rs.html#69-78">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.82.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks whether the mutex is currently 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.82.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/mutex/trait.RawMutex.js" async></script></section></div></main></body></html>
|