195 lines
48 KiB
HTML
195 lines
48 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Receives values from the associated `Sender`."><title>Receiver in tokio::sync::watch - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="tokio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Receiver</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../tokio/index.html">tokio</a><span class="version">1.49.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Receiver</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.borrow" title="borrow">borrow</a></li><li><a href="#method.borrow_and_update" title="borrow_and_update">borrow_and_update</a></li><li><a href="#method.changed" title="changed">changed</a></li><li><a href="#method.has_changed" title="has_changed">has_changed</a></li><li><a href="#method.mark_changed" title="mark_changed">mark_changed</a></li><li><a href="#method.mark_unchanged" title="mark_unchanged">mark_unchanged</a></li><li><a href="#method.same_channel" title="same_channel">same_channel</a></li><li><a href="#method.wait_for" title="wait_for">wait_for</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-Receiver%3CT%3E" title="Clone">Clone</a></li><li><a href="#impl-Debug-for-Receiver%3CT%3E" title="Debug">Debug</a></li><li><a href="#impl-Drop-for-Receiver%3CT%3E" title="Drop">Drop</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-Receiver%3CT%3E" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-Receiver%3CT%3E" title="!UnwindSafe">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-Receiver%3CT%3E" title="Freeze">Freeze</a></li><li><a href="#impl-Send-for-Receiver%3CT%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-Receiver%3CT%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Receiver%3CT%3E" title="Unpin">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-ToOwned-for-T" title="ToOwned">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In tokio::<wbr>sync::<wbr>watch</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">tokio</a>::<wbr><a href="../index.html">sync</a>::<wbr><a href="index.html">watch</a></div><h1>Struct <span class="struct">Receiver</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/tokio/sync/watch.rs.html#185-191">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Receiver<T> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Receives values from the associated <a href="struct.Sender.html" title="struct tokio::sync::watch::Sender"><code>Sender</code></a>.</p>
|
|
<p>Instances are created by the <a href="fn.channel.html" title="fn tokio::sync::watch::channel"><code>channel</code></a> function.</p>
|
|
<p>To turn this receiver into a <code>Stream</code>, you can use the <a href="https://docs.rs/tokio-stream/0.1/tokio_stream/wrappers/struct.WatchStream.html"><code>WatchStream</code></a>
|
|
wrapper.</p>
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Receiver%3CT%3E" class="impl"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#576-959">Source</a><a href="#impl-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#629-638">Source</a><h4 class="code-header">pub fn <a href="#method.borrow" class="fn">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>This method does not mark the returned value as seen, so future calls to
|
|
<a href="struct.Receiver.html#method.changed" title="method tokio::sync::watch::Receiver::changed"><code>changed</code></a> may return immediately even if you have already seen the
|
|
value with a call to <code>borrow</code>.</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>
|
|
<p>The priority policy of the lock is dependent on the underlying lock
|
|
implementation, and this type does not guarantee that any particular policy
|
|
will be used. In particular, a producer which is waiting to acquire the lock
|
|
in <code>send</code> might or might not block concurrent calls to <code>borrow</code>, e.g.:</p>
|
|
<details><summary>Potential deadlock example</summary>
|
|
<div class="example-wrap"><pre class="language-text"><code>// Task 1 (on thread A) | // Task 2 (on thread B)
|
|
let _ref1 = rx.borrow(); |
|
|
| // will block
|
|
| let _ = tx.send(());
|
|
// may deadlock |
|
|
let _ref2 = rx.borrow(); |</code></pre></div></details>
|
|
<p>For more information on when to use this method versus
|
|
<a href="struct.Receiver.html#method.borrow_and_update" title="method tokio::sync::watch::Receiver::borrow_and_update"><code>borrow_and_update</code></a>, see <a href="index.html#borrow_and_update-versus-borrow" title="mod tokio::sync::watch">here</a>.</p>
|
|
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</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>(<span class="kw">_</span>, rx) = watch::channel(<span class="string">"hello"</span>);
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>rx.borrow(), <span class="string">"hello"</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.borrow_and_update" class="method"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#676-688">Source</a><h4 class="code-header">pub fn <a href="#method.borrow_and_update" class="fn">borrow_and_update</a>(&mut 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 and marks that value
|
|
as seen.</p>
|
|
<p>This method marks the current value as seen. Subsequent calls to <a href="struct.Receiver.html#method.changed" title="method tokio::sync::watch::Receiver::changed"><code>changed</code></a>
|
|
will not return immediately until the <a href="struct.Sender.html" title="struct tokio::sync::watch::Sender"><code>Sender</code></a> has modified the shared
|
|
value again.</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>
|
|
<p>The priority policy of the lock is dependent on the underlying lock
|
|
implementation, and this type does not guarantee that any particular policy
|
|
will be used. In particular, a producer which is waiting to acquire the lock
|
|
in <code>send</code> might or might not block concurrent calls to <code>borrow</code>, e.g.:</p>
|
|
<details><summary>Potential deadlock example</summary>
|
|
<div class="example-wrap"><pre class="language-text"><code>// Task 1 (on thread A) | // Task 2 (on thread B)
|
|
let _ref1 = rx1.borrow_and_update(); |
|
|
| // will block
|
|
| let _ = tx.send(());
|
|
// may deadlock |
|
|
let _ref2 = rx2.borrow_and_update(); |</code></pre></div></details>
|
|
<p>For more information on when to use this method versus <a href="struct.Receiver.html#method.borrow" title="method tokio::sync::watch::Receiver::borrow"><code>borrow</code></a>, see
|
|
<a href="index.html#borrow_and_update-versus-borrow" title="mod tokio::sync::watch">here</a>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.has_changed" class="method"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#738-748">Source</a><h4 class="code-header">pub fn <a href="#method.has_changed" class="fn">has_changed</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a>, <a class="struct" href="error/struct.RecvError.html" title="struct tokio::sync::watch::error::RecvError">RecvError</a>></h4></section></summary><div class="docblock"><p>Checks if this channel contains a message that this receiver has not yet
|
|
seen. The current value will not be marked as seen.</p>
|
|
<p>Although this method is called <code>has_changed</code>, it does not check
|
|
messages for equality, so this call will return true even if the current
|
|
message is equal to the previous message.</p>
|
|
<h5 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h5>
|
|
<p>Returns a <a href="error/struct.RecvError.html" title="struct tokio::sync::watch::error::RecvError"><code>RecvError</code></a> if and only if the channel has been closed.</p>
|
|
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5><h6 id="basic-usage"><a class="doc-anchor" href="#basic-usage">§</a>Basic usage</h6>
|
|
<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-2">mut </span>rx) = watch::channel(<span class="string">"hello"</span>);
|
|
|
|
tx.send(<span class="string">"goodbye"</span>).unwrap();
|
|
|
|
<span class="macro">assert!</span>(rx.has_changed().unwrap());
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>rx.borrow_and_update(), <span class="string">"goodbye"</span>);
|
|
|
|
<span class="comment">// The value has been marked as seen
|
|
</span><span class="macro">assert!</span>(!rx.has_changed().unwrap());</code></pre></div><h6 id="closed-channel-example"><a class="doc-anchor" href="#closed-channel-example">§</a>Closed channel example</h6>
|
|
<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="string">"hello"</span>);
|
|
tx.send(<span class="string">"goodbye"</span>).unwrap();
|
|
|
|
drop(tx);
|
|
|
|
<span class="comment">// The channel is closed
|
|
</span><span class="macro">assert!</span>(rx.has_changed().is_err());</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.mark_changed" class="method"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#758-760">Source</a><h4 class="code-header">pub fn <a href="#method.mark_changed" class="fn">mark_changed</a>(&mut self)</h4></section></summary><div class="docblock"><p>Marks the state as changed.</p>
|
|
<p>After invoking this method <a href="struct.Receiver.html#method.has_changed" title="method tokio::sync::watch::Receiver::has_changed"><code>has_changed()</code></a>
|
|
returns <code>true</code> and <a href="struct.Receiver.html#method.changed" title="method tokio::sync::watch::Receiver::changed"><code>changed()</code></a> returns
|
|
immediately, regardless of whether a new value has been sent.</p>
|
|
<p>This is useful for triggering an initial change notification after
|
|
subscribing to synchronize new receivers.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.mark_unchanged" class="method"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#768-771">Source</a><h4 class="code-header">pub fn <a href="#method.mark_unchanged" class="fn">mark_unchanged</a>(&mut self)</h4></section></summary><div class="docblock"><p>Marks the state as unchanged.</p>
|
|
<p>The current value will be considered seen by the receiver.</p>
|
|
<p>This is useful if you are not interested in the current value
|
|
visible in the receiver.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.changed" class="method"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#818-820">Source</a><h4 class="code-header">pub async fn <a href="#method.changed" class="fn">changed</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.RecvError.html" title="struct tokio::sync::watch::error::RecvError">RecvError</a>></h4></section></summary><div class="docblock"><p>Waits for a change notification, then marks the current value as seen.</p>
|
|
<p>If the current value in the channel has not yet been marked seen when
|
|
this method is called, the method marks that value seen and returns
|
|
immediately. If the newest value has already been marked seen, then the
|
|
method sleeps until a new message is sent by a <a href="struct.Sender.html" title="struct tokio::sync::watch::Sender"><code>Sender</code></a> connected to
|
|
this <code>Receiver</code>, or until all <a href="struct.Sender.html" title="struct tokio::sync::watch::Sender"><code>Sender</code></a>s are dropped.</p>
|
|
<p>For more information, see
|
|
<a href="index.html#change-notifications" title="mod tokio::sync::watch"><em>Change notifications</em></a> in the module-level documentation.</p>
|
|
<h5 id="errors-1"><a class="doc-anchor" href="#errors-1">§</a>Errors</h5>
|
|
<p>Returns a <a href="error/struct.RecvError.html" title="struct tokio::sync::watch::error::RecvError"><code>RecvError</code></a> if the channel has been closed <strong>AND</strong>
|
|
the current value is seen.</p>
|
|
<h5 id="cancel-safety"><a class="doc-anchor" href="#cancel-safety">§</a>Cancel safety</h5>
|
|
<p>This method is cancel safe. If you use it as the event in a
|
|
<a href="../../macro.select.html" title="macro tokio::select"><code>tokio::select!</code></a> statement and some other branch
|
|
completes first, then it is guaranteed that no values have been marked
|
|
seen by this call to <code>changed</code>.</p>
|
|
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</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-2">mut </span>rx) = watch::channel(<span class="string">"hello"</span>);
|
|
|
|
tokio::spawn(<span class="kw">async move </span>{
|
|
tx.send(<span class="string">"goodbye"</span>).unwrap();
|
|
});
|
|
|
|
<span class="macro">assert!</span>(rx.changed().<span class="kw">await</span>.is_ok());
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>rx.borrow_and_update(), <span class="string">"goodbye"</span>);
|
|
|
|
<span class="comment">// The `tx` handle has been dropped
|
|
</span><span class="macro">assert!</span>(rx.changed().<span class="kw">await</span>.is_err());</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.wait_for" class="method"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#889-894">Source</a><h4 class="code-header">pub async fn <a href="#method.wait_for" class="fn">wait_for</a>(
|
|
&mut self,
|
|
f: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Ref.html" title="struct tokio::sync::watch::Ref">Ref</a><'_, T>, <a class="struct" href="error/struct.RecvError.html" title="struct tokio::sync::watch::error::RecvError">RecvError</a>></h4></section></summary><div class="docblock"><p>Waits for a value that satisfies the provided condition.</p>
|
|
<p>This method will call the provided closure whenever something is sent on
|
|
the channel. Once the closure returns <code>true</code>, this method will return a
|
|
reference to the value that was passed to the closure.</p>
|
|
<p>Before <code>wait_for</code> starts waiting for changes, it will call the closure
|
|
on the current value. If the closure returns <code>true</code> when given the
|
|
current value, then <code>wait_for</code> will immediately return a reference to
|
|
the current value. This is the case even if the current value is already
|
|
considered seen.</p>
|
|
<p>The watch channel only keeps track of the most recent value, so if
|
|
several messages are sent faster than <code>wait_for</code> is able to call the
|
|
closure, then it may skip some updates. Whenever the closure is called,
|
|
it will be called with the most recent value.</p>
|
|
<p>When this function returns, the value that was passed to the closure
|
|
when it returned <code>true</code> will be considered seen.</p>
|
|
<p>If the channel is closed, then <code>wait_for</code> will return a <a href="error/struct.RecvError.html" title="struct tokio::sync::watch::error::RecvError"><code>RecvError</code></a>.
|
|
Once this happens, no more messages can ever be sent on the channel.
|
|
When an error is returned, it is guaranteed that the closure has been
|
|
called on the last value, and that it returned <code>false</code> for that value.
|
|
(If the closure returned <code>true</code>, then the last value would have been
|
|
returned instead of the error.)</p>
|
|
<p>Like the <a href="struct.Receiver.html#method.borrow" title="method tokio::sync::watch::Receiver::borrow"><code>borrow</code></a> method, the returned borrow holds 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. See the documentation of <code>borrow</code> for more information on
|
|
this.</p>
|
|
<h5 id="cancel-safety-1"><a class="doc-anchor" href="#cancel-safety-1">§</a>Cancel safety</h5>
|
|
<p>This method is cancel safe. If you use it as the event in a
|
|
<a href="../../macro.select.html" title="macro tokio::select"><code>tokio::select!</code></a> statement and some other branch
|
|
completes first, then it is guaranteed that the last seen value <code>val</code>
|
|
(if any) satisfies <code>f(val) == false</code>.</p>
|
|
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
|
<p>If and only if the closure <code>f</code> panics. In that case, no resource owned
|
|
or shared by this <a href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver"><code>Receiver</code></a> will be poisoned.</p>
|
|
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
|
|
<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::{sleep, Duration};
|
|
|
|
<span class="attr">#[tokio::main(flavor = <span class="string">"current_thread"</span>, start_paused = <span class="bool-val">true</span>)]
|
|
</span><span class="kw">async fn </span>main() {
|
|
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = watch::channel(<span class="string">"hello"</span>);
|
|
|
|
tokio::spawn(<span class="kw">async move </span>{
|
|
sleep(Duration::from_secs(<span class="number">1</span>)).<span class="kw">await</span>;
|
|
tx.send(<span class="string">"goodbye"</span>).unwrap();
|
|
});
|
|
|
|
<span class="macro">assert!</span>(rx.wait_for(|val| <span class="kw-2">*</span>val == <span class="string">"goodbye"</span>).<span class="kw">await</span>.is_ok());
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>rx.borrow(), <span class="string">"goodbye"</span>);
|
|
}</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.same_channel" class="method"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#950-952">Source</a><h4 class="code-header">pub fn <a href="#method.same_channel" class="fn">same_channel</a>(&self, other: &Self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if receivers belong to the same channel.</p>
|
|
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</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="bool-val">true</span>);
|
|
<span class="kw">let </span>rx2 = rx.clone();
|
|
<span class="macro">assert!</span>(rx.same_channel(<span class="kw-2">&</span>rx2));
|
|
|
|
<span class="kw">let </span>(tx3, rx3) = tokio::sync::watch::channel(<span class="bool-val">true</span>);
|
|
<span class="macro">assert!</span>(!rx3.same_channel(<span class="kw-2">&</span>rx2));</code></pre></div></div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-Receiver%3CT%3E" class="impl"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#1004-1011">Source</a><a href="#impl-Clone-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#1005-1010">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> Self</h4></section></summary><div class='docblock'>Returns a duplicate of the value. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#245-247">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Receiver%3CT%3E" class="impl"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#184">Source</a><a href="#impl-Debug-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#184">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Drop-for-Receiver%3CT%3E" class="impl"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#1013-1022">Source</a><a href="#impl-Drop-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../../../src/tokio/sync/watch.rs.html#1014-1021">Source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.93.1/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Receiver%3CT%3E" class="impl"><a href="#impl-Freeze-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T></h3></section><section id="impl-RefUnwindSafe-for-Receiver%3CT%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> !<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T></h3></section><section id="impl-Send-for-Receiver%3CT%3E" class="impl"><a href="#impl-Send-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T><div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Sync-for-Receiver%3CT%3E" class="impl"><a href="#impl-Sync-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T><div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-Receiver%3CT%3E" class="impl"><a href="#impl-Unpin-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T></h3></section><section id="impl-UnwindSafe-for-Receiver%3CT%3E" class="impl"><a href="#impl-UnwindSafe-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> !<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::watch::Receiver">Receiver</a><T></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#547">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#549">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dest: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dest</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|
<p>That is, this conversion is whatever the implementation of
|
|
<code><a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#85-87">Source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#89">Source</a><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#90">Source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#94">Source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |