mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 20:09:33 +01:00
112 lines
43 KiB
HTML
112 lines
43 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="A spin-based lock providing mutually exclusive access to data."><title>Mutex in spin::mutex - 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="spin" 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 struct"><!--[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="../../spin/index.html">spin</a><span class="version">0.9.8</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Mutex</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li><li><a href="#thread-safety-example" title="Thread safety example">Thread safety example</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.force_unlock" title="force_unlock">force_unlock</a></li><li><a href="#method.get_mut" title="get_mut">get_mut</a></li><li><a href="#method.into_inner" title="into_inner">into_inner</a></li><li><a href="#method.is_locked" title="is_locked">is_locked</a></li><li><a href="#method.lock" title="lock">lock</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.try_lock" title="try_lock">try_lock</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Mutex%3CT,+R%3E" title="Debug">Debug</a></li><li><a href="#impl-Default-for-Mutex%3CT,+R%3E" title="Default">Default</a></li><li><a href="#impl-From%3CT%3E-for-Mutex%3CT,+R%3E" title="From<T>">From<T></a></li><li><a href="#impl-RawMutex-for-Mutex%3C(),+R%3E" title="RawMutex">RawMutex</a></li><li><a href="#impl-Send-for-Mutex%3CT,+R%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-Mutex%3CT,+R%3E" title="Sync">Sync</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Mutex%3CT,+R%3E" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Mutex%3CT,+R%3E" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-Mutex%3CT,+R%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Mutex%3CT,+R%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations<
|
|||
|
|
<p>The implementation uses either a ticket mutex or a regular spin mutex depending on whether the <code>spin_mutex</code> or
|
|||
|
|
<code>ticket_mutex</code> feature flag is enabled.</p>
|
|||
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>spin;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>lock = spin::Mutex::new(<span class="number">0</span>);
|
|||
|
|
|
|||
|
|
<span class="comment">// Modify the data
|
|||
|
|
</span><span class="kw-2">*</span>lock.lock() = <span class="number">2</span>;
|
|||
|
|
|
|||
|
|
<span class="comment">// Read the data
|
|||
|
|
</span><span class="kw">let </span>answer = <span class="kw-2">*</span>lock.lock();
|
|||
|
|
<span class="macro">assert_eq!</span>(answer, <span class="number">2</span>);</code></pre></div>
|
|||
|
|
<h2 id="thread-safety-example"><a class="doc-anchor" href="#thread-safety-example">§</a>Thread safety example</h2>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>spin;
|
|||
|
|
<span class="kw">use </span>std::sync::{Arc, Barrier};
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>thread_count = <span class="number">1000</span>;
|
|||
|
|
<span class="kw">let </span>spin_mutex = Arc::new(spin::Mutex::new(<span class="number">0</span>));
|
|||
|
|
|
|||
|
|
<span class="comment">// We use a barrier to ensure the readout happens after all writing
|
|||
|
|
</span><span class="kw">let </span>barrier = Arc::new(Barrier::new(thread_count + <span class="number">1</span>));
|
|||
|
|
|
|||
|
|
<span class="kw">for _ in </span>(<span class="number">0</span>..thread_count) {
|
|||
|
|
<span class="kw">let </span>my_barrier = barrier.clone();
|
|||
|
|
<span class="kw">let </span>my_lock = spin_mutex.clone();
|
|||
|
|
std::thread::spawn(<span class="kw">move </span>|| {
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>guard = my_lock.lock();
|
|||
|
|
<span class="kw-2">*</span>guard += <span class="number">1</span>;
|
|||
|
|
|
|||
|
|
<span class="comment">// Release the lock to prevent a deadlock
|
|||
|
|
</span>drop(guard);
|
|||
|
|
my_barrier.wait();
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
barrier.wait();
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>answer = { <span class="kw-2">*</span>spin_mutex.lock() };
|
|||
|
|
<span class="macro">assert_eq!</span>(answer, thread_count);
|
|||
|
|
</code></pre></div>
|
|||
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Mutex%3CT,+R%3E" class="impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#131-166">source</a><a href="#impl-Mutex%3CT,+R%3E" class="anchor">§</a><h3 class="code-header">impl<T, R> <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/spin/mutex.rs.html#148-152">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>(value: T) -> Self</h4></section></summary><div class="docblock"><p>Creates a new <a href="struct.Mutex.html" title="struct spin::mutex::Mutex"><code>Mutex</code></a> wrapping the supplied data.</p>
|
|||
|
|
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>spin::Mutex;
|
|||
|
|
|
|||
|
|
<span class="kw">static </span>MUTEX: Mutex<()> = Mutex::new(());
|
|||
|
|
|
|||
|
|
<span class="kw">fn </span>demo() {
|
|||
|
|
<span class="kw">let </span>lock = MUTEX.lock();
|
|||
|
|
<span class="comment">// do something with lock
|
|||
|
|
</span>drop(lock);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_inner" class="method"><a class="src rightside" href="../../src/spin/mutex.rs.html#163-165">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fn">into_inner</a>(self) -> T</h4></section></summary><div class="docblock"><p>Consumes this <a href="struct.Mutex.html" title="struct spin::mutex::Mutex"><code>Mutex</code></a> and unwraps the underlying data.</p>
|
|||
|
|
<h5 id="example-2"><a class="doc-anchor" href="#example-2">§</a>Example</h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>lock = spin::Mutex::new(<span class="number">42</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="number">42</span>, lock.into_inner());</code></pre></div>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Mutex%3CT,+R%3E-1" class="impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#168-189">source</a><a href="#impl-Mutex%3CT,+R%3E-1" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, R: <a class="trait" href="../relax/trait.RelaxStrategy.html" title="trait spin::relax::RelaxStrategy">RelaxStrategy</a>> <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.lock" class="method"><a class="src rightside" href="../../src/spin/mutex.rs.html#184-188">source</a><h4 class="code-header">pub fn <a href="#method.lock" class="fn">lock</a>(&self) -> <a class="struct" href="struct.MutexGuard.html" title="struct spin::mutex::MutexGuard">MutexGuard</a><'_, T></h4></section></summary><div class="docblock"><p>Locks the <a href="struct.Mutex.html" title="struct spin::mutex::Mutex"><code>Mutex</code></a> and returns a guard that permits access to the inner data.</p>
|
|||
|
|
<p>The returned value may be dereferenced for data access
|
|||
|
|
and the lock will be dropped when the guard falls out of scope.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>lock = spin::Mutex::new(<span class="number">0</span>);
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>data = lock.lock();
|
|||
|
|
<span class="comment">// The lock is now locked and the data can be accessed
|
|||
|
|
</span><span class="kw-2">*</span>data += <span class="number">1</span>;
|
|||
|
|
<span class="comment">// The lock is implicitly dropped at the end of the scope
|
|||
|
|
</span>}</code></pre></div>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Mutex%3CT,+R%3E-2" class="impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#191-253">source</a><a href="#impl-Mutex%3CT,+R%3E-2" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, R> <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.is_locked" class="method"><a class="src rightside" href="../../src/spin/mutex.rs.html#199-201">source</a><h4 class="code-header">pub 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>Returns <code>true</code> if the lock is currently held.</p>
|
|||
|
|
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
|||
|
|
<p>This function provides no synchronization guarantees and so its result should be considered ‘out of date’
|
|||
|
|
the instant it is called. Do not use it for synchronization purposes. However, it may be useful as a heuristic.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.force_unlock" class="method"><a class="src rightside" href="../../src/spin/mutex.rs.html#211-213">source</a><h4 class="code-header">pub unsafe fn <a href="#method.force_unlock" class="fn">force_unlock</a>(&self)</h4></section></summary><div class="docblock"><p>Force unlock this <a href="struct.Mutex.html" title="struct spin::mutex::Mutex"><code>Mutex</code></a>.</p>
|
|||
|
|
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
|
|||
|
|
<p>This is <em>extremely</em> unsafe if the lock is not held by the current
|
|||
|
|
thread. However, this can be useful in some instances for exposing the
|
|||
|
|
lock to FFI that doesn’t know how to deal with RAII.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_lock" class="method"><a class="src rightside" href="../../src/spin/mutex.rs.html#230-234">source</a><h4 class="code-header">pub fn <a href="#method.try_lock" class="fn">try_lock</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.MutexGuard.html" title="struct spin::mutex::MutexGuard">MutexGuard</a><'_, T>></h4></section></summary><div class="docblock"><p>Try to lock this <a href="struct.Mutex.html" title="struct spin::mutex::Mutex"><code>Mutex</code></a>, returning a lock guard if successful.</p>
|
|||
|
|
<h5 id="example-3"><a class="doc-anchor" href="#example-3">§</a>Example</h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>lock = spin::Mutex::new(<span class="number">42</span>);
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>maybe_guard = lock.try_lock();
|
|||
|
|
<span class="macro">assert!</span>(maybe_guard.is_some());
|
|||
|
|
|
|||
|
|
<span class="comment">// `maybe_guard` is still held, so the second call fails
|
|||
|
|
</span><span class="kw">let </span>maybe_guard2 = lock.try_lock();
|
|||
|
|
<span class="macro">assert!</span>(maybe_guard2.is_none());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><a class="src rightside" href="../../src/spin/mutex.rs.html#250-252">source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fn">get_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&mut T</a></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the underlying data.</p>
|
|||
|
|
<p>Since this call borrows the <a href="struct.Mutex.html" title="struct spin::mutex::Mutex"><code>Mutex</code></a> mutably, and a mutable reference is guaranteed to be exclusive in Rust,
|
|||
|
|
no actual locking needs to take place – the mutable borrow statically guarantees no locks exist. As such,
|
|||
|
|
this is a ‘zero-cost’ operation.</p>
|
|||
|
|
<h5 id="example-4"><a class="doc-anchor" href="#example-4">§</a>Example</h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>lock = spin::Mutex::new(<span class="number">0</span>);
|
|||
|
|
<span class="kw-2">*</span>lock.get_mut() = <span class="number">10</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>lock.lock(), <span class="number">10</span>);</code></pre></div>
|
|||
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Mutex%3CT,+R%3E" class="impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#255-259">source</a><a href="#impl-Debug-for-Mutex%3CT,+R%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, R> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#256-258">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.83.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-Mutex%3CT,+R%3E" class="impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#261-265">source</a><a href="#impl-Default-for-Mutex%3CT,+R%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>, R> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#262-264">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CT%3E-for-Mutex%3CT,+R%3E" class="impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#267-271">source</a><a href="#impl-From%3CT%3E-for-Mutex%3CT,+R%3E" class="anchor">§</a><h3 class="code-header">impl<T, R> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-imp
|
|||
|
|
one of the <code>GuardSend</code> or <code>GuardNoSend</code> helper types here.</div></details><details class="toggle method-toggle" open><summary><section id="method.lock-1" class="method trait-impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#323-326">source</a><a href="#method.lock-1" class="anchor">§</a><h4 class="code-header">fn <a href="../../lock_api/mutex/trait.RawMutex.html#tymethod.lock" class="fn">lock</a>(&self)</h4></section></summary><div class='docblock'>Acquires this mutex, blocking the current thread until it is able to do so.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_lock-1" class="method trait-impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#328-331">source</a><a href="#method.try_lock-1" class="anchor">§</a><h4 class="code-header">fn <a href="../../lock_api/mutex/trait.RawMutex.html#tymethod.try_lock" class="fn">try_lock</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'>Attempts to acquire this mutex without blocking. Returns <code>true</code>
|
|||
|
|
if the lock was successfully acquired and <code>false</code> otherwise.</div></details><details class="toggle method-toggle" open><summary><section id="method.unlock" class="method trait-impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#333-335">source</a><a href="#method.unlock" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="../../lock_api/mutex/trait.RawMutex.html#tymethod.unlock" class="fn">unlock</a>(&self)</h4></section></summary><div class='docblock'>Unlocks this mutex. <a href="../../lock_api/mutex/trait.RawMutex.html#tymethod.unlock">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.is_locked-1" class="method trait-impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#337-339">source</a><a href="#method.is_locked-1" class="anchor">§</a><h4 class="code-header">fn <a href="../../lock_api/mutex/trait.RawMutex.html#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'>Checks whether the mutex is currently locked.</div></details></div></details><section id="impl-Send-for-Mutex%3CT,+R%3E" class="impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#118">source</a><a href="#impl-Send-for-Mutex%3CT,+R%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, R> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R></h3></section><section id="impl-Sync-for-Mutex%3CT,+R%3E" class="impl"><a class="src rightside" href="../../src/spin/mutex.rs.html#117">source</a><a href="#impl-Sync-for-Mutex%3CT,+R%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, R> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Mutex%3CT,+R%3E" class="impl"><a href="#impl-Freeze-for-Mutex%3CT,+R%3E" class="anchor">§</a><h3 class="code-header">impl<T, R = <a class="struct" href="../relax/struct.Spin.html" title="struct spin::relax::Spin">Spin</a>> !<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R></h3></section><section id="impl-RefUnwindSafe-for-Mutex%3CT,+R%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Mutex%3CT,+R%3E" class="anchor">§</a><h3 class="code-header">impl<T, R = <a class="struct" href="../relax/struct.Spin.html" title="struct spin::relax::Spin">Spin</a>> !<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R></h3></section><section id="impl-Unpin-for-Mutex%3CT,+R%3E" class="impl"><a href="#impl-Unpin-for-Mutex%3CT,+R%3E" class="anchor">§</a><h3 class="c
|
|||
|
|
R: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section><section id="impl-UnwindSafe-for-Mutex%3CT,+R%3E" class="impl"><a href="#impl-UnwindSafe-for-Mutex%3CT,+R%3E" class="anchor">§</a><h3 class="code-header">impl<T, R> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a><T, R><div class="where">where
|
|||
|
|
R: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/any.rs.html#138">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|||
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/any.rs.html#139">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#209">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#211">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#217">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#218">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3C!%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#782">source</a><a href="#impl-From%3C!%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.never.html">!</a>> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#783">source</a><a href="#method.from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.never.html">!</a>) -> T</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|||
|
|
<p>That is, this conversion is whatever the implementation of
|
|||
|
|
<code><a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#809">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#794">source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
|