Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / tokio / sync / struct.Notify.html
blob: 67dfda43d27f8d318412936774ebe6e93a934a2b [file] [log] [blame]
<!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="Notifies a single task to wake up."><meta name="keywords" content="rust, rustlang, rust-lang, Notify"><title>Notify in tokio::sync - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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">&#9776;</button><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Notify</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.new">new</a></li><li><a href="#method.notified">notified</a></li><li><a href="#method.notify_one">notify_one</a></li><li><a href="#method.notify_waiters">notify_waiters</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-Notify">Debug</a></li><li><a href="#impl-Default-for-Notify">Default</a></li><li><a href="#impl-RefUnwindSafe-for-Notify">RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-Notify">UnwindSafe</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Send-for-Notify">Send</a></li><li><a href="#impl-Sync-for-Notify">Sync</a></li><li><a href="#impl-Unpin-for-Notify">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Notify">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Notify">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Notify">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-Notify">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-Notify">Into&lt;U&gt;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Notify">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Notify">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In tokio::sync</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">tokio</a>::<wbr><a href="index.html">sync</a>::<wbr><a class="struct" href="#">Notify</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tokio/sync/notify.rs.html#201-214">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Notify { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Notifies a single task to wake up.</p>
<p><code>Notify</code> provides a basic mechanism to notify a single task of an event.
<code>Notify</code> itself does not carry any data. Instead, it is to be used to signal
another task to perform an operation.</p>
<p>A <code>Notify</code> can be thought of as a <a href="struct.Semaphore.html"><code>Semaphore</code></a> starting with 0 permits. The
<a href="struct.Notify.html#method.notified"><code>notified().await</code></a> method waits for a permit to become available, and
<a href="struct.Notify.html#method.notify_one"><code>notify_one()</code></a> sets a permit <strong>if there currently are no available
permits</strong>.</p>
<p>The synchronization details of <code>Notify</code> are similar to
<a href="https://doc.rust-lang.org/nightly/std/thread/fn.park.html"><code>thread::park</code></a> and <a href="https://doc.rust-lang.org/nightly/std/thread/struct.Thread.html#method.unpark"><code>Thread::unpark</code></a> from std. A <a href="struct.Notify.html" title="Notify"><code>Notify</code></a>
value contains a single permit. <a href="struct.Notify.html#method.notified"><code>notified().await</code></a> waits for the permit to
be made available, consumes the permit, and resumes. <a href="struct.Notify.html#method.notify_one"><code>notify_one()</code></a> sets
the permit, waking a pending task if there is one.</p>
<p>If <code>notify_one()</code> is called <strong>before</strong> <code>notified().await</code>, then the next
call to <code>notified().await</code> will complete immediately, consuming the permit.
Any subsequent calls to <code>notified().await</code> will wait for a new permit.</p>
<p>If <code>notify_one()</code> is called <strong>multiple</strong> times before <code>notified().await</code>,
only a <strong>single</strong> permit is stored. The next call to <code>notified().await</code> will
complete immediately, but the one after will wait for a new permit.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<p>Basic usage.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::Notify;
<span class="kw">use </span>std::sync::Arc;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>notify = Arc::new(Notify::new());
<span class="kw">let </span>notify2 = notify.clone();
<span class="kw">let </span>handle = tokio::spawn(<span class="kw">async move </span>{
notify2.notified().<span class="kw">await</span>;
<span class="macro">println!</span>(<span class="string">&quot;received notification&quot;</span>);
});
<span class="macro">println!</span>(<span class="string">&quot;sending notification&quot;</span>);
notify.notify_one();
<span class="comment">// Wait for task to receive notification.
</span>handle.<span class="kw">await</span>.unwrap();
}</code></pre></div>
<p>Unbound multi-producer single-consumer (mpsc) channel.</p>
<p>No wakeups can be lost when using this channel because the call to
<code>notify_one()</code> will store a permit in the <code>Notify</code>, which the following call
to <code>notified()</code> will consume.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::Notify;
<span class="kw">use </span>std::collections::VecDeque;
<span class="kw">use </span>std::sync::Mutex;
<span class="kw">struct </span>Channel&lt;T&gt; {
values: Mutex&lt;VecDeque&lt;T&gt;&gt;,
notify: Notify,
}
<span class="kw">impl</span>&lt;T&gt; Channel&lt;T&gt; {
<span class="kw">pub fn </span>send(<span class="kw-2">&amp;</span><span class="self">self</span>, value: T) {
<span class="self">self</span>.values.lock().unwrap()
.push_back(value);
<span class="comment">// Notify the consumer a value is available
</span><span class="self">self</span>.notify.notify_one();
}
<span class="comment">// This is a single-consumer channel, so several concurrent calls to
// `recv` are not allowed.
</span><span class="kw">pub async fn </span>recv(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; T {
<span class="kw">loop </span>{
<span class="comment">// Drain values
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(value) = <span class="self">self</span>.values.lock().unwrap().pop_front() {
<span class="kw">return </span>value;
}
<span class="comment">// Wait for values to be available
</span><span class="self">self</span>.notify.notified().<span class="kw">await</span>;
}
}
}</code></pre></div>
<p>Unbound multi-producer multi-consumer (mpmc) channel.</p>
<p>The call to <a href="futures/struct.Notified.html#method.enable"><code>enable</code></a> is important because otherwise if you have two
calls to <code>recv</code> and two calls to <code>send</code> in parallel, the following could
happen:</p>
<ol>
<li>Both calls to <code>try_recv</code> return <code>None</code>.</li>
<li>Both new elements are added to the vector.</li>
<li>The <code>notify_one</code> method is called twice, adding only a single
permit to the <code>Notify</code>.</li>
<li>Both calls to <code>recv</code> reach the <code>Notified</code> future. One of them
consumes the permit, and the other sleeps forever.</li>
</ol>
<p>By adding the <code>Notified</code> futures to the list by calling <code>enable</code> before
<code>try_recv</code>, the <code>notify_one</code> calls in step three would remove the
futures from the list and mark them notified instead of adding a permit
to the <code>Notify</code>. This ensures that both futures are woken.</p>
<p>Notice that this failure can only happen if there are two concurrent calls
to <code>recv</code>. This is why the mpsc example above does not require a call to
<code>enable</code>.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::Notify;
<span class="kw">use </span>std::collections::VecDeque;
<span class="kw">use </span>std::sync::Mutex;
<span class="kw">struct </span>Channel&lt;T&gt; {
messages: Mutex&lt;VecDeque&lt;T&gt;&gt;,
notify_on_sent: Notify,
}
<span class="kw">impl</span>&lt;T&gt; Channel&lt;T&gt; {
<span class="kw">pub fn </span>send(<span class="kw-2">&amp;</span><span class="self">self</span>, msg: T) {
<span class="kw">let </span><span class="kw-2">mut </span>locked_queue = <span class="self">self</span>.messages.lock().unwrap();
locked_queue.push_back(msg);
drop(locked_queue);
<span class="comment">// Send a notification to one of the calls currently
// waiting in a call to `recv`.
</span><span class="self">self</span>.notify_on_sent.notify_one();
}
<span class="kw">pub fn </span>try_recv(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;T&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>locked_queue = <span class="self">self</span>.messages.lock().unwrap();
locked_queue.pop_front()
}
<span class="kw">pub async fn </span>recv(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; T {
<span class="kw">let </span>future = <span class="self">self</span>.notify_on_sent.notified();
<span class="macro">tokio::pin!</span>(future);
<span class="kw">loop </span>{
<span class="comment">// Make sure that no wakeup is lost if we get
// `None` from `try_recv`.
</span>future.as_mut().enable();
<span class="kw">if let </span><span class="prelude-val">Some</span>(msg) = <span class="self">self</span>.try_recv() {
<span class="kw">return </span>msg;
}
<span class="comment">// Wait for a call to `notify_one`.
//
// This uses `.as_mut()` to avoid consuming the future,
// which lets us call `Pin::set` below.
</span>future.as_mut().<span class="kw">await</span>;
<span class="comment">// Reset the future in case another call to
// `try_recv` got the message before us.
</span>future.set(<span class="self">self</span>.notify_on_sent.notified());
}
}
}</code></pre></div>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Notify" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#420-693">source</a><a href="#impl-Notify" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Notify.html" title="struct tokio::sync::Notify">Notify</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#430-435">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -&gt; <a class="struct" href="struct.Notify.html" title="struct tokio::sync::Notify">Notify</a></h4></section></summary><div class="docblock"><p>Create a new <code>Notify</code>, initialized without a permit.</p>
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::Notify;
<span class="kw">let </span>notify = Notify::new();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.notified" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#505-515">source</a><h4 class="code-header">pub fn <a href="#method.notified" class="fnname">notified</a>(&amp;self) -&gt; <a class="struct" href="futures/struct.Notified.html" title="struct tokio::sync::futures::Notified">Notified</a>&lt;'_&gt;<span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="futures/struct.Notified.html" title="struct tokio::sync::futures::Notified">Notified</a>&lt;'_&gt;</span><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="futures/struct.Notified.html" title="struct tokio::sync::futures::Notified">Notified</a>&lt;'_&gt;</span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>;</span></code></span></span></span></span></h4></section></summary><div class="docblock"><p>Wait for a notification.</p>
<p>Equivalent to:</p>
<div class="example-wrap ignore"><div class='tooltip'>ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">async fn </span>notified(<span class="kw-2">&amp;</span><span class="self">self</span>);</code></pre></div>
<p>Each <code>Notify</code> value holds a single permit. If a permit is available from
an earlier call to <a href="struct.Notify.html#method.notify_one"><code>notify_one()</code></a>, then <code>notified().await</code> will complete
immediately, consuming that permit. Otherwise, <code>notified().await</code> waits
for a permit to be made available by the next call to <code>notify_one()</code>.</p>
<p>The <code>Notified</code> future is not guaranteed to receive wakeups from calls to
<code>notify_one()</code> if it has not yet been polled. See the documentation for
<a href="futures/struct.Notified.html#method.enable"><code>Notified::enable()</code></a> for more details.</p>
<p>The <code>Notified</code> future is guaranteed to receive wakeups from
<code>notify_waiters()</code> as soon as it has been created, even if it has not
yet been polled.</p>
<h5 id="cancel-safety"><a href="#cancel-safety">Cancel safety</a></h5>
<p>This method uses a queue to fairly distribute notifications in the order
they were requested. Cancelling a call to <code>notified</code> makes you lose your
place in the queue.</p>
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::Notify;
<span class="kw">use </span>std::sync::Arc;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>notify = Arc::new(Notify::new());
<span class="kw">let </span>notify2 = notify.clone();
tokio::spawn(<span class="kw">async move </span>{
notify2.notified().<span class="kw">await</span>;
<span class="macro">println!</span>(<span class="string">&quot;received notification&quot;</span>);
});
<span class="macro">println!</span>(<span class="string">&quot;sending notification&quot;</span>);
notify.notify_one();
}</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.notify_one" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#553-585">source</a><h4 class="code-header">pub fn <a href="#method.notify_one" class="fnname">notify_one</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Notifies a waiting task.</p>
<p>If a task is currently waiting, that task is notified. Otherwise, a
permit is stored in this <code>Notify</code> value and the <strong>next</strong> call to
<a href="struct.Notify.html#method.notified"><code>notified().await</code></a> will complete immediately consuming the permit made
available by this call to <code>notify_one()</code>.</p>
<p>At most one permit may be stored by <code>Notify</code>. Many sequential calls to
<code>notify_one</code> will result in a single permit being stored. The next call to
<code>notified().await</code> will complete immediately, but the one after that
will wait.</p>
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::Notify;
<span class="kw">use </span>std::sync::Arc;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>notify = Arc::new(Notify::new());
<span class="kw">let </span>notify2 = notify.clone();
tokio::spawn(<span class="kw">async move </span>{
notify2.notified().<span class="kw">await</span>;
<span class="macro">println!</span>(<span class="string">&quot;received notification&quot;</span>);
});
<span class="macro">println!</span>(<span class="string">&quot;sending notification&quot;</span>);
notify.notify_one();
}</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.notify_waiters" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#619-692">source</a><h4 class="code-header">pub fn <a href="#method.notify_waiters" class="fnname">notify_waiters</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Notifies all waiting tasks.</p>
<p>If a task is currently waiting, that task is notified. Unlike with
<code>notify_one()</code>, no permit is stored to be used by the next call to
<code>notified().await</code>. The purpose of this method is to notify all
already registered waiters. Registering for notification is done by
acquiring an instance of the <code>Notified</code> future via calling <code>notified()</code>.</p>
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::Notify;
<span class="kw">use </span>std::sync::Arc;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>notify = Arc::new(Notify::new());
<span class="kw">let </span>notify2 = notify.clone();
<span class="kw">let </span>notified1 = notify.notified();
<span class="kw">let </span>notified2 = notify.notified();
<span class="kw">let </span>handle = tokio::spawn(<span class="kw">async move </span>{
<span class="macro">println!</span>(<span class="string">&quot;sending notifications&quot;</span>);
notify2.notify_waiters();
});
notified1.<span class="kw">await</span>;
notified2.<span class="kw">await</span>;
<span class="macro">println!</span>(<span class="string">&quot;received notifications&quot;</span>);
}</code></pre></div>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#200">source</a><a href="#impl-Debug-for-Notify" class="anchor"></a><h3 class="code-header">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="struct.Notify.html" title="struct tokio::sync::Notify">Notify</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#200">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/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/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#695-699">source</a><a href="#impl-Default-for-Notify" class="anchor"></a><h3 class="code-header">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="struct.Notify.html" title="struct tokio::sync::Notify">Notify</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#696-698">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -&gt; <a class="struct" href="struct.Notify.html" title="struct tokio::sync::Notify">Notify</a></h4></section></summary><div class='docblock'>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></div></details></div></details><section id="impl-RefUnwindSafe-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#702">source</a><a href="#impl-RefUnwindSafe-for-Notify" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Notify.html" title="struct tokio::sync::Notify">Notify</a></h3></section><section id="impl-UnwindSafe-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/sync/notify.rs.html#701">source</a><a href="#impl-UnwindSafe-for-Notify" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Notify.html" title="struct tokio::sync::Notify">Notify</a></h3></section></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"><section id="impl-Send-for-Notify" class="impl has-srclink"><a href="#impl-Send-for-Notify" class="anchor"></a><h3 class="code-header">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="struct.Notify.html" title="struct tokio::sync::Notify">Notify</a></h3></section><section id="impl-Sync-for-Notify" class="impl has-srclink"><a href="#impl-Sync-for-Notify" class="anchor"></a><h3 class="code-header">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="struct.Notify.html" title="struct tokio::sync::Notify">Notify</a></h3></section><section id="impl-Unpin-for-Notify" class="impl has-srclink"><a href="#impl-Unpin-for-Notify" class="anchor"></a><h3 class="code-header">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="struct.Notify.html" title="struct tokio::sync::Notify">Notify</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-Notify" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <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>&nbsp;&nbsp;&nbsp;&nbsp;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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/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/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-Notify" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-Notify" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T</h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-Notify" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-Notify" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -&gt; 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/nightly/core/convert/trait.From.html" title="From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-Notify" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/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="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Notify" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-Notify" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/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="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>