<!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="API documentation for the Rust `Mutex` struct in crate `spin_sync`."><meta name="keywords" content="rust, rustlang, rust-lang, Mutex"><title>spin_sync::Mutex - 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><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 struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../spin_sync/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Struct Mutex</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.get_mut">get_mut</a><a href="#method.into_inner">into_inner</a><a href="#method.is_poisoned">is_poisoned</a><a href="#method.lock">lock</a><a href="#method.new">new</a><a href="#method.try_lock">try_lock</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Unpin">Unpin</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3C!%3E">From<!></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="index.html">spin_sync</a></p><script>window.sidebarCurrent = {name: "Mutex", ty: "struct", relpath: ""};</script><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"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><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><span class="help-button">?</span>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><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/spin_sync/mutex.rs.html#167-171" title="goto source code">[src]</a></span><span class="in-band">Struct <a href="index.html">spin_sync</a>::<wbr><a class="struct" href="">Mutex</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Mutex<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> { /* fields omitted */ }</pre></div><div class="docblock"><p>A mutual exclusion primitive useful for protecting shared data.</p>
<p>It behaves like std::sync::Mutex except for using spinlock.
What is more, the constructor is a const function; i.e. it is possible to declare
static Mutex<T> variable as long as the inner data can be built statically.</p>
<p>This mutex will block threads waiting for the lock to become available. The
mutex can also be statically initialized or created via a <a href="#method.new"><code>new</code></a>
constructor. Each mutex has a type parameter which represents the data that
it is protecting. The data can only be accessed through the RAII guards
returned from <a href="#method.lock"><code>lock</code></a> and <a href="#method.try_lock"><code>try_lock</code></a>, which guarantees that the data is only
ever accessed when the mutex is locked.</p>
<h1 id="poisoning" class="section-header"><a href="#poisoning">Poisoning</a></h1>
<p>The mutexes in this module implement a strategy called "poisoning" where a
mutex is considered poisoned whenever a thread panics while holding the
mutex. Once a mutex is poisoned, all other threads are unable to access the
data by default as it is likely tainted.</p>
<p>For a mutex, this means that the <a href="#method.lock"><code>lock</code></a> and <a href="#method.try_lock"><code>try_lock</code></a> methods return a
<code>Result</code> which indicates whether a mutex has been poisoned or not. Most
usage of a mutex will simply <code>unwrap()</code> these results, propagating panics
among threads to ensure that a possibly invalid invariant is not witnessed.</p>
<p>A poisoned mutex, however, does not prevent all access to the underlying
data. The <a href="type.PoisonError.html"><code>PoisonError</code></a> type has an <code>into_inner</code> method which will return
the guard that would have otherwise been returned on a successful lock. This
allows access to the data, despite the lock being poisoned.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<p>Protect a variable (non-atomically) and update it in worker threads.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">spin_sync</span>::<span class="ident">Mutex</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="kw">const</span> <span class="ident">WORKER_NUM</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">10</span>;
<span class="comment">// We can declare static Mutex<usize> variable because Mutex::new is const.</span>
<span class="kw">static</span> <span class="ident">MUTEX</span>: <span class="ident">Mutex</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> <span class="op">=</span> <span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="number">0</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">handles</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="ident">WORKER_NUM</span>);
<span class="comment">// Create worker threads to inclement the value by 1.</span>
<span class="kw">for</span> <span class="kw">_</span> <span class="kw">in</span> <span class="number">0</span>..<span class="ident">WORKER_NUM</span> {
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">num</span> <span class="op">=</span> <span class="ident">MUTEX</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>();
<span class="kw-2">*</span><span class="ident">num</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
});
<span class="ident">handles</span>.<span class="ident">push</span>(<span class="ident">handle</span>);
}
<span class="comment">// Wait for the all worker threads are finished.</span>
<span class="kw">for</span> <span class="ident">handle</span> <span class="kw">in</span> <span class="ident">handles</span> {
<span class="ident">handle</span>.<span class="ident">join</span>().<span class="ident">unwrap</span>();
}
<span class="comment">// Make sure the value is incremented by the worker count.</span>
<span class="kw">let</span> <span class="ident">num</span> <span class="op">=</span> <span class="ident">MUTEX</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">WORKER_NUM</span>, <span class="kw-2">*</span><span class="ident">num</span>);</pre></div>
<p>To recover from a poisoned mutex:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">spin_sync</span>::<span class="ident">Mutex</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="comment">// Like std::sync::Mutex, it can be declare as local variable, of course.</span>
<span class="kw">let</span> <span class="ident">mutex</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="number">0</span>));
<span class="kw">let</span> <span class="ident">c_mutex</span> <span class="op">=</span> <span class="ident">mutex</span>.<span class="ident">clone</span>();
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> <span class="op">-</span><span class="op">></span> () {
<span class="comment">// This thread will acquire the mutex first, unwrapping the result of</span>
<span class="comment">// `lock` because the lock has not been poisoned.</span>
<span class="kw">let</span> <span class="ident">_guard</span> <span class="op">=</span> <span class="ident">c_mutex</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>();
<span class="comment">// This panic while holding the lock (`_guard` is in scope) will poison</span>
<span class="comment">// the mutex.</span>
<span class="macro">panic</span><span class="macro">!</span>();
}).<span class="ident">join</span>();
<span class="comment">// Here, the mutex has been poisoned.</span>
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="bool-val">true</span>, <span class="ident">mutex</span>.<span class="ident">is_poisoned</span>());
<span class="comment">// The returned result can be pattern matched on to return the underlying</span>
<span class="comment">// guard on both branches.</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">guard</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">mutex</span>.<span class="ident">lock</span>() {
<span class="prelude-val">Ok</span>(<span class="ident">guard</span>) <span class="op">=</span><span class="op">></span> <span class="ident">guard</span>,
<span class="prelude-val">Err</span>(<span class="ident">poisoned</span>) <span class="op">=</span><span class="op">></span> <span class="ident">poisoned</span>.<span class="ident">into_inner</span>(),
};
<span class="kw-2">*</span><span class="ident">guard</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">1</span>, <span class="kw-2">*</span><span class="ident">guard</span>);</pre></div>
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<T> <a class="struct" href="../spin_sync/struct.Mutex.html" title="struct spin_sync::Mutex">Mutex</a><T></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/spin_sync/mutex.rs.html#173-232" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub const fn <a href="#method.new" class="fnname">new</a>(t: T) -> Self</code><a class="srclink" href="../src/spin_sync/mutex.rs.html#196-202" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new mutex in an unlocked state ready for use.</p>
<p>unlike to <code>std::sync::Mutex::new</code>, this is a const function.
It can be use for static variable.</p>
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<p>Declare as a static variable.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">spin_sync</span>::<span class="ident">Mutex</span>;
<span class="kw">static</span> <span class="ident">MUTEX</span>: <span class="ident">Mutex</span><span class="op"><</span><span class="ident">i32</span><span class="op">></span> <span class="op">=</span> <span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="number">0</span>);</pre></div>
<p>Declare as a local variable.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">spin_sync</span>::<span class="ident">Mutex</span>;
<span class="kw">let</span> <span class="ident">mutex</span> <span class="op">=</span> <span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="number">0</span>);</pre></div>
</div><h4 id="method.into_inner" class="method"><code>pub fn <a href="#method.into_inner" class="fnname">into_inner</a>(self) -> <a class="type" href="../spin_sync/type.LockResult.html" title="type spin_sync::LockResult">LockResult</a><T></code><a class="srclink" href="../src/spin_sync/mutex.rs.html#222-231" title="goto source code">[src]</a></h4><div class="docblock"><p>Consumes this mutex and returns the underlying data.</p>
<p>Note that this method won't acquire any lock because we know there is
no other references to <code>self</code>.</p>
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
<p>If another user panicked while holding this mutex, this call wraps
the result in an error and returns it.</p>
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">spin_sync</span>::<span class="ident">Mutex</span>;
<span class="kw">let</span> <span class="ident">mutex</span> <span class="op">=</span> <span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="number">0</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0</span>, <span class="ident">mutex</span>.<span class="ident">into_inner</span>().<span class="ident">unwrap</span>());</pre></div>
</div></div><h3 id="impl-1" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="../spin_sync/struct.Mutex.html" title="struct spin_sync::Mutex">Mutex</a><T></code><a href="#impl-1" class="anchor"></a><a class="srclink" href="../src/spin_sync/mutex.rs.html#234-431" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.lock" class="method"><code>pub fn <a href="#method.lock" class="fnname">lock</a>(&self) -> <a class="type" href="../spin_sync/type.LockResult.html" title="type spin_sync::LockResult">LockResult</a><<a class="struct" href="../spin_sync/struct.MutexGuard.html" title="struct spin_sync::MutexGuard">MutexGuard</a><'_, T>></code><a class="srclink" href="../src/spin_sync/mutex.rs.html#268-276" title="goto source code">[src]</a></h4><div class="docblock"><p>Blocks the current thread until acquiring the lock, and returns an RAII guard object.</p>
<p>The actual flow will be as follows.</p>
<ol>
<li>User calls this method.
<ol>
<li>Blocks until this thread acquires the exclusive lock.</li>
<li>Creates an RAII guard object.</li>
<li>Wraps the guard in <code>Result</code> and returns it. If this mutex has been
poisoned, it is wrapped in an <code>Err</code>; otherwise wrapped in a <code>Ok</code>.</li>
</ol>
</li>
<li>User accesses to the underlying data through the returned guard.
(No other thread can access to the data then.)</li>
<li>The guard is dropped (falls out of scope) and the lock is released.</li>
</ol>
<h1 id="errors-1" class="section-header"><a href="#errors-1">Errors</a></h1>
<p>If another user panicked while holding this mutex, this method call wraps
the guard in an error and returns it.</p>
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">spin_sync</span>::<span class="ident">Mutex</span>;
<span class="kw">let</span> <span class="ident">mutex</span> <span class="op">=</span> <span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="number">0</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">guard</span> <span class="op">=</span> <span class="ident">mutex</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0</span>, <span class="kw-2">*</span><span class="ident">guard</span>);
<span class="kw-2">*</span><span class="ident">guard</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">1</span>, <span class="kw-2">*</span><span class="ident">guard</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="bool-val">true</span>, <span class="ident">mutex</span>.<span class="ident">try_lock</span>().<span class="ident">is_err</span>());</pre></div>
</div><h4 id="method.try_lock" class="method"><code>pub fn <a href="#method.try_lock" class="fnname">try_lock</a>(&self) -> <a class="type" href="../spin_sync/type.TryLockResult.html" title="type spin_sync::TryLockResult">TryLockResult</a><<a class="struct" href="../spin_sync/struct.MutexGuard.html" title="struct spin_sync::MutexGuard">MutexGuard</a><'_, T>></code><a class="srclink" href="../src/spin_sync/mutex.rs.html#331-339" title="goto source code">[src]</a></h4><div class="docblock"><p>Attempts to acquire this lock and returns an RAII guard object if succeeded.</p>
<p>Behaves like <a href="#method.lock"><code>lock</code></a> except for this method returns an error immediately if another
user is holding the lock.</p>
<p>This method does not block.</p>
<p>The actual flow will be as follows.</p>
<ol>
<li>User calls this method.
<ol>
<li>Tries to acquire the lock. If failed (i.e. if the lock is being held,)
returns an error immediately and this flow is finished here.</li>
<li>Creates an RAII guard object.</li>
<li>Wrapps the guard in <code>Result</code> and returns it. If this mutex has been
poisoned, it is wrapped in an <code>Err</code>; otherwise wrapped in an <code>Ok</code>.</li>
</ol>
</li>
<li>User accesses to the underlying data through the returned guard.
(No other thread can access to the data then.)</li>
<li>The guard is dropped (falls out of scope) and the lock is released.</li>
</ol>
<h1 id="errors-2" class="section-header"><a href="#errors-2">Errors</a></h1>
<ul>
<li>If another user is holding this mutex, <a href="type.TryLockError.html"><code>TryLockError::WouldBlock</code></a> is returned.</li>
<li>If this function call succeeded to acquire the lock, and if another
user panicked while holding this mutex, <a href="type.TryLockError.html"><code>TryLockError::Poisoned</code></a> is returned.</li>
</ul>
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">spin_sync</span>::<span class="ident">Mutex</span>;
<span class="kw">let</span> <span class="ident">mutex</span> <span class="op">=</span> <span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="number">0</span>);
<span class="comment">// try_lock() fails while another guard is.</span>
<span class="comment">// It doesn't cause a deadlock.</span>
{
<span class="kw">let</span> <span class="ident">_guard</span> <span class="op">=</span> <span class="ident">mutex</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="bool-val">true</span>, <span class="ident">mutex</span>.<span class="ident">try_lock</span>().<span class="ident">is_err</span>());
}
<span class="comment">// try_lock() behaves like lock() if no other guard is.</span>
{
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">guard</span> <span class="op">=</span> <span class="ident">mutex</span>.<span class="ident">try_lock</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="bool-val">true</span>, <span class="ident">mutex</span>.<span class="ident">try_lock</span>().<span class="ident">is_err</span>());
<span class="kw-2">*</span><span class="ident">guard</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
}
<span class="kw">let</span> <span class="ident">guard</span> <span class="op">=</span> <span class="ident">mutex</span>.<span class="ident">try_lock</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">1</span>, <span class="kw-2">*</span><span class="ident">guard</span>);</pre></div>
</div><h4 id="method.is_poisoned" class="method"><code>pub fn <a href="#method.is_poisoned" class="fnname">is_poisoned</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../src/spin_sync/mutex.rs.html#393-398" title="goto source code">[src]</a></h4><div class="docblock"><p>Determines whether the mutex is poisoned or not.</p>
<h1 id="warnings" class="section-header"><a href="#warnings">Warnings</a></h1>
<p>This function won't acquire any lock. If another thread is active,
the mutex can become poisoned at any time. You should not trust a <code>false</code>
value for program correctness without additional synchronization.</p>
<p>This behavior is same to <code>std::sync::Mutex::is_poisoned()</code>.</p>
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">spin_sync</span>::<span class="ident">Mutex</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="kw">let</span> <span class="ident">mutex</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="number">0</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="bool-val">false</span>, <span class="ident">mutex</span>.<span class="ident">is_poisoned</span>());
<span class="comment">// Panic and poison the mutex.</span>
{
<span class="kw">let</span> <span class="ident">mutex</span> <span class="op">=</span> <span class="ident">mutex</span>.<span class="ident">clone</span>();
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
<span class="comment">// This panic while holding the lock (`_guard` is in scope) will poison</span>
<span class="comment">// the mutex.</span>
<span class="kw">let</span> <span class="ident">_guard</span> <span class="op">=</span> <span class="ident">mutex</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>();
<span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Poison here"</span>);
}).<span class="ident">join</span>();
}
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="bool-val">true</span>, <span class="ident">mutex</span>.<span class="ident">is_poisoned</span>());</pre></div>
</div><h4 id="method.get_mut" class="method"><code>pub fn <a href="#method.get_mut" class="fnname">get_mut</a>(&mut self) -> <a class="type" href="../spin_sync/type.LockResult.html" title="type spin_sync::LockResult">LockResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T></code><a class="srclink" href="../src/spin_sync/mutex.rs.html#419-430" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the underlying data.</p>
<p>Note that this method won't acquire any lock because we know there is
no other references to <code>self</code>.</p>
<h1 id="errors-3" class="section-header"><a href="#errors-3">Errors</a></h1>
<p>If another user panicked while holding this mutex, this method call
wraps the result in an error and returns it.</p>
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">spin_sync</span>::<span class="ident">Mutex</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">mutex</span> <span class="op">=</span> <span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="number">0</span>);
<span class="kw-2">*</span><span class="ident">mutex</span>.<span class="ident">get_mut</span>().<span class="ident">unwrap</span>() <span class="op">=</span> <span class="number">10</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">10</span>, <span class="kw-2">*</span><span class="ident">mutex</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>());</pre></div>
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../spin_sync/struct.Mutex.html" title="struct spin_sync::Mutex">Mutex</a><T></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../src/spin_sync/mutex.rs.html#433-455" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../src/spin_sync/mutex.rs.html#434-454" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id="impl-Default" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../spin_sync/struct.Mutex.html" title="struct spin_sync::Mutex">Mutex</a><T></code><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../src/spin_sync/mutex.rs.html#463-467" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.default" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</code><a class="srclink" href="../src/spin_sync/mutex.rs.html#464-466" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for <a class="struct" href="../spin_sync/struct.Mutex.html" title="struct spin_sync::Mutex">Mutex</a><T></code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="../src/spin_sync/mutex.rs.html#457-461" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> Self</code><a class="srclink" href="../src/spin_sync/mutex.rs.html#458-460" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../spin_sync/struct.Mutex.html" title="struct spin_sync::Mutex">Mutex</a><T></code><a href="#impl-RefUnwindSafe" class="anchor"></a><a class="srclink" href="../src/spin_sync/mutex.rs.html#542" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../spin_sync/struct.Mutex.html" title="struct spin_sync::Mutex">Mutex</a><T></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../src/spin_sync/mutex.rs.html#544" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../spin_sync/struct.Mutex.html" title="struct spin_sync::Mutex">Mutex</a><T></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../src/spin_sync/mutex.rs.html#545" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../spin_sync/struct.Mutex.html" title="struct spin_sync::Mutex">Mutex</a><T></code><a href="#impl-UnwindSafe" class="anchor"></a><a class="srclink" href="../src/spin_sync/mutex.rs.html#541" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../spin_sync/struct.Mutex.html" title="struct spin_sync::Mutex">Mutex</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#108-112" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#109-111" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210-214" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211-213" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217-221" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id="impl-From%3C!%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.never.html">!</a>> for T</code><a href="#impl-From%3C!%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#567-571" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-2" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.never.html">!</a>) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-570" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id="impl-From%3CT%3E-1" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E-1" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#552-556" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-1" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#553-555" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#541-548" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-547" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#589-598" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#595-597" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#575-584" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#581-583" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "spin_sync";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>