mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-25 19:39:32 +01:00
101 lines
36 KiB
HTML
101 lines
36 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 mutex based on critical sections."><title>Mutex in critical_section - 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="critical_section" 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="../critical_section/index.html">critical_<wbr>section</a><span class="version">1.2.0</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="#design" title="Design">Design</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.borrow" title="borrow">borrow</a></li><li><a href="#method.borrow_ref" title="borrow_ref">borrow_ref</a></li><li><a href="#method.borrow_ref_mut" title="borrow_ref_mut">borrow_ref_mut</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.new" title="new">new</a></li><li><a href="#method.replace" title="replace">replace</a></li><li><a href="#method.replace_with" title="replace_with">replace_with</a></li><li><a href="#method.take" title="take">take</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%3E" title="Debug">Debug</a></li><li><a href="#impl-Sync-for-Mutex%3CT%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%3E" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Mutex%3CT%3E" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Mutex%3CT%3E" title="Send">Send</a></li><li><a href="#impl-Unpin-for-Mutex%3CT%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Mutex%3CT%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a
|
|||
|
|
<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">static </span>FOO: Mutex<Cell<i32>> = Mutex::new(Cell::new(<span class="number">42</span>));
|
|||
|
|
|
|||
|
|
<span class="kw">fn </span>main() {
|
|||
|
|
critical_section::with(|cs| {
|
|||
|
|
FOO.borrow(cs).set(<span class="number">43</span>);
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn </span>interrupt_handler() {
|
|||
|
|
<span class="kw">let </span>_x = critical_section::with(|cs| FOO.borrow(cs).get());
|
|||
|
|
}</code></pre></div>
|
|||
|
|
<h2 id="design"><a class="doc-anchor" href="#design">§</a>Design</h2>
|
|||
|
|
<p><a href="https://doc.rust-lang.org/std/sync/struct.Mutex.html"><code>std::sync::Mutex</code></a> has two purposes. It converts types that are <a href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send"><code>Send</code></a>
|
|||
|
|
but not <a href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync"><code>Sync</code></a> into types that are both; and it provides
|
|||
|
|
<a href="https://doc.rust-lang.org/reference/interior-mutability.html">interior mutability</a>. <code>critical_section::Mutex</code>, on the other hand, only adds
|
|||
|
|
<code>Sync</code>. It does <em>not</em> provide interior mutability.</p>
|
|||
|
|
<p>This was a conscious design choice. It is possible to create multiple
|
|||
|
|
<a href="struct.CriticalSection.html" title="struct critical_section::CriticalSection"><code>CriticalSection</code></a> tokens, either by nesting critical sections or <code>Copy</code>ing
|
|||
|
|
an existing token. As a result, it would not be sound for <a href="struct.Mutex.html#method.borrow" title="method critical_section::Mutex::borrow"><code>Mutex::borrow</code></a>
|
|||
|
|
to return <code>&mut T</code>, because there would be nothing to prevent calling
|
|||
|
|
<code>borrow</code> multiple times to create aliased <code>&mut T</code> references.</p>
|
|||
|
|
<p>The solution is to include a runtime check to ensure that each resource is
|
|||
|
|
borrowed only once. This is what <code>std::sync::Mutex</code> does. However, this is
|
|||
|
|
a runtime cost that may not be required in all circumstances. For instance,
|
|||
|
|
<code>Mutex<Cell<T>></code> never needs to create <code>&mut T</code> or equivalent.</p>
|
|||
|
|
<p>If <code>&mut T</code> is needed, the simplest solution is to use <code>Mutex<RefCell<T>></code>,
|
|||
|
|
which is the closest analogy to <code>std::sync::Mutex</code>. <a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html" title="struct core::cell::RefCell"><code>RefCell</code></a> inserts the
|
|||
|
|
exact runtime check necessary to guarantee that the <code>&mut T</code> reference is
|
|||
|
|
unique.</p>
|
|||
|
|
<p>To reduce verbosity when using <code>Mutex<RefCell<T>></code>, we reimplement some of
|
|||
|
|
<code>RefCell</code>’s methods on it directly.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
|
|||
|
|
<span class="kw">static </span>FOO: Mutex<RefCell<i32>> = Mutex::new(RefCell::new(<span class="number">42</span>));
|
|||
|
|
|
|||
|
|
<span class="kw">fn </span>main() {
|
|||
|
|
critical_section::with(|cs| {
|
|||
|
|
<span class="comment">// Instead of calling this
|
|||
|
|
</span><span class="kw">let _ </span>= FOO.borrow(cs).take();
|
|||
|
|
<span class="comment">// Call this
|
|||
|
|
</span><span class="kw">let _ </span>= FOO.take(cs);
|
|||
|
|
<span class="comment">// `RefCell::borrow` and `RefCell::borrow_mut` are renamed to
|
|||
|
|
// `borrow_ref` and `borrow_ref_mut` to avoid name collisions
|
|||
|
|
</span><span class="kw">let _</span>: <span class="kw-2">&mut </span>i32 = <span class="kw-2">&mut *</span>FOO.borrow_ref_mut(cs);
|
|||
|
|
})
|
|||
|
|
}</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%3E" class="impl"><a class="src rightside" href="../src/critical_section/mutex.rs.html#86-117">source</a><a href="#impl-Mutex%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="struct" href="struct.Mutex.html" title="struct critical_section::Mutex">Mutex</a><T></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/critical_section/mutex.rs.html#89-93">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 mutex.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><a class="src rightside" href="../src/critical_section/mutex.rs.html#102-104">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>Gets a mutable reference to the contained value when the mutex is already uniquely borrowed.</p>
|
|||
|
|
<p>This does not require locking or a critical section since it takes <code>&mut self</code>, which
|
|||
|
|
guarantees unique ownership already. Care must be taken when using this method to
|
|||
|
|
<strong>unsafely</strong> access <code>static mut</code> variables, appropriate fences must be used to prevent
|
|||
|
|
unwanted optimizations.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_inner" class="method"><a class="src rightside" href="../src/critical_section/mutex.rs.html#108-110">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>Unwraps the contained value, consuming the mutex.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method"><a class="src rightside" href="../src/critical_section/mutex.rs.html#114-116">source</a><h4 class="code-header">pub fn <a href="#method.borrow" class="fn">borrow</a><'cs>(&'cs self, _cs: <a class="struct" href="struct.CriticalSection.html" title="struct critical_section::CriticalSection">CriticalSection</a><'cs>) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&'cs T</a></h4></section></summary><div class="docblock"><p>Borrows the data for the duration of the critical section.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Mutex%3CRefCell%3CT%3E%3E" class="impl"><a class="src rightside" href="../src/critical_section/mutex.rs.html#119-178">source</a><a href="#impl-Mutex%3CRefCell%3CT%3E%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="struct" href="struct.Mutex.html" title="struct critical_section::Mutex">Mutex</a><<a class="struct" href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html" title="struct core::cell::RefCell">RefCell</a><T>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.replace" class="method"><a class="src rightside" href="../src/critical_section/mutex.rs.html#130-132">source</a><h4 class="code-header">pub fn <a href="#method.replace" class="fn">replace</a><'cs>(&'cs self, cs: <a class="struct" href="struct.CriticalSection.html" title="struct critical_section::CriticalSection">CriticalSection</a><'cs>, t: T) -> T</h4></section></summary><div class="docblock"><p>Borrow the data and call <a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html#method.replace" title="method core::cell::RefCell::replace"><code>RefCell::replace</code></a></p>
|
|||
|
|
<p>This is equivalent to <code>self.borrow(cs).replace(t)</code></p>
|
|||
|
|
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
|||
|
|
<p>This call could panic. See the documentation for <a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html#method.replace" title="method core::cell::RefCell::replace"><code>RefCell::replace</code></a>
|
|||
|
|
for more details.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.replace_with" class="method"><a class="src rightside" href="../src/critical_section/mutex.rs.html#144-149">source</a><h4 class="code-header">pub fn <a href="#method.replace_with" class="fn">replace_with</a><'cs, F>(&'cs self, cs: <a class="struct" href="struct.CriticalSection.html" title="struct critical_section::CriticalSection">CriticalSection</a><'cs>, f: F) -> T<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&mut T</a>) -> T,</div></h4></section></summary><div class="docblock"><p>Borrow the data and call <a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html#method.replace_with" title="method core::cell::RefCell::replace_with"><code>RefCell::replace_with</code></a></p>
|
|||
|
|
<p>This is equivalent to <code>self.borrow(cs).replace_with(f)</code></p>
|
|||
|
|
<h5 id="panics-1"><a class="doc-anchor" href="#panics-1">§</a>Panics</h5>
|
|||
|
|
<p>This call could panic. See the documentation for
|
|||
|
|
<a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html#method.replace_with" title="method core::cell::RefCell::replace_with"><code>RefCell::replace_with</code></a> for more details.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.borrow_ref" class="method"><a class="src rightside" href="../src/critical_section/mutex.rs.html#161-163">source</a><h4 class="code-header">pub fn <a href="#method.borrow_ref" class="fn">borrow_ref</a><'cs>(&'cs self, cs: <a class="struct" href="struct.CriticalSection.html" title="struct critical_section::CriticalSection">CriticalSection</a><'cs>) -> <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><'cs, T></h4></section></summary><div class="docblock"><p>Borrow the data and call <a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html#method.borrow" title="method core::cell::RefCell::borrow"><code>RefCell::borrow</code></a></p>
|
|||
|
|
<p>This is equivalent to <code>self.borrow(cs).borrow()</code></p>
|
|||
|
|
<h5 id="panics-2"><a class="doc-anchor" href="#panics-2">§</a>Panics</h5>
|
|||
|
|
<p>This call could panic. See the documentation for <a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html#method.borrow" title="method core::cell::RefCell::borrow"><code>RefCell::borrow</code></a>
|
|||
|
|
for more details.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.borrow_ref_mut" class="method"><a class="src rightside" href="../src/critical_section/mutex.rs.html#175-177">source</a><h4 class="code-header">pub fn <a href="#method.borrow_ref_mut" class="fn">borrow_ref_mut</a><'cs>(
|
|||
|
|
&'cs self,
|
|||
|
|
cs: <a class="struct" href="struct.CriticalSection.html" title="struct critical_section::CriticalSection">CriticalSection</a><'cs>,
|
|||
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefMut.html" title="struct core::cell::RefMut">RefMut</a><'cs, T></h4></section></summary><div class="docblock"><p>Borrow the data and call <a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html#method.borrow_mut" title="method core::cell::RefCell::borrow_mut"><code>RefCell::borrow_mut</code></a></p>
|
|||
|
|
<p>This is equivalent to <code>self.borrow(cs).borrow_mut()</code></p>
|
|||
|
|
<h5 id="panics-3"><a class="doc-anchor" href="#panics-3">§</a>Panics</h5>
|
|||
|
|
<p>This call could panic. See the documentation for <a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html#method.borrow_mut" title="method core::cell::RefCell::borrow_mut"><code>RefCell::borrow_mut</code></a>
|
|||
|
|
for more details.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Mutex%3CRefCell%3CT%3E%3E-1" class="impl"><a class="src rightside" href="../src/critical_section/mutex.rs.html#180-194">source</a><a href="#impl-Mutex%3CRefCell%3CT%3E%3E-1" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> <a class="struct" href="struct.Mutex.html" title="struct critical_section::Mutex">Mutex</a><<a class="struct" href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html" title="struct core::cell::RefCell">RefCell</a><T>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.take" class="method"><a class="src rightside" href="../src/critical_section/mutex.rs.html#191-193">source</a><h4 class="code-header">pub fn <a href="#method.take" class="fn">take</a><'cs>(&'cs self, cs: <a class="struct" href="struct.CriticalSection.html" title="struct critical_section::CriticalSection">CriticalSection</a><'cs>) -> T</h4></section></summary><div class="docblock"><p>Borrow the data and call <a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html#method.take" title="method core::cell::RefCell::take"><code>RefCell::take</code></a></p>
|
|||
|
|
<p>This is equivalent to <code>self.borrow(cs).take()</code></p>
|
|||
|
|
<h5 id="panics-4"><a class="doc-anchor" href="#panics-4">§</a>Panics</h5>
|
|||
|
|
<p>This call could panic. See the documentation for <a href="https://doc.rust-lang.org/1.83.0/core/cell/struct.RefCell.html#method.take" title="method core::cell::RefCell::take"><code>RefCell::take</code></a>
|
|||
|
|
for more details.</p>
|
|||
|
|
</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%3E" class="impl"><a class="src rightside" href="../src/critical_section/mutex.rs.html#73">source</a><a href="#impl-Debug-for-Mutex%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</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> for <a class="struct" href="struct.Mutex.html" title="struct critical_section::Mutex">Mutex</a><T></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/critical_section/mutex.rs.html#73">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><section id="impl-Sync-for-Mutex%3CT%3E" class="impl"><a class="src rightside" href="../src/critical_section/mutex.rs.html#199">source</a><a href="#impl-Sync-for-Mutex%3CT%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.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Mutex.html" title="struct critical_section::Mutex">Mutex</a><T><div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></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%3E" class="impl"><a href="#impl-Freeze-for-Mutex%3CT%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.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Mutex.html" title="struct critical_section::Mutex">Mutex</a><T></h3></section><section id="impl-RefUnwindSafe-for-Mutex%3CT%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Mutex%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> !<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 critical_section::Mutex">Mutex</a><T></h3></section><section id="impl-Send-for-Mutex%3CT%3E" class="impl"><a href="#impl-Send-for-Mutex%3CT%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.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Mutex.html" title="struct critical_section::Mutex">Mutex</a><T><div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Unpin-for-Mutex%3CT%3E" class="impl"><a href="#impl-Unpin-for-Mutex%3CT%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.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Mutex.html" title="struct critical_section::Mutex">Mutex</a><T><div class="where">where
|
|||
|
|
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>,</div></h3></section><section id="impl-UnwindSafe-for-Mutex%3CT%3E" class="impl"><a href="#impl-UnwindSafe-for-Mutex%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<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> for <a class="struct" href="struct.Mutex.html" title="struct critical_section::Mutex">Mutex</a><T><div class="where">where
|
|||
|
|
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>,</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-1" 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-1" 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%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" 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" 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>
|