blob: 838c82450f60dd503c1d61de20a9b9d02c0fed6e [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A `Waker` is a handle for waking up a task by notifying its executor that it is ready to be run."><meta name="keywords" content="rust, rustlang, rust-lang, Waker"><title>Waker 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">&#9776;</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="#">Waker</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.as_raw">as_raw</a></li><li><a href="#method.from_raw">from_raw</a></li><li><a href="#method.wake">wake</a></li><li><a href="#method.wake_by_ref">wake_by_ref</a></li><li><a href="#method.will_wake">will_wake</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Waker">Clone</a></li><li><a href="#impl-Debug-for-Waker">Debug</a></li><li><a href="#impl-Drop-for-Waker">Drop</a></li><li><a href="#impl-From%3CArc%3CW%3E%3E-for-Waker">From&lt;Arc&lt;W&gt;&gt;</a></li><li><a href="#impl-Send-for-Waker">Send</a></li><li><a href="#impl-Sync-for-Waker">Sync</a></li><li><a href="#impl-Unpin-for-Waker">Unpin</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Waker">RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-Waker">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Waker">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Waker">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Waker">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-Waker">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-Waker">Into&lt;U&gt;</a></li><li><a href="#impl-ToOwned-for-Waker">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Waker">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Waker">TryInto&lt;U&gt;</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="#">Waker</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"><span class="since" title="Stable since Rust version 1.36.0">1.36.0</span> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Waker { /* 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 <code>Waker</code> is a handle for waking up a task by notifying its executor that it
is ready to be run.</p>
<p>This handle encapsulates a <a href="struct.RawWaker.html" title="RawWaker"><code>RawWaker</code></a> instance, which defines the
executor-specific wakeup behavior.</p>
<p>The typical life of a <code>Waker</code> is that it is constructed by an executor, wrapped in a
<a href="struct.Context.html" title="Context"><code>Context</code></a>, then passed to <a href="../future/trait.Future.html#tymethod.poll"><code>Future::poll()</code></a>. Then, if the future chooses to return
<a href="enum.Poll.html#variant.Pending"><code>Poll::Pending</code></a>, it must also store the waker somehow and call <a href="struct.Waker.html#method.wake" title="Waker::wake()"><code>Waker::wake()</code></a> when
the future should be polled again.</p>
<p>Implements [<code>Clone</code>], [<code>Send</code>], and [<code>Sync</code>]; therefore, a waker may be invoked
from any thread, including ones not in any way managed by the executor. For example,
this might be done to wake a future when a blocking function call completes on another
thread.</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-Waker" class="impl has-srclink"><a href="#impl-Waker" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.wake" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.wake" class="fnname">wake</a>(self)</h4></section></summary><div class="docblock"><p>Wake up the task associated with this <code>Waker</code>.</p>
<p>As long as the executor keeps running and the task is not finished, it is
guaranteed that each invocation of <a href="struct.Waker.html#method.wake"><code>wake()</code></a> (or
<a href="struct.Waker.html#method.wake_by_ref"><code>wake_by_ref()</code></a>) will be followed by at least one
<a href="../future/trait.Future.html#tymethod.poll"><code>poll()</code></a> of the task to which this <code>Waker</code> belongs. This makes
it possible to temporarily yield to other tasks while running potentially
unbounded processing loops.</p>
<p>Note that the above implies that multiple wake-ups may be coalesced into a
single <a href="../future/trait.Future.html#tymethod.poll"><code>poll()</code></a> invocation by the runtime.</p>
<p>Also note that yielding to competing tasks is not guaranteed: it is the
executor’s choice which task to run and the executor may choose to run the
current task again.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.wake_by_ref" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.wake_by_ref" class="fnname">wake_by_ref</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Wake up the task associated with this <code>Waker</code> without consuming the <code>Waker</code>.</p>
<p>This is similar to <a href="struct.Waker.html#method.wake"><code>wake()</code></a>, but may be slightly less efficient in
the case where an owned <code>Waker</code> is available. This method should be preferred to
calling <code>waker.clone().wake()</code>.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.will_wake" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.will_wake" class="fnname">will_wake</a>(&amp;self, other: &amp;<a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a>) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns <code>true</code> if this <code>Waker</code> and another <code>Waker</code> would awake the same task.</p>
<p>This function works on a best-effort basis, and may return false even
when the <code>Waker</code>s would awaken the same task. However, if this function
returns <code>true</code>, it is guaranteed that the <code>Waker</code>s will awaken the same task.</p>
<p>This function is primarily used for optimization purposes.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_raw" class="method has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/102012" title="Tracking issue for const_waker">unstable</a></span><h4 class="code-header">pub unsafe fn <a href="#method.from_raw" class="fnname">from_raw</a>(waker: <a class="struct" href="struct.RawWaker.html" title="struct futures::task::RawWaker">RawWaker</a>) -&gt; <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a></h4></section></summary><div class="docblock"><p>Creates a new <code>Waker</code> from <a href="struct.RawWaker.html" title="RawWaker"><code>RawWaker</code></a>.</p>
<p>The behavior of the returned <code>Waker</code> is undefined if the contract defined
in <a href="struct.RawWaker.html" title="RawWaker"><code>RawWaker</code></a>’s and <a href="struct.RawWakerVTable.html" title="RawWakerVTable"><code>RawWakerVTable</code></a>’s documentation is not upheld.
Therefore this method is unsafe.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_raw" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.as_raw" class="fnname">as_raw</a>(&amp;self) -&gt; &amp;<a class="struct" href="struct.RawWaker.html" title="struct futures::task::RawWaker">RawWaker</a></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>waker_getters</code>)</span></div></span></summary><div class="docblock"><p>Get a reference to the underlying <a href="struct.RawWaker.html" title="RawWaker"><code>RawWaker</code></a>.</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-Clone-for-Waker" class="impl has-srclink"><a href="#impl-Clone-for-Waker" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Waker" class="impl has-srclink"><a href="#impl-Debug-for-Waker" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</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 href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; Result&lt;(), Error&gt;</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-Waker" class="impl has-srclink"><a href="#impl-Drop-for-Waker" class="anchor"></a><h3 class="code-header">impl Drop for <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a></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 href="#method.drop" class="anchor"></a><h4 class="code-header">fn <a class="fnname">drop</a>(&amp;mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CArc%3CW%3E%3E-for-Waker" class="impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.51.0">1.51.0</span><a href="#impl-From%3CArc%3CW%3E%3E-for-Waker" class="anchor"></a><h3 class="code-header">impl&lt;W&gt; From&lt;Arc&lt;W&gt;&gt; for <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;W: 'static + Wake + Send + Sync,</span></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"><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(waker: Arc&lt;W&gt;) -&gt; <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a></h4></section></summary><div class="docblock"><p>Use a <code>Wake</code>-able type as a <code>Waker</code>.</p>
<p>No heap allocations or atomic operations are used for this conversion.</p>
</div></details></div></details><section id="impl-Send-for-Waker" class="impl has-srclink"><a href="#impl-Send-for-Waker" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a></h3></section><section id="impl-Sync-for-Waker" class="impl has-srclink"><a href="#impl-Sync-for-Waker" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a></h3></section><section id="impl-Unpin-for-Waker" class="impl has-srclink"><a href="#impl-Unpin-for-Waker" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</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-Waker" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Waker" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</a></h3></section><section id="impl-UnwindSafe-for-Waker" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Waker" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.Waker.html" title="struct futures::task::Waker">Waker</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-Waker" class="impl has-srclink"><a href="#impl-Any-for-Waker" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>(&amp;self) -&gt; 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-Waker" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Waker" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</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="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" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;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-Waker" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Waker" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>(&amp;mut self) -&gt; &amp;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-Waker" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Waker" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-1" 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-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Waker" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Waker" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="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) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Waker" class="impl has-srclink"><a href="#impl-ToOwned-for-Waker" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; ToOwned for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&amp;self, target: &amp;mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Waker" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Waker" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a 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) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Waker" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Waker" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::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) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>