mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 15:04:32 +01:00
113 lines
46 KiB
HTML
113 lines
46 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 which can be recursively locked by a single thread."><title>ReentrantMutex in lock_api - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="lock_api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc 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="../lock_api/index.html">lock_<wbr>api</a><span class="version">0.4.12</span></h2></div><h2 class="location"><a href="#">Reentrant<wbr>Mutex</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.const_new">const_new</a></li><li><a href="#method.data_ptr">data_ptr</a></li><li><a href="#method.force_unlock">force_unlock</a></li><li><a href="#method.force_unlock_fair">force_unlock_fair</a></li><li><a href="#method.from_raw">from_raw</a></li><li><a href="#method.get_mut">get_mut</a></li><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.is_locked">is_locked</a></li><li><a href="#method.is_owned_by_current_thread">is_owned_by_current_thread</a></li><li><a href="#method.lock">lock</a></li><li><a href="#method.make_guard_unchecked">make_guard_unchecked</a></li><li><a href="#method.new">new</a></li><li><a href="#method.raw">raw</a></li><li><a href="#method.try_lock">try_lock</a></li><li><a href="#method.try_lock_for">try_lock_for</a></li><li><a href="#method.try_lock_until">try_lock_until</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-ReentrantMutex%3CR,+G,+T%3E">Debug</a></li><li><a href="#impl-Default-for-ReentrantMutex%3CR,+G,+T%3E">Default</a></li><li><a href="#impl-From%3CT%3E-for-ReentrantMutex%3CR,+G,+T%3E">From<T></a></li><li><a href="#impl-Send-for-ReentrantMutex%3CR,+G,+T%3E">Send</a></li><li><a href="#impl-Sync-for-ReentrantMutex%3CR,+G,+T%3E">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-ReentrantMutex%3CR,+G,+T%3E">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-ReentrantMutex%3CR,+G,+T%3E">!RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-ReentrantMutex%3CR,+G,+T%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ReentrantMutex%3CR,+G,+T%3E">UnwindSafe</a></li></ul><h3><a href="#bl
|
||
|
|
<p>This type is identical to <code>Mutex</code> except for the following points:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Locking multiple times from the same thread will work correctly instead of
|
||
|
|
deadlocking.</li>
|
||
|
|
<li><code>ReentrantMutexGuard</code> does not give mutable references to the locked data.
|
||
|
|
Use a <code>RefCell</code> if you need this.</li>
|
||
|
|
</ul>
|
||
|
|
<p>See <a href="struct.Mutex.html" title="struct lock_api::Mutex"><code>Mutex</code></a> for more details about the underlying mutex
|
||
|
|
primitive.</p>
|
||
|
|
</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-ReentrantMutex%3CR,+G,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/remutex.rs.html#230-266">source</a><a href="#impl-ReentrantMutex%3CR,+G,+T%3E" class="anchor">§</a><h3 class="code-header">impl<R: <a class="trait" href="trait.RawMutex.html" title="trait lock_api::RawMutex">RawMutex</a>, G: <a class="trait" href="trait.GetThreadId.html" title="trait lock_api::GetThreadId">GetThreadId</a>, T> <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, 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/lock_api/remutex.rs.html#234-244">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>(val: T) -> <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, T></h4></section></summary><div class="docblock"><p>Creates a new reentrant mutex in an unlocked state ready for use.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_inner" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#263-265">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 mutex, returning the underlying data.</p>
|
||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-ReentrantMutex%3CR,+G,+T%3E-1" class="impl"><a class="src rightside" href="../src/lock_api/remutex.rs.html#268-295">source</a><a href="#impl-ReentrantMutex%3CR,+G,+T%3E-1" class="anchor">§</a><h3 class="code-header">impl<R, G, T> <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_raw" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#272-282">source</a><h4 class="code-header">pub const fn <a href="#method.from_raw" class="fn">from_raw</a>(
|
||
|
|
raw_mutex: R,
|
||
|
|
get_thread_id: G,
|
||
|
|
val: T,
|
||
|
|
) -> <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, T></h4></section></summary><div class="docblock"><p>Creates a new reentrant mutex based on a pre-existing raw mutex and a
|
||
|
|
helper to get the thread ID.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.const_new" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#292-294">source</a><h4 class="code-header">pub const fn <a href="#method.const_new" class="fn">const_new</a>(
|
||
|
|
raw_mutex: R,
|
||
|
|
get_thread_id: G,
|
||
|
|
val: T,
|
||
|
|
) -> <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, T></h4></section></summary><div class="docblock"><p>Creates a new reentrant mutex based on a pre-existing raw mutex and a
|
||
|
|
helper to get the thread ID.</p>
|
||
|
|
<p>This allows creating a reentrant mutex in a constant context on stable
|
||
|
|
Rust.</p>
|
||
|
|
<p>This method is a legacy alias for <a href="struct.ReentrantMutex.html#method.from_raw" title="associated function lock_api::ReentrantMutex::from_raw"><code>from_raw</code></a>.</p>
|
||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-ReentrantMutex%3CR,+G,+T%3E-2" class="impl"><a class="src rightside" href="../src/lock_api/remutex.rs.html#297-459">source</a><a href="#impl-ReentrantMutex%3CR,+G,+T%3E-2" class="anchor">§</a><h3 class="code-header">impl<R: <a class="trait" href="trait.RawMutex.html" title="trait lock_api::RawMutex">RawMutex</a>, G: <a class="trait" href="trait.GetThreadId.html" title="trait lock_api::GetThreadId">GetThreadId</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.make_guard_unchecked" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#307-312">source</a><h4 class="code-header">pub unsafe fn <a href="#method.make_guard_unchecked" class="fn">make_guard_unchecked</a>(&self) -> <a class="struct" href="struct.ReentrantMutexGuard.html" title="struct lock_api::ReentrantMutexGuard">ReentrantMutexGuard</a><'_, R, G, T></h4></section></summary><div class="docblock"><p>Creates a new <code>ReentrantMutexGuard</code> without checking if the lock is held.</p>
|
||
|
|
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
||
|
|
<p>This method must only be called if the thread logically holds the lock.</p>
|
||
|
|
<p>Calling this function when a guard has already been produced is undefined behaviour unless
|
||
|
|
the guard was forgotten with <code>mem::forget</code>.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.lock" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#325-329">source</a><h4 class="code-header">pub fn <a href="#method.lock" class="fn">lock</a>(&self) -> <a class="struct" href="struct.ReentrantMutexGuard.html" title="struct lock_api::ReentrantMutexGuard">ReentrantMutexGuard</a><'_, R, G, T></h4></section></summary><div class="docblock"><p>Acquires a reentrant mutex, blocking the current thread until it is able
|
||
|
|
to do so.</p>
|
||
|
|
<p>If the mutex is held by another thread then this function will block the
|
||
|
|
local thread until it is available to acquire the mutex. If the mutex is
|
||
|
|
already held by the current thread then this function will increment the
|
||
|
|
lock reference count and return immediately. Upon returning,
|
||
|
|
the thread is the only thread with the mutex held. An RAII guard is
|
||
|
|
returned to allow scoped unlock of the lock. When the guard goes out of
|
||
|
|
scope, the mutex will be unlocked.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_lock" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#339-346">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.82.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.ReentrantMutexGuard.html" title="struct lock_api::ReentrantMutexGuard">ReentrantMutexGuard</a><'_, R, G, T>></h4></section></summary><div class="docblock"><p>Attempts to acquire this lock.</p>
|
||
|
|
<p>If the lock could not be acquired at this time, then <code>None</code> is returned.
|
||
|
|
Otherwise, an RAII guard is returned. The lock will be unlocked when the
|
||
|
|
guard is dropped.</p>
|
||
|
|
<p>This function does not block.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#353-355">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.82.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 <code>ReentrantMutex</code> mutably, no actual locking needs to
|
||
|
|
take place—the mutable borrow statically guarantees no locks exist.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_locked" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#359-361">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.82.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks whether the mutex is currently locked.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_owned_by_current_thread" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#365-367">source</a><h4 class="code-header">pub fn <a href="#method.is_owned_by_current_thread" class="fn">is_owned_by_current_thread</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks whether the mutex is currently held by the current thread.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.force_unlock" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#381-383">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>Forcibly unlocks the mutex.</p>
|
||
|
|
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
||
|
|
the need to maintain a <code>ReentrantMutexGuard</code> object alive, for example when
|
||
|
|
dealing with FFI.</p>
|
||
|
|
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
|
||
|
|
<p>This method must only be called if the current thread logically owns a
|
||
|
|
<code>ReentrantMutexGuard</code> but that guard has be discarded using <code>mem::forget</code>.
|
||
|
|
Behavior is undefined if a mutex is unlocked when not locked.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.raw" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#395-397">source</a><h4 class="code-header">pub unsafe fn <a href="#method.raw" class="fn">raw</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&R</a></h4></section></summary><div class="docblock"><p>Returns the underlying raw mutex object.</p>
|
||
|
|
<p>Note that you will most likely need to import the <code>RawMutex</code> trait from
|
||
|
|
<code>lock_api</code> to be able to call functions on the raw mutex.</p>
|
||
|
|
<h5 id="safety-2"><a class="doc-anchor" href="#safety-2">§</a>Safety</h5>
|
||
|
|
<p>This method is unsafe because it allows unlocking a mutex while
|
||
|
|
still holding a reference to a <code>ReentrantMutexGuard</code>.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.data_ptr" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#412-414">source</a><h4 class="code-header">pub fn <a href="#method.data_ptr" class="fn">data_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut T</a></h4></section></summary><div class="docblock"><p>Returns a raw pointer to the underlying data.</p>
|
||
|
|
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
||
|
|
the need to maintain a <code>ReentrantMutexGuard</code> object alive, for example
|
||
|
|
when dealing with FFI.</p>
|
||
|
|
<h5 id="safety-3"><a class="doc-anchor" href="#safety-3">§</a>Safety</h5>
|
||
|
|
<p>You must ensure that there are no data races when dereferencing the
|
||
|
|
returned pointer, for example if the current thread logically owns a
|
||
|
|
<code>ReentrantMutexGuard</code> but that guard has been discarded using
|
||
|
|
<code>mem::forget</code>.</p>
|
||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-ReentrantMutex%3CR,+G,+T%3E-3" class="impl"><a class="src rightside" href="../src/lock_api/remutex.rs.html#461-477">source</a><a href="#impl-ReentrantMutex%3CR,+G,+T%3E-3" class="anchor">§</a><h3 class="code-header">impl<R: <a class="trait" href="trait.RawMutexFair.html" title="trait lock_api::RawMutexFair">RawMutexFair</a>, G: <a class="trait" href="trait.GetThreadId.html" title="trait lock_api::GetThreadId">GetThreadId</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.force_unlock_fair" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#474-476">source</a><h4 class="code-header">pub unsafe fn <a href="#method.force_unlock_fair" class="fn">force_unlock_fair</a>(&self)</h4></section></summary><div class="docblock"><p>Forcibly unlocks the mutex using a fair unlock protocol.</p>
|
||
|
|
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
||
|
|
the need to maintain a <code>ReentrantMutexGuard</code> object alive, for example when
|
||
|
|
dealing with FFI.</p>
|
||
|
|
<h5 id="safety-4"><a class="doc-anchor" href="#safety-4">§</a>Safety</h5>
|
||
|
|
<p>This method must only be called if the current thread logically owns a
|
||
|
|
<code>ReentrantMutexGuard</code> but that guard has be discarded using <code>mem::forget</code>.
|
||
|
|
Behavior is undefined if a mutex is unlocked when not locked.</p>
|
||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-ReentrantMutex%3CR,+G,+T%3E-4" class="impl"><a class="src rightside" href="../src/lock_api/remutex.rs.html#479-545">source</a><a href="#impl-ReentrantMutex%3CR,+G,+T%3E-4" class="anchor">§</a><h3 class="code-header">impl<R: <a class="trait" href="trait.RawMutexTimed.html" title="trait lock_api::RawMutexTimed">RawMutexTimed</a>, G: <a class="trait" href="trait.GetThreadId.html" title="trait lock_api::GetThreadId">GetThreadId</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.try_lock_for" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#486-493">source</a><h4 class="code-header">pub fn <a href="#method.try_lock_for" class="fn">try_lock_for</a>(
|
||
|
|
&self,
|
||
|
|
timeout: R::<a class="associatedtype" href="trait.RawMutexTimed.html#associatedtype.Duration" title="type lock_api::RawMutexTimed::Duration">Duration</a>,
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.ReentrantMutexGuard.html" title="struct lock_api::ReentrantMutexGuard">ReentrantMutexGuard</a><'_, R, G, T>></h4></section></summary><div class="docblock"><p>Attempts to acquire this lock until a timeout is reached.</p>
|
||
|
|
<p>If the lock could not be acquired before the timeout expired, then
|
||
|
|
<code>None</code> is returned. Otherwise, an RAII guard is returned. The lock will
|
||
|
|
be unlocked when the guard is dropped.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_lock_until" class="method"><a class="src rightside" href="../src/lock_api/remutex.rs.html#501-508">source</a><h4 class="code-header">pub fn <a href="#method.try_lock_until" class="fn">try_lock_until</a>(
|
||
|
|
&self,
|
||
|
|
timeout: R::<a class="associatedtype" href="trait.RawMutexTimed.html#associatedtype.Instant" title="type lock_api::RawMutexTimed::Instant">Instant</a>,
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.ReentrantMutexGuard.html" title="struct lock_api::ReentrantMutexGuard">ReentrantMutexGuard</a><'_, R, G, T>></h4></section></summary><div class="docblock"><p>Attempts to acquire this lock until a timeout is reached.</p>
|
||
|
|
<p>If the lock could not be acquired before the timeout expired, then
|
||
|
|
<code>None</code> is returned. Otherwise, an RAII guard is returned. The lock will
|
||
|
|
be unlocked when the guard is dropped.</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-ReentrantMutex%3CR,+G,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/remutex.rs.html#561-582">source</a><a href="#impl-Debug-for-ReentrantMutex%3CR,+G,+T%3E" class="anchor">§</a><h3 class="code-header">impl<R: <a class="trait" href="trait.RawMutex.html" title="trait lock_api::RawMutex">RawMutex</a>, G: <a class="trait" href="trait.GetThreadId.html" title="trait lock_api::GetThreadId">GetThreadId</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, 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/lock_api/remutex.rs.html#562-581">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.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.82.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.82.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.82.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-ReentrantMutex%3CR,+G,+T%3E" class="impl"><a class="src rightside" href="../src/lock_api/remutex.rs.html#547-552">source</a><a href="#impl-Default-for-ReentrantMutex%3CR,+G,+T%3E" class="anchor">§</a><h3 class="code-header">impl<R: <a class="trait" href="trait.RawMutex.html" title="trait lock_api::RawMutex">RawMutex</a>, G: <a class="trait" href="trait.GetThreadId.html" title="trait lock_api::GetThreadId">GetThreadId</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, T></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/lock_api/remutex.rs.html#549-551">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, T></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.82.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-Fr
|
||
|
|
R: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
||
|
|
G: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section><section id="impl-UnwindSafe-for-ReentrantMutex%3CR,+G,+T%3E" class="impl"><a href="#impl-UnwindSafe-for-ReentrantMutex%3CR,+G,+T%3E" class="anchor">§</a><h3 class="code-header">impl<R, G, T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ReentrantMutex.html" title="struct lock_api::ReentrantMutex">ReentrantMutex</a><R, G, T><div class="where">where
|
||
|
|
R: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,
|
||
|
|
G: <a class="trait" href="https://doc.rust-lang.org/1.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.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.82.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.82.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: <a class="primitive" href="https://doc.rust-lang.org/1.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.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.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.82.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.82.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.82.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.82.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.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.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.82.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.82.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.82.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.82.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.82.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.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.82.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.82.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.82.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.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.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>
|