|
|
|
|
|
<!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 `Condvar` struct in crate `parking_lot`."><meta name="keywords" content="rust, rustlang, rust-lang, Condvar"><title>parking_lot::Condvar - 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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><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='../parking_lot/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Struct Condvar</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.notify_all">notify_all</a><a href="#method.notify_one">notify_one</a><a href="#method.wait">wait</a><a href="#method.wait_for">wait_for</a><a href="#method.wait_until">wait_until</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</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-Erased">Erased</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'>parking_lot</a></p><script>window.sidebarCurrent = {name: 'Condvar', 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!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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/parking_lot/condvar.rs.html#84-86' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='index.html'>parking_lot</a>::<wbr><a class="struct" href=''>Condvar</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct Condvar { /* fields omitted */ }</pre></div><div class
|
|
|
|
|
|
<p>Condition variables represent the ability to block a thread such that it
|
|
|
|
|
|
consumes no CPU time while waiting for an event to occur. Condition
|
|
|
|
|
|
variables are typically associated with a boolean predicate (a condition)
|
|
|
|
|
|
and a mutex. The predicate is always verified inside of the mutex before
|
|
|
|
|
|
determining that thread must block.</p>
|
|
|
|
|
|
<p>Note that this module places one additional restriction over the system
|
|
|
|
|
|
condition variables: each condvar can be used with only one mutex at a
|
|
|
|
|
|
time. Any attempt to use multiple mutexes on the same condition variable
|
|
|
|
|
|
simultaneously will result in a runtime panic. However it is possible to
|
|
|
|
|
|
switch to a different mutex if there are no threads currently waiting on
|
|
|
|
|
|
the condition variable.</p>
|
|
|
|
|
|
<h1 id="differences-from-the-standard-library-condvar" class="section-header"><a href="#differences-from-the-standard-library-condvar">Differences from the standard library <code>Condvar</code></a></h1>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>No spurious wakeups: A wait will only return a non-timeout result if it
|
|
|
|
|
|
was woken up by <code>notify_one</code> or <code>notify_all</code>.</li>
|
|
|
|
|
|
<li><code>Condvar::notify_all</code> will only wake up a single thread, the rest are
|
|
|
|
|
|
requeued to wait for the <code>Mutex</code> to be unlocked by the thread that was
|
|
|
|
|
|
woken up.</li>
|
|
|
|
|
|
<li>Only requires 1 word of space, whereas the standard library boxes the
|
|
|
|
|
|
<code>Condvar</code> due to platform limitations.</li>
|
|
|
|
|
|
<li>Can be statically constructed (requires the <code>const_fn</code> nightly feature).</li>
|
|
|
|
|
|
<li>Does not require any drop glue when dropped.</li>
|
|
|
|
|
|
<li>Inline fast path for the uncontended case.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">parking_lot</span>::{<span class="ident">Mutex</span>, <span class="ident">Condvar</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">pair</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="bool-val">false</span>), <span class="ident">Condvar</span>::<span class="ident">new</span>()));
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">pair2</span> <span class="op">=</span> <span class="ident">pair</span>.<span class="ident">clone</span>();
|
|
|
|
|
|
|
|
|
|
|
|
<span class="comment">// Inside of our lock, spawn a new thread, and then wait for it to start</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">&</span>(<span class="kw-2">ref</span> <span class="ident">lock</span>, <span class="kw-2">ref</span> <span class="ident">cvar</span>) <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">pair2</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">started</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">lock</span>();
|
|
|
|
|
|
<span class="kw-2">*</span><span class="ident">started</span> <span class="op">=</span> <span class="bool-val">true</span>;
|
|
|
|
|
|
<span class="ident">cvar</span>.<span class="ident">notify_one</span>();
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
<span class="comment">// wait for the thread to start up</span>
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">&</span>(<span class="kw-2">ref</span> <span class="ident">lock</span>, <span class="kw-2">ref</span> <span class="ident">cvar</span>) <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">pair</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">started</span> <span class="op">=</span> <span class="ident">lock</span>.<span class="ident">lock</span>();
|
|
|
|
|
|
<span class="kw">while</span> <span class="op">!</span><span class="kw-2">*</span><span class="ident">started</span> {
|
|
|
|
|
|
<span class="ident">cvar</span>.<span class="ident">wait</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">started</span>);
|
|
|
|
|
|
}</pre></div>
|
|
|
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../parking_lot/struct.Condvar.html" title="struct parking_lot::Condvar">Condvar</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/parking_lot/condvar.rs.html#88-406' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../parking_lot/struct.Condvar.html" title="struct parking_lot::Condvar">Condvar</a></code><a class='srclink' href='../src/parking_lot/condvar.rs.html#103-107' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new condition variable which is ready to be waited on and
|
|
|
|
|
|
notified.</p>
|
|
|
|
|
|
</div><h4 id='method.notify_one' class="method"><code id='notify_one.v'>pub fn <a href='#method.notify_one' class='fnname'>notify_one</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/parking_lot/condvar.rs.html#133-141' title='goto source code'>[src]</a></h4><div class='docblock'><p>Wakes up one blocked thread on this condvar.</p>
|
|
|
|
|
|
<p>Returns whether a thread was woken up.</p>
|
|
|
|
|
|
<p>If there is a blocked thread on this condition variable, then it will
|
|
|
|
|
|
be woken up from its call to <code>wait</code> or <code>wait_timeout</code>. Calls to
|
|
|
|
|
|
<code>notify_one</code> are not buffered in any way.</p>
|
|
|
|
|
|
<p>To wake up all threads, see <code>notify_all()</code>.</p>
|
|
|
|
|
|
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">parking_lot</span>::<span class="ident">Condvar</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">condvar</span> <span class="op">=</span> <span class="ident">Condvar</span>::<span class="ident">new</span>();
|
|
|
|
|
|
|
|
|
|
|
|
<span class="comment">// do something with condvar, share it with other threads</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">if</span> <span class="op">!</span><span class="ident">condvar</span>.<span class="ident">notify_one</span>() {
|
|
|
|
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Nobody was listening for this."</span>);
|
|
|
|
|
|
}</pre></div>
|
|
|
|
|
|
</div><h4 id='method.notify_all' class="method"><code id='notify_all.v'>pub fn <a href='#method.notify_all' class='fnname'>notify_all</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/parking_lot/condvar.rs.html#195-203' title='goto source code'>[src]</a></h4><div class='docblock'><p>Wakes up all blocked threads on this condvar.</p>
|
|
|
|
|
|
<p>Returns the number of threads woken up.</p>
|
|
|
|
|
|
<p>This method will ensure that any current waiters on the condition
|
|
|
|
|
|
variable are awoken. Calls to <code>notify_all()</code> are not buffered in any
|
|
|
|
|
|
way.</p>
|
|
|
|
|
|
<p>To wake up only one thread, see <code>notify_one()</code>.</p>
|
|
|
|
|
|
</div><h4 id='method.wait' class="method"><code id='wait.v'>pub fn <a href='#method.wait' class='fnname'>wait</a><T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, mutex_guard: &mut <a class="type" href="../parking_lot/type.MutexGuard.html" title="type parking_lot::MutexGuard">MutexGuard</a><T>)</code><a class='srclink' href='../src/parking_lot/condvar.rs.html#266-268' title='goto source code'>[src]</a></h4><div class='docblock'><p>Blocks the current thread until this condition variable receives a
|
|
|
|
|
|
notification.</p>
|
|
|
|
|
|
<p>This function will atomically unlock the mutex specified (represented by
|
|
|
|
|
|
<code>mutex_guard</code>) and block the current thread. This means that any calls
|
|
|
|
|
|
to <code>notify_*()</code> which happen logically after the mutex is unlocked are
|
|
|
|
|
|
candidates to wake this thread up. When this function call returns, the
|
|
|
|
|
|
lock specified will have been re-acquired.</p>
|
|
|
|
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
|
|
|
|
|
<p>This function will panic if another thread is waiting on the <code>Condvar</code>
|
|
|
|
|
|
with a different <code>Mutex</code> object.</p>
|
|
|
|
|
|
</div><h4 id='method.wait_until' class="method"><code id='wait_until.v'>pub fn <a href='#method.wait_until' class='fnname'>wait_until</a><T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &self, <br> mutex_guard: &mut <a class="type" href="../parking_lot/type.MutexGuard.html" title="type parking_lot::MutexGuard">MutexGuard</a><T>, <br> timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a><br>) -> <a class="struct" href="../parking_lot/struct.WaitTimeoutResult.html" title="struct parking_lot::WaitTimeoutResult">WaitTimeoutResult</a></code><a class='srclink' href='../src/parking_lot/condvar.rs.html#294-303' title='goto source code'>[src]</a></h4><div class='docblock'><p>Waits on this condition variable for a notification, timing out after
|
|
|
|
|
|
the specified time instant.</p>
|
|
|
|
|
|
<p>The semantics of this function are equivalent to <code>wait()</code> except that
|
|
|
|
|
|
the thread will be blocked roughly until <code>timeout</code> is reached. This
|
|
|
|
|
|
method should not be used for precise timing due to anomalies such as
|
|
|
|
|
|
preemption or platform differences that may not cause the maximum
|
|
|
|
|
|
amount of time waited to be precisely <code>timeout</code>.</p>
|
|
|
|
|
|
<p>Note that the best effort is made to ensure that the time waited is
|
|
|
|
|
|
measured with a monotonic clock, and not affected by the changes made to
|
|
|
|
|
|
the system time.</p>
|
|
|
|
|
|
<p>The returned <code>WaitTimeoutResult</code> value indicates if the timeout is
|
|
|
|
|
|
known to have elapsed.</p>
|
|
|
|
|
|
<p>Like <code>wait</code>, the lock specified will be re-acquired when this function
|
|
|
|
|
|
returns, regardless of whether the timeout elapsed or not.</p>
|
|
|
|
|
|
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
|
|
|
|
|
<p>This function will panic if another thread is waiting on the <code>Condvar</code>
|
|
|
|
|
|
with a different <code>Mutex</code> object.</p>
|
|
|
|
|
|
</div><h4 id='method.wait_for' class="method"><code id='wait_for.v'>pub fn <a href='#method.wait_for' class='fnname'>wait_for</a><T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &self, <br> mutex_guard: &mut <a class="type" href="../parking_lot/type.MutexGuard.html" title="type parking_lot::MutexGuard">MutexGuard</a><T>, <br> timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a><br>) -> <a class="struct" href="../parking_lot/struct.WaitTimeoutResult.html" title="struct parking_lot::WaitTimeoutResult">WaitTimeoutResult</a></code><a class='srclink' href='../src/parking_lot/condvar.rs.html#398-405' title='goto source code'>[src]</a></h4><div class='docblock'><p>Waits on this condition variable for a notification, timing out after a
|
|
|
|
|
|
specified duration.</p>
|
|
|
|
|
|
<p>The semantics of this function are equivalent to <code>wait()</code> except that
|
|
|
|
|
|
the thread will be blocked for roughly no longer than <code>timeout</code>. This
|
|
|
|
|
|
method should not be used for precise timing due to anomalies such as
|
|
|
|
|
|
preemption or platform differences that may not cause the maximum
|
|
|
|
|
|
amount of time waited to be precisely <code>timeout</code>.</p>
|
|
|
|
|
|
<p>Note that the best effort is made to ensure that the time waited is
|
|
|
|
|
|
measured with a monotonic clock, and not affected by the changes made to
|
|
|
|
|
|
the system time.</p>
|
|
|
|
|
|
<p>The returned <code>WaitTimeoutResult</code> value indicates if the timeout is
|
|
|
|
|
|
known to have elapsed.</p>
|
|
|
|
|
|
<p>Like <code>wait</code>, the lock specified will be re-acquired when this function
|
|
|
|
|
|
returns, regardless of whether the timeout elapsed or not.</p>
|
|
|
|
|
|
<h1 id="panics-2" class="section-header"><a href="#panics-2">Panics</a></h1>
|
|
|
|
|
|
<p>Panics if the given <code>timeout</code> is so large that it can't be added to the current time.
|
|
|
|
|
|
This panic is not possible if the crate is built with the <code>nightly</code> feature, then a too
|
|
|
|
|
|
large <code>timeout</code> becomes equivalent to just calling <code>wait</code>.</p>
|
|
|
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Default' class='impl'><code class='in-band'>impl <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="../parking_lot/struct.Condvar.html" title="struct parking_lot::Condvar">Condvar</a></code><a href='#impl-Default' class='anchor'></a><a class='srclink' href='../src/parking_lot/condvar.rs.html#408-413' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.default' class="method hidden"><code id='default.v'>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../parking_lot/struct.Condvar.html" title="struct parking_lot::Condvar">Condvar</a></code><a class='srclink' href='../src/parking_lot/condvar.rs.html#410-412' 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-Debug' class='impl'><code class='in-band'>impl <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="../parking_lot/struct.Condvar.html" title="struct parking_lot::Condvar">Condvar</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../src/parking_lot/condvar.rs.html#415-419' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>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/parking_lot/condvar.rs.html#416-418' 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></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-Send' class='impl'><code class='in-band'>impl <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="../parking_lot/struct.Condvar.html" title="struct parking_lot::Condvar">Condvar</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <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="../parking_lot/struct.Condvar.html" title="struct parking_lot::Condvar">Condvar</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <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="../parking_lot/struct.Condvar.html" title="struct parking_lot::Condvar">Condvar</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl <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="../parking_lot/struct.Condvar.html" title="struct parking_lot::Condvar">Condvar</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl <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="../parking_lot/struct.Condvar.html" title="struct parking_lot::Condvar">Condvar</a></code><a href='#impl-RefUnwindSafe' 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-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.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>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.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</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 T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>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.rs.html#554' 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.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>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 id='try_from.v'>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.rs.html#575-577' 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.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>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 id='try_into.v'>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.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</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#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>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#219' 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-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#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>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#214' 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-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#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>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#101' 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-Erased' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../owning_ref/trait.Erased.html" title="trait owning_ref::Erased">Erased</a> for T</code><a href='#impl-Erased' class='anchor'></a><a class='srclink' href='../src/owning_ref/lib.rs.html#281' title='goto source code'>[src]</a></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "parking_lot";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
