| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A synchronization primitive for task wakeup."><meta name="keywords" content="rust, rustlang, rust-lang, AtomicWaker"><title>AtomicWaker in futures::task - 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="../../futures/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="../../futures/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">AtomicWaker</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.register">register</a></li><li><a href="#method.take">take</a></li><li><a href="#method.wake">wake</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-AtomicWaker">Debug</a></li><li><a href="#impl-Default-for-AtomicWaker">Default</a></li><li><a href="#impl-Send-for-AtomicWaker">Send</a></li><li><a href="#impl-Sync-for-AtomicWaker">Sync</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-AtomicWaker">!RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-AtomicWaker">Unpin</a></li><li><a href="#impl-UnwindSafe-for-AtomicWaker">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-AtomicWaker">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-AtomicWaker">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-AtomicWaker">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-AtomicWaker">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-AtomicWaker">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-AtomicWaker">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-AtomicWaker">TryInto<U></a></li></ul></section><h2><a href="index.html">In futures::task</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">futures</a>::<wbr><a href="index.html">task</a>::<wbr><a class="struct" href="#">AtomicWaker</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/futures_core/task/__internal/atomic_waker.rs.html#96">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 AtomicWaker { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A synchronization primitive for task wakeup.</p> |
| <p>Sometimes the task interested in a given event will change over time. |
| An <code>AtomicWaker</code> can coordinate concurrent notifications with the consumer |
| potentially “updating” the underlying task to wake up. This is useful in |
| scenarios where a computation completes in another thread and wants to |
| notify the consumer, but the consumer is in the process of being migrated to |
| a new logical task.</p> |
| <p>Consumers should call <code>register</code> before checking the result of a computation |
| and producers should call <code>wake</code> after producing the computation (this |
| differs from the usual <code>thread::park</code> pattern). It is also permitted for |
| <code>wake</code> to be called <strong>before</strong> <code>register</code>. This results in a no-op.</p> |
| <p>A single <code>AtomicWaker</code> may be reused for any number of calls to <code>register</code> or |
| <code>wake</code>.</p> |
| <h2 id="memory-ordering"><a href="#memory-ordering">Memory ordering</a></h2> |
| <p>Calling <code>register</code> “acquires” all memory “released” by calls to <code>wake</code> |
| before the call to <code>register</code>. Later calls to <code>wake</code> will wake the |
| registered waker (on contention this wake might be triggered in <code>register</code>).</p> |
| <p>For concurrent calls to <code>register</code> (should be avoided) the ordering is only |
| guaranteed for the winning call.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <p>Here is a simple example providing a <code>Flag</code> that can be signalled manually |
| when it is ready.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::future::Future; |
| <span class="kw">use </span>futures::task::{Context, Poll, AtomicWaker}; |
| <span class="kw">use </span>std::sync::Arc; |
| <span class="kw">use </span>std::sync::atomic::AtomicBool; |
| <span class="kw">use </span>std::sync::atomic::Ordering::Relaxed; |
| <span class="kw">use </span>std::pin::Pin; |
| |
| <span class="kw">struct </span>Inner { |
| waker: AtomicWaker, |
| set: AtomicBool, |
| } |
| |
| <span class="attribute">#[derive(Clone)] |
| </span><span class="kw">struct </span>Flag(Arc<Inner>); |
| |
| <span class="kw">impl </span>Flag { |
| <span class="kw">pub fn </span>new() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>(Arc::new(Inner { |
| waker: AtomicWaker::new(), |
| set: AtomicBool::new(<span class="bool-val">false</span>), |
| })) |
| } |
| |
| <span class="kw">pub fn </span>signal(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="self">self</span>.<span class="number">0</span>.set.store(<span class="bool-val">true</span>, Relaxed); |
| <span class="self">self</span>.<span class="number">0</span>.waker.wake(); |
| } |
| } |
| |
| <span class="kw">impl </span>Future <span class="kw">for </span>Flag { |
| <span class="kw">type </span>Output = (); |
| |
| <span class="kw">fn </span>poll(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<()> { |
| <span class="comment">// quick check to avoid registration if already done. |
| </span><span class="kw">if </span><span class="self">self</span>.<span class="number">0</span>.set.load(Relaxed) { |
| <span class="kw">return </span>Poll::Ready(()); |
| } |
| |
| <span class="self">self</span>.<span class="number">0</span>.waker.register(cx.waker()); |
| |
| <span class="comment">// Need to check condition **after** `register` to avoid a race |
| // condition that would result in lost notifications. |
| </span><span class="kw">if </span><span class="self">self</span>.<span class="number">0</span>.set.load(Relaxed) { |
| Poll::Ready(()) |
| } <span class="kw">else </span>{ |
| Poll::Pending |
| } |
| } |
| }</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-AtomicWaker" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/task/__internal/atomic_waker.rs.html#205">source</a><a href="#impl-AtomicWaker" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.AtomicWaker.html" title="struct futures::task::AtomicWaker">AtomicWaker</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/futures_core/task/__internal/atomic_waker.rs.html#207">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fnname">new</a>() -> <a class="struct" href="struct.AtomicWaker.html" title="struct futures::task::AtomicWaker">AtomicWaker</a></h4></section></summary><div class="docblock"><p>Create an <code>AtomicWaker</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.register" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_core/task/__internal/atomic_waker.rs.html#265">source</a><h4 class="code-header">pub fn <a href="#method.register" class="fnname">register</a>(&self, waker: &<a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a>)</h4></section></summary><div class="docblock"><p>Registers the waker to be notified on calls to <code>wake</code>.</p> |
| <p>The new task will take place of any previous tasks that were registered |
| by previous calls to <code>register</code>. Any calls to <code>wake</code> that happen after |
| a call to <code>register</code> (as defined by the memory ordering rules), will |
| notify the <code>register</code> caller’s task and deregister the waker from future |
| notifications. Because of this, callers should ensure <code>register</code> gets |
| invoked with a new <code>Waker</code> <strong>each</strong> time they require a wakeup.</p> |
| <p>It is safe to call <code>register</code> with multiple other threads concurrently |
| calling <code>wake</code>. This will result in the <code>register</code> caller’s current |
| task being notified once.</p> |
| <p>This function is safe to call concurrently, but this is generally a bad |
| idea. Concurrent calls to <code>register</code> will attempt to register different |
| tasks to be notified. One of the callers will win and have its task set, |
| but there is no guarantee as to which caller will succeed.</p> |
| <h5 id="examples-1"><a href="#examples-1">Examples</a></h5> |
| <p>Here is how <code>register</code> is used when implementing a flag.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::future::Future; |
| <span class="kw">use </span>futures::task::{Context, Poll, AtomicWaker}; |
| <span class="kw">use </span>std::sync::atomic::AtomicBool; |
| <span class="kw">use </span>std::sync::atomic::Ordering::Relaxed; |
| <span class="kw">use </span>std::pin::Pin; |
| |
| <span class="kw">struct </span>Flag { |
| waker: AtomicWaker, |
| set: AtomicBool, |
| } |
| |
| <span class="kw">impl </span>Future <span class="kw">for </span>Flag { |
| <span class="kw">type </span>Output = (); |
| |
| <span class="kw">fn </span>poll(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<()> { |
| <span class="comment">// Register **before** checking `set` to avoid a race condition |
| // that would result in lost notifications. |
| </span><span class="self">self</span>.waker.register(cx.waker()); |
| |
| <span class="kw">if </span><span class="self">self</span>.set.load(Relaxed) { |
| Poll::Ready(()) |
| } <span class="kw">else </span>{ |
| Poll::Pending |
| } |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.wake" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_core/task/__internal/atomic_waker.rs.html#363">source</a><h4 class="code-header">pub fn <a href="#method.wake" class="fnname">wake</a>(&self)</h4></section></summary><div class="docblock"><p>Calls <code>wake</code> on the last <code>Waker</code> passed to <code>register</code>.</p> |
| <p>If <code>register</code> has not been called yet, then this does nothing.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.take" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_core/task/__internal/atomic_waker.rs.html#377">source</a><h4 class="code-header">pub fn <a href="#method.take" class="fnname">take</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a>></h4></section></summary><div class="docblock"><p>Returns the last <code>Waker</code> passed to <code>register</code>, so that the user can wake it.</p> |
| <p>Sometimes, just waking the AtomicWaker is not fine grained enough. This allows the user |
| to take the waker and then wake it separately, rather than performing both steps in one |
| atomic action.</p> |
| <p>If a waker has not been registered, this returns <code>None</code>.</p> |
| </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-AtomicWaker" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/task/__internal/atomic_waker.rs.html#414">source</a><a href="#impl-Debug-for-AtomicWaker" 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.AtomicWaker.html" title="struct futures::task::AtomicWaker">AtomicWaker</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/futures_core/task/__internal/atomic_waker.rs.html#415">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>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</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-AtomicWaker" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/task/__internal/atomic_waker.rs.html#408">source</a><a href="#impl-Default-for-AtomicWaker" 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.AtomicWaker.html" title="struct futures::task::AtomicWaker">AtomicWaker</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/futures_core/task/__internal/atomic_waker.rs.html#409">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>() -> <a class="struct" href="struct.AtomicWaker.html" title="struct futures::task::AtomicWaker">AtomicWaker</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-Send-for-AtomicWaker" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/task/__internal/atomic_waker.rs.html#420">source</a><a href="#impl-Send-for-AtomicWaker" 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.AtomicWaker.html" title="struct futures::task::AtomicWaker">AtomicWaker</a></h3></section><section id="impl-Sync-for-AtomicWaker" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/task/__internal/atomic_waker.rs.html#421">source</a><a href="#impl-Sync-for-AtomicWaker" 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.AtomicWaker.html" title="struct futures::task::AtomicWaker">AtomicWaker</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-RefUnwindSafe-for-AtomicWaker" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-AtomicWaker" 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.AtomicWaker.html" title="struct futures::task::AtomicWaker">AtomicWaker</a></h3></section><section id="impl-Unpin-for-AtomicWaker" class="impl has-srclink"><a href="#impl-Unpin-for-AtomicWaker" 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.AtomicWaker.html" title="struct futures::task::AtomicWaker">AtomicWaker</a></h3></section><section id="impl-UnwindSafe-for-AtomicWaker" class="impl has-srclink"><a href="#impl-UnwindSafe-for-AtomicWaker" 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.AtomicWaker.html" title="struct futures::task::AtomicWaker">AtomicWaker</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-AtomicWaker" 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-AtomicWaker" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></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>(&self) -> <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-AtomicWaker" 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-AtomicWaker" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></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>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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-AtomicWaker" 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-AtomicWaker" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></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>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&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-AtomicWaker" 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-AtomicWaker" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</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) -> 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-AtomicWaker" 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-AtomicWaker" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</span></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) -> 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><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-AtomicWaker" 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-AtomicWaker" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</span></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) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="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'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-AtomicWaker" 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-AtomicWaker" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</span></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> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="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) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="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'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |