| <!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="Sends values to the associated `Receiver`."><meta name="keywords" content="rust, rustlang, rust-lang, Sender"><title>Sender in tokio::sync::watch - 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">☰</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="#">Sender</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.borrow">borrow</a></li><li><a href="#method.closed">closed</a></li><li><a href="#method.is_closed">is_closed</a></li><li><a href="#method.receiver_count">receiver_count</a></li><li><a href="#method.send">send</a></li><li><a href="#method.send_if_modified">send_if_modified</a></li><li><a href="#method.send_modify">send_modify</a></li><li><a href="#method.send_replace">send_replace</a></li><li><a href="#method.subscribe">subscribe</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-Sender%3CT%3E">Debug</a></li><li><a href="#impl-Drop-for-Sender%3CT%3E">Drop</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Sender%3CT%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Sender%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-Sender%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-Sender%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Sender%3CT%3E">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Sender%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Sender%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Sender%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Sender%3CT%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Sender%3CT%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-Sender%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Sender%3CT%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In tokio::sync::watch</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 href="index.html">watch</a>::<wbr><a class="struct" href="#">Sender</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/watch.rs.html#86-88">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Sender<T> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Sends values to the associated <a href="struct.Receiver.html"><code>Receiver</code></a>.</p> |
| <p>Instances are created by the <a href="fn.channel.html"><code>channel</code></a> function.</p> |
| </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-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#607-968">source</a><a href="#impl-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="struct" href="struct.Sender.html" title="struct tokio::sync::watch::Sender">Sender</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#626-634">source</a><h4 class="code-header">pub fn <a href="#method.send" class="fnname">send</a>(&self, value: T) -> Result<(), <a class="struct" href="error/struct.SendError.html" title="struct tokio::sync::watch::error::SendError">SendError</a><T>></h4></section></summary><div class="docblock"><p>Sends a new value via the channel, notifying all receivers.</p> |
| <p>This method fails if the channel is closed, which is the case when |
| every receiver has been dropped. It is possible to reopen the channel |
| using the <a href="struct.Sender.html#method.subscribe"><code>subscribe</code></a> method. However, when <code>send</code> fails, the value |
| isn’t made available for future receivers (but returned with the |
| <a href="error/struct.SendError.html"><code>SendError</code></a>).</p> |
| <p>To always make a new value available for future receivers, even if no |
| receiver currently exists, one of the other send methods |
| (<a href="struct.Sender.html#method.send_if_modified"><code>send_if_modified</code></a>, <a href="struct.Sender.html#method.send_modify"><code>send_modify</code></a>, or <a href="struct.Sender.html#method.send_replace"><code>send_replace</code></a>) can be |
| used instead.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send_modify" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#666-674">source</a><h4 class="code-header">pub fn <a href="#method.send_modify" class="fnname">send_modify</a><F>(&self, modify: F)<span class="where fmt-newline">where<br> F: FnOnce(&mut T),</span></h4></section></summary><div class="docblock"><p>Modifies the watched value <strong>unconditionally</strong> in-place, |
| notifying all receivers.</p> |
| <p>This can useful for modifying the watched value, without |
| having to allocate a new instance. Additionally, this |
| method permits sending values even when there are no receivers.</p> |
| <p>Prefer to use the more versatile function <a href="struct.Sender.html#method.send_if_modified" title="Self::send_if_modified()"><code>Self::send_if_modified()</code></a> |
| if the value is only modified conditionally during the mutable borrow |
| to prevent unneeded change notifications for unmodified values.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>This function panics when the invocation of the <code>modify</code> closure panics. |
| No receivers are notified when panicking. All changes of the watched |
| value applied by the closure before panicking will be visible in |
| subsequent calls to <code>borrow</code>.</p> |
| <h5 id="examples"><a href="#examples">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::watch; |
| |
| <span class="kw">struct </span>State { |
| counter: usize, |
| } |
| <span class="kw">let </span>(state_tx, state_rx) = watch::channel(State { counter: <span class="number">0 </span>}); |
| state_tx.send_modify(|state| state.counter += <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(state_rx.borrow().counter, <span class="number">1</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send_if_modified" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#733-773">source</a><h4 class="code-header">pub fn <a href="#method.send_if_modified" class="fnname">send_if_modified</a><F>(&self, modify: F) -> bool<span class="where fmt-newline">where<br> F: FnOnce(&mut T) -> bool,</span></h4></section></summary><div class="docblock"><p>Modifies the watched value <strong>conditionally</strong> in-place, |
| notifying all receivers only if modified.</p> |
| <p>This can useful for modifying the watched value, without |
| having to allocate a new instance. Additionally, this |
| method permits sending values even when there are no receivers.</p> |
| <p>The <code>modify</code> closure must return <code>true</code> if the value has actually |
| been modified during the mutable borrow. It should only return <code>false</code> |
| if the value is guaranteed to be unmodified despite the mutable |
| borrow.</p> |
| <p>Receivers are only notified if the closure returned <code>true</code>. If the |
| closure has modified the value but returned <code>false</code> this results |
| in a <em>silent modification</em>, i.e. the modified value will be visible |
| in subsequent calls to <code>borrow</code>, but receivers will not receive |
| a change notification.</p> |
| <p>Returns the result of the closure, i.e. <code>true</code> if the value has |
| been modified and <code>false</code> otherwise.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>This function panics when the invocation of the <code>modify</code> closure panics. |
| No receivers are notified when panicking. All changes of the watched |
| value applied by the closure before panicking will be visible in |
| subsequent calls to <code>borrow</code>.</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::watch; |
| |
| <span class="kw">struct </span>State { |
| counter: usize, |
| } |
| <span class="kw">let </span>(state_tx, <span class="kw-2">mut </span>state_rx) = watch::channel(State { counter: <span class="number">1 </span>}); |
| <span class="kw">let </span>inc_counter_if_odd = |state: <span class="kw-2">&mut </span>State| { |
| <span class="kw">if </span>state.counter % <span class="number">2 </span>== <span class="number">1 </span>{ |
| state.counter += <span class="number">1</span>; |
| <span class="kw">return </span><span class="bool-val">true</span>; |
| } |
| <span class="bool-val">false |
| </span>}; |
| |
| <span class="macro">assert_eq!</span>(state_rx.borrow().counter, <span class="number">1</span>); |
| |
| <span class="macro">assert!</span>(!state_rx.has_changed().unwrap()); |
| <span class="macro">assert!</span>(state_tx.send_if_modified(inc_counter_if_odd)); |
| <span class="macro">assert!</span>(state_rx.has_changed().unwrap()); |
| <span class="macro">assert_eq!</span>(state_rx.borrow_and_update().counter, <span class="number">2</span>); |
| |
| <span class="macro">assert!</span>(!state_rx.has_changed().unwrap()); |
| <span class="macro">assert!</span>(!state_tx.send_if_modified(inc_counter_if_odd)); |
| <span class="macro">assert!</span>(!state_rx.has_changed().unwrap()); |
| <span class="macro">assert_eq!</span>(state_rx.borrow_and_update().counter, <span class="number">2</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send_replace" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#791-796">source</a><h4 class="code-header">pub fn <a href="#method.send_replace" class="fnname">send_replace</a>(&self, value: T) -> T</h4></section></summary><div class="docblock"><p>Sends a new value via the channel, notifying all receivers and returning |
| the previous value in the channel.</p> |
| <p>This can be useful for reusing the buffers inside a watched value. |
| Additionally, this method permits sending values even when there are no |
| receivers.</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::watch; |
| |
| <span class="kw">let </span>(tx, _rx) = watch::channel(<span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(tx.send_replace(<span class="number">2</span>), <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(tx.send_replace(<span class="number">3</span>), <span class="number">2</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#815-822">source</a><h4 class="code-header">pub fn <a href="#method.borrow" class="fnname">borrow</a>(&self) -> <a class="struct" href="struct.Ref.html" title="struct tokio::sync::watch::Ref">Ref</a><'_, T></h4></section></summary><div class="docblock"><p>Returns a reference to the most recently sent value</p> |
| <p>Outstanding borrows hold a read lock on the inner value. This means that |
| long-lived borrows could cause the producer half to block. It is recommended |
| to keep the borrow as short-lived as possible. Additionally, if you are |
| running in an environment that allows <code>!Send</code> futures, you must ensure that |
| the returned <code>Ref</code> type is never held alive across an <code>.await</code> point, |
| otherwise, it can lead to a deadlock.</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::watch; |
| |
| <span class="kw">let </span>(tx, <span class="kw">_</span>) = watch::channel(<span class="string">"hello"</span>); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>tx.borrow(), <span class="string">"hello"</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_closed" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#836-838">source</a><h4 class="code-header">pub fn <a href="#method.is_closed" class="fnname">is_closed</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Checks if the channel has been closed. This happens when all receivers |
| have dropped.</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">let </span>(tx, rx) = tokio::sync::watch::channel(()); |
| <span class="macro">assert!</span>(!tx.is_closed()); |
| |
| drop(rx); |
| <span class="macro">assert!</span>(tx.is_closed());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.closed" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#869-881">source</a><h4 class="code-header">pub async fn <a href="#method.closed" class="fnname">closed</a>(&self)</h4></section></summary><div class="docblock"><p>Completes when all receivers have dropped.</p> |
| <p>This allows the producer to get notified when interest in the produced |
| values is canceled and immediately stop doing work.</p> |
| <h5 id="cancel-safety"><a href="#cancel-safety">Cancel safety</a></h5> |
| <p>This method is cancel safe. Once the channel is closed, it stays closed |
| forever and all future calls to <code>closed</code> will return immediately.</p> |
| <h5 id="examples-5"><a href="#examples-5">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::watch; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span>(tx, rx) = watch::channel(<span class="string">"hello"</span>); |
| |
| tokio::spawn(<span class="kw">async move </span>{ |
| <span class="comment">// use `rx` |
| </span>drop(rx); |
| }); |
| |
| <span class="comment">// Waits for `rx` to drop |
| </span>tx.closed().<span class="kw">await</span>; |
| <span class="macro">println!</span>(<span class="string">"the `rx` handles dropped"</span>) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.subscribe" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#938-945">source</a><h4 class="code-header">pub fn <a href="#method.subscribe" class="fnname">subscribe</a>(&self) -> <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T></h4></section></summary><div class="docblock"><p>Creates a new <a href="struct.Receiver.html" title="Receiver"><code>Receiver</code></a> connected to this <code>Sender</code>.</p> |
| <p>All messages sent before this call to <code>subscribe</code> are initially marked |
| as seen by the new <code>Receiver</code>.</p> |
| <p>This method can be called even if there are no other receivers. In this |
| case, the channel is reopened.</p> |
| <h5 id="examples-6"><a href="#examples-6">Examples</a></h5> |
| <p>The new channel will receive messages sent on this <code>Sender</code>.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::watch; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span>(tx, _rx) = watch::channel(<span class="number">0u64</span>); |
| |
| tx.send(<span class="number">5</span>).unwrap(); |
| |
| <span class="kw">let </span>rx = tx.subscribe(); |
| <span class="macro">assert_eq!</span>(<span class="number">5</span>, <span class="kw-2">*</span>rx.borrow()); |
| |
| tx.send(<span class="number">10</span>).unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">10</span>, <span class="kw-2">*</span>rx.borrow()); |
| }</code></pre></div> |
| <p>The most recent message is considered seen by the channel, so this test |
| is guaranteed to pass.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::watch; |
| <span class="kw">use </span>tokio::time::Duration; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span>(tx, _rx) = watch::channel(<span class="number">0u64</span>); |
| tx.send(<span class="number">5</span>).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>rx = tx.subscribe(); |
| |
| tokio::spawn(<span class="kw">async move </span>{ |
| <span class="comment">// by spawning and sleeping, the message is sent after `main` |
| // hits the call to `changed`. |
| </span>tokio::time::sleep(Duration::from_millis(<span class="number">10</span>)).<span class="kw">await</span>; |
| tx.send(<span class="number">100</span>).unwrap(); |
| }); |
| |
| rx.changed().<span class="kw">await</span>.unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">100</span>, <span class="kw-2">*</span>rx.borrow()); |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.receiver_count" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#965-967">source</a><h4 class="code-header">pub fn <a href="#method.receiver_count" class="fnname">receiver_count</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Returns the number of receivers that currently exist.</p> |
| <h5 id="examples-7"><a href="#examples-7">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::watch; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span>(tx, rx1) = watch::channel(<span class="string">"hello"</span>); |
| |
| <span class="macro">assert_eq!</span>(<span class="number">1</span>, tx.receiver_count()); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>_rx2 = rx1.clone(); |
| |
| <span class="macro">assert_eq!</span>(<span class="number">2</span>, tx.receiver_count()); |
| }</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-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#85">source</a><a href="#impl-Debug-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: Debug> Debug for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::watch::Sender">Sender</a><T></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/watch.rs.html#85">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Drop-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#970-975">source</a><a href="#impl-Drop-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Drop for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::watch::Sender">Sender</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/watch.rs.html#971-974">source</a><a href="#method.drop" class="anchor"></a><h4 class="code-header">fn <a class="fnname">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a>Read more</a></div></details></div></details></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-RefUnwindSafe-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> !RefUnwindSafe for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::watch::Sender">Sender</a><T></h3></section><section id="impl-Send-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Send for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::watch::Sender">Sender</a><T><span class="where fmt-newline">where<br> T: Send + Sync,</span></h3></section><section id="impl-Sync-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Sync for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::watch::Sender">Sender</a><T><span class="where fmt-newline">where<br> T: Send + Sync,</span></h3></section><section id="impl-Unpin-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Unpin for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::watch::Sender">Sender</a><T></h3></section><section id="impl-UnwindSafe-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> !UnwindSafe for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::watch::Sender">Sender</a><T></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-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</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 href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow-1" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> 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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> 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-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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>[From]<T> 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-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</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 class="associatedtype">Error</a> = Infallible</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></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-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</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 class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></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> |
