| <!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="Indicates whether a value is available or if the current task has been scheduled to receive a wakeup instead."><meta name="keywords" content="rust, rustlang, rust-lang, Poll"><title>Poll 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 enum"><!--[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="#">Poll</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block"><li><a href="#variant.Pending">Pending</a></li><li><a href="#variant.Ready">Ready</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.is_pending">is_pending</a></li><li><a href="#method.is_ready">is_ready</a></li><li><a href="#method.map">map</a></li><li><a href="#method.map_err">map_err</a></li><li><a href="#method.map_err-1">map_err</a></li><li><a href="#method.map_ok">map_ok</a></li><li><a href="#method.map_ok-1">map_ok</a></li><li><a href="#method.ready">ready</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Poll%3CT%3E">Clone</a></li><li><a href="#impl-Copy-for-Poll%3CT%3E">Copy</a></li><li><a href="#impl-Debug-for-Poll%3CT%3E">Debug</a></li><li><a href="#impl-Eq-for-Poll%3CT%3E">Eq</a></li><li><a href="#impl-From%3CT%3E-for-Poll%3CT%3E">From<T></a></li><li><a href="#impl-FromResidual%3CReady%3CInfallible%3E%3E-for-Poll%3CT%3E">FromResidual<Ready<Infallible>></a></li><li><a href="#impl-FromResidual%3CResult%3CInfallible%2C%20E%3E%3E-for-Poll%3COption%3CResult%3CT%2C%20F%3E%3E%3E">FromResidual<Result<Infallible, E>></a></li><li><a href="#impl-FromResidual%3CResult%3CInfallible%2C%20E%3E%3E-for-Poll%3CResult%3CT%2C%20F%3E%3E">FromResidual<Result<Infallible, E>></a></li><li><a href="#impl-Hash-for-Poll%3CT%3E">Hash</a></li><li><a href="#impl-Ord-for-Poll%3CT%3E">Ord</a></li><li><a href="#impl-PartialEq%3CPoll%3CT%3E%3E-for-Poll%3CT%3E">PartialEq<Poll<T>></a></li><li><a href="#impl-PartialOrd%3CPoll%3CT%3E%3E-for-Poll%3CT%3E">PartialOrd<Poll<T>></a></li><li><a href="#impl-StructuralEq-for-Poll%3CT%3E">StructuralEq</a></li><li><a href="#impl-StructuralPartialEq-for-Poll%3CT%3E">StructuralPartialEq</a></li><li><a href="#impl-Try-for-Poll%3COption%3CResult%3CT%2C%20E%3E%3E%3E">Try</a></li><li><a href="#impl-Try-for-Poll%3CResult%3CT%2C%20E%3E%3E">Try</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Poll%3CT%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Poll%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-Poll%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-Poll%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Poll%3CT%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Poll%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Poll%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Poll%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3C!%3E-for-Poll%3CT%3E">From<!></a></li><li><a href="#impl-From%3CT%3E-for-Poll%3CT%3E-1">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Poll%3CT%3E">Into<U></a></li><li><a href="#impl-ToOwned-for-Poll%3CT%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Poll%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Poll%3CT%3E">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">Enum <a href="../index.html">futures</a>::<wbr><a href="index.html">task</a>::<wbr><a class="enum" href="#">Poll</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">−</span>]</a></span></div><div class="item-decl"><pre class="rust enum"><code>pub enum Poll<T> { |
| Ready(T), |
| Pending, |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Indicates whether a value is available or if the current task has been |
| scheduled to receive a wakeup instead.</p> |
| </div></details><h2 id="variants" class="variants small-section-header">Variants<a href="#variants" class="anchor"></a></h2><h3 id="variant.Ready" class="variant small-section-header"><a href="#variant.Ready" class="anchor field"></a><code>Ready(T)</code></h3><div class="docblock"><p>Represents that a value is immediately ready.</p> |
| </div><h3 id="variant.Pending" class="variant small-section-header"><a href="#variant.Pending" class="anchor field"></a><code>Pending</code></h3><div class="docblock"><p>Represents that a value is not ready yet.</p> |
| <p>When a function returns <code>Pending</code>, the function <em>must</em> also |
| ensure that the current task is scheduled to be awoken when |
| progress can be made.</p> |
| </div><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-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.map" class="fnname">map</a><U, F>(self, f: F) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><U><span class="where fmt-newline">where<br> F: FnOnce(T) -> U,</span></h4></section></summary><div class="docblock"><p>Maps a <code>Poll<T></code> to <code>Poll<U></code> by applying a function to a contained value.</p> |
| <h5 id="examples"><a href="#examples">Examples</a></h5> |
| <p>Converts a <code>Poll<<a href="../../std/string/struct.String.html" title="String">String</a>></code> into a <code>Poll<[usize]></code>, consuming |
| the original:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>poll_some_string = Poll::Ready(String::from(<span class="string">"Hello, World!"</span>)); |
| <span class="comment">// `Poll::map` takes self *by value*, consuming `poll_some_string` |
| </span><span class="kw">let </span>poll_some_len = poll_some_string.map(|s| s.len()); |
| |
| <span class="macro">assert_eq!</span>(poll_some_len, Poll::Ready(<span class="number">13</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_ready" class="method has-srclink"><span class="since rightside" title="const since 1.49.0">const: 1.49.0</span><h4 class="code-header">pub const fn <a href="#method.is_ready" class="fnname">is_ready</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the poll is a <a href="enum.Poll.html#variant.Ready" title="Poll::Ready"><code>Poll::Ready</code></a> value.</p> |
| <h5 id="examples-1"><a href="#examples-1">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x: Poll<u32> = Poll::Ready(<span class="number">2</span>); |
| <span class="macro">assert_eq!</span>(x.is_ready(), <span class="bool-val">true</span>); |
| |
| <span class="kw">let </span>x: Poll<u32> = Poll::Pending; |
| <span class="macro">assert_eq!</span>(x.is_ready(), <span class="bool-val">false</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_pending" class="method has-srclink"><span class="since rightside" title="const since 1.49.0">const: 1.49.0</span><h4 class="code-header">pub const fn <a href="#method.is_pending" class="fnname">is_pending</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the poll is a <a href="enum.Poll.html#variant.Pending"><code>Pending</code></a> value.</p> |
| <h5 id="examples-2"><a href="#examples-2">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x: Poll<u32> = Poll::Ready(<span class="number">2</span>); |
| <span class="macro">assert_eq!</span>(x.is_pending(), <span class="bool-val">false</span>); |
| |
| <span class="kw">let </span>x: Poll<u32> = Poll::Pending; |
| <span class="macro">assert_eq!</span>(x.is_pending(), <span class="bool-val">true</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ready" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.ready" class="fnname">ready</a>(self) -> Ready<T></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>poll_ready</code>)</span></div></span></summary><div class="docblock"><p>Extracts the successful type of a <a href="enum.Poll.html" title="Poll<T>"><code>Poll<T></code></a>.</p> |
| <p>When combined with the <code>?</code> operator, this function will |
| propagate any <a href="enum.Poll.html#variant.Pending" title="Poll::Pending"><code>Poll::Pending</code></a> values to the caller, and |
| extract the <code>T</code> from <a href="enum.Poll.html#variant.Ready" title="Poll::Ready"><code>Poll::Ready</code></a>.</p> |
| <h5 id="examples-3"><a href="#examples-3">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attribute">#![feature(poll_ready)] |
| |
| </span><span class="kw">use </span>std::task::{Context, Poll}; |
| <span class="kw">use </span>std::future::{<span class="self">self</span>, Future}; |
| <span class="kw">use </span>std::pin::Pin; |
| |
| <span class="kw">pub fn </span>do_poll(cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<()> { |
| <span class="kw">let </span><span class="kw-2">mut </span>fut = future::ready(<span class="number">42</span>); |
| <span class="kw">let </span>fut = Pin::new(<span class="kw-2">&mut </span>fut); |
| |
| <span class="kw">let </span>num = fut.poll(cx).ready()<span class="question-mark">?</span>; |
| <span class="comment">// ... use num |
| |
| </span>Poll::Ready(()) |
| }</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Poll%3CResult%3CT%2C%20E%3E%3E" class="impl has-srclink"><a href="#impl-Poll%3CResult%3CT%2C%20E%3E%3E" class="anchor"></a><h3 class="code-header">impl<T, E> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<T, E>></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map_ok" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.map_ok" class="fnname">map_ok</a><U, F>(self, f: F) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<U, E>><span class="where fmt-newline">where<br> F: FnOnce(T) -> U,</span></h4></section></summary><div class="docblock"><p>Maps a <code>Poll<Result<T, E>></code> to <code>Poll<Result<U, E>></code> by applying a |
| function to a contained <code>Poll::Ready(Ok)</code> value, leaving all other |
| variants untouched.</p> |
| <p>This function can be used to compose the results of two functions.</p> |
| <h5 id="examples-4"><a href="#examples-4">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>res: Poll<<span class="prelude-ty">Result</span><u8, <span class="kw">_</span>>> = Poll::Ready(<span class="string">"12"</span>.parse()); |
| <span class="kw">let </span>squared = res.map_ok(|n| n * n); |
| <span class="macro">assert_eq!</span>(squared, Poll::Ready(<span class="prelude-val">Ok</span>(<span class="number">144</span>)));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map_err" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.map_err" class="fnname">map_err</a><U, F>(self, f: F) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<T, U>><span class="where fmt-newline">where<br> F: FnOnce(E) -> U,</span></h4></section></summary><div class="docblock"><p>Maps a <code>Poll::Ready<Result<T, E>></code> to <code>Poll::Ready<Result<T, F>></code> by |
| applying a function to a contained <code>Poll::Ready(Err)</code> value, leaving all other |
| variants untouched.</p> |
| <p>This function can be used to pass through a successful result while handling |
| an error.</p> |
| <h5 id="examples-5"><a href="#examples-5">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>res: Poll<<span class="prelude-ty">Result</span><u8, <span class="kw">_</span>>> = Poll::Ready(<span class="string">"oops"</span>.parse()); |
| <span class="kw">let </span>res = res.map_err(|<span class="kw">_</span>| <span class="number">0_u8</span>); |
| <span class="macro">assert_eq!</span>(res, Poll::Ready(<span class="prelude-val">Err</span>(<span class="number">0</span>)));</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Poll%3COption%3CResult%3CT%2C%20E%3E%3E%3E" class="impl has-srclink"><a href="#impl-Poll%3COption%3CResult%3CT%2C%20E%3E%3E%3E" class="anchor"></a><h3 class="code-header">impl<T, E> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<Result<T, E>>></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map_ok-1" class="method has-srclink"><span class="since rightside" title="Stable since Rust version 1.51.0">1.51.0</span><h4 class="code-header">pub fn <a href="#method.map_ok-1" class="fnname">map_ok</a><U, F>(self, f: F) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<Result<U, E>>><span class="where fmt-newline">where<br> F: FnOnce(T) -> U,</span></h4></section></summary><div class="docblock"><p>Maps a <code>Poll<Option<Result<T, E>>></code> to <code>Poll<Option<Result<U, E>>></code> by |
| applying a function to a contained <code>Poll::Ready(Some(Ok))</code> value, |
| leaving all other variants untouched.</p> |
| <p>This function can be used to compose the results of two functions.</p> |
| <h5 id="examples-6"><a href="#examples-6">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>res: Poll<<span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><u8, <span class="kw">_</span>>>> = Poll::Ready(<span class="prelude-val">Some</span>(<span class="string">"12"</span>.parse())); |
| <span class="kw">let </span>squared = res.map_ok(|n| n * n); |
| <span class="macro">assert_eq!</span>(squared, Poll::Ready(<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(<span class="number">144</span>))));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map_err-1" class="method has-srclink"><span class="since rightside" title="Stable since Rust version 1.51.0">1.51.0</span><h4 class="code-header">pub fn <a href="#method.map_err-1" class="fnname">map_err</a><U, F>(self, f: F) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<Result<T, U>>><span class="where fmt-newline">where<br> F: FnOnce(E) -> U,</span></h4></section></summary><div class="docblock"><p>Maps a <code>Poll::Ready<Option<Result<T, E>>></code> to |
| <code>Poll::Ready<Option<Result<T, F>>></code> by applying a function to a |
| contained <code>Poll::Ready(Some(Err))</code> value, leaving all other variants |
| untouched.</p> |
| <p>This function can be used to pass through a successful result while handling |
| an error.</p> |
| <h5 id="examples-7"><a href="#examples-7">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>res: Poll<<span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><u8, <span class="kw">_</span>>>> = Poll::Ready(<span class="prelude-val">Some</span>(<span class="string">"oops"</span>.parse())); |
| <span class="kw">let </span>res = res.map_err(|<span class="kw">_</span>| <span class="number">0_u8</span>); |
| <span class="macro">assert_eq!</span>(res, Poll::Ready(<span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(<span class="number">0</span>))));</code></pre></div> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Clone-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Clone for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: Clone,</span></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>(&self) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T></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>(&mut self, source: &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-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Debug-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Debug for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: Debug,</span></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>(&self, f: &mut Formatter<'_>) -> Result<(), Error></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-From%3CT%3E-for-Poll%3CT%3E" class="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="#impl-From%3CT%3E-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T></h4></section></summary><div class="docblock"><p>Moves the value into a <a href="enum.Poll.html#variant.Ready" title="Poll::Ready"><code>Poll::Ready</code></a> to make a <code>Poll<T></code>.</p> |
| <h5 id="example"><a href="#example">Example</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(Poll::from(<span class="bool-val">true</span>), Poll::Ready(<span class="bool-val">true</span>));</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-FromResidual%3CReady%3CInfallible%3E%3E-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-FromResidual%3CReady%3CInfallible%3E%3E-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> FromResidual<Ready<Infallible>> for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_residual-2" class="method trait-impl has-srclink"><a href="#method.from_residual-2" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from_residual</a>(residual: Ready<Infallible>) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>Constructs the type from a compatible <code>Residual</code> type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-FromResidual%3CResult%3CInfallible%2C%20E%3E%3E-for-Poll%3COption%3CResult%3CT%2C%20F%3E%3E%3E" class="impl has-srclink"><a href="#impl-FromResidual%3CResult%3CInfallible%2C%20E%3E%3E-for-Poll%3COption%3CResult%3CT%2C%20F%3E%3E%3E" class="anchor"></a><h3 class="code-header">impl<T, E, F> FromResidual<Result<Infallible, E>> for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<Result<T, F>>><span class="where fmt-newline">where<br> F: From<E>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_residual-1" class="method trait-impl has-srclink"><a href="#method.from_residual-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from_residual</a>(x: Result<Infallible, E>) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<Result<T, F>>></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>Constructs the type from a compatible <code>Residual</code> type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-FromResidual%3CResult%3CInfallible%2C%20E%3E%3E-for-Poll%3CResult%3CT%2C%20F%3E%3E" class="impl has-srclink"><a href="#impl-FromResidual%3CResult%3CInfallible%2C%20E%3E%3E-for-Poll%3CResult%3CT%2C%20F%3E%3E" class="anchor"></a><h3 class="code-header">impl<T, E, F> FromResidual<Result<Infallible, E>> for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<T, F>><span class="where fmt-newline">where<br> F: From<E>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_residual" class="method trait-impl has-srclink"><a href="#method.from_residual" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from_residual</a>(x: Result<Infallible, E>) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<T, F>></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>Constructs the type from a compatible <code>Residual</code> type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Hash-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Hash-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Hash for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: Hash,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash" class="method trait-impl has-srclink"><a href="#method.hash" class="anchor"></a><h4 class="code-header">fn <a class="fnname">hash</a><__H>(&self, state: &mut __H)<span class="where fmt-newline">where<br> __H: Hasher,</span></h4></section></summary><div class='docblock'>Feeds this value into the given [<code>Hasher</code>]. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash_slice" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.3.0">1.3.0</span><a href="#method.hash_slice" class="anchor"></a><h4 class="code-header">fn <a class="fnname">hash_slice</a><H>(data: &[Self], state: &mut H)<span class="where fmt-newline">where<br> H: Hasher,</span></h4></section></summary><div class='docblock'>Feeds a slice of this type into the given [<code>Hasher</code>]. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Ord-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Ord-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Ord for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: Ord,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cmp" class="method trait-impl has-srclink"><a href="#method.cmp" class="anchor"></a><h4 class="code-header">fn <a class="fnname">cmp</a>(&self, other: &<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T>) -> Ordering</h4></section></summary><div class='docblock'>This method returns an [<code>Ordering</code>] between <code>self</code> and <code>other</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.21.0">1.21.0</span><a href="#method.max" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">max</a>(self, other: Self) -> Self</h4></section></summary><div class='docblock'>Compares and returns the maximum of two values. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.min" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.21.0">1.21.0</span><a href="#method.min" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">min</a>(self, other: Self) -> Self</h4></section></summary><div class='docblock'>Compares and returns the minimum of two values. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clamp" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.50.0">1.50.0</span><a href="#method.clamp" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clamp</a>(self, min: Self, max: Self) -> Self<span class="where fmt-newline">where<br> Self: PartialOrd<Self>,</span></h4></section></summary><div class='docblock'>Restrict a value to a certain interval. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CPoll%3CT%3E%3E-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-PartialEq%3CPoll%3CT%3E%3E-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> PartialEq<<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T>> for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: PartialEq<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a class="fnname">eq</a>(&self, other: &<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T>) -> bool</h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used |
| by <code>==</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" 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.ne" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ne</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always |
| sufficient, and should not be overridden without very good reason. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialOrd%3CPoll%3CT%3E%3E-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-PartialOrd%3CPoll%3CT%3E%3E-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> PartialOrd<<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T>> for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: PartialOrd<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.partial_cmp" class="method trait-impl has-srclink"><a href="#method.partial_cmp" class="anchor"></a><h4 class="code-header">fn <a class="fnname">partial_cmp</a>(&self, other: &<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T>) -> Option<Ordering></h4></section></summary><div class='docblock'>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lt" 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.lt" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">lt</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.le" 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.le" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">le</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code> |
| operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.gt" 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.gt" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">gt</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ge" 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.ge" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ge</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code> |
| operator. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Try-for-Poll%3COption%3CResult%3CT%2C%20E%3E%3E%3E" class="impl has-srclink"><a href="#impl-Try-for-Poll%3COption%3CResult%3CT%2C%20E%3E%3E%3E" class="anchor"></a><h3 class="code-header">impl<T, E> Try for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<Result<T, E>>></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Output</a> = <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<T>></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>The type of the value produced by <code>?</code> when <em>not</em> short-circuiting.</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.Residual-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Residual-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Residual</a> = Result<Infallible, E></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>The type of the value passed to [<code>FromResidual::from_residual</code>] |
| as part of <code>?</code> when short-circuiting. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_output-1" class="method trait-impl has-srclink"><a href="#method.from_output-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from_output</a>(<br> c: <<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<Result<T, E>>> as Try>::Output<br>) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<Result<T, E>>></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>Constructs the type from its <code>Output</code> type. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.branch-1" class="method trait-impl has-srclink"><a href="#method.branch-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">branch</a>(<br> self<br>) -> ControlFlow<<<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<Result<T, E>>> as Try>::Residual, <<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Option<Result<T, E>>> as Try>::Output></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>Used in <code>?</code> to decide whether the operator should produce a value |
| (because this returned [<code>ControlFlow::Continue</code>]) |
| or propagate a value back to the caller |
| (because this returned [<code>ControlFlow::Break</code>]). <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Try-for-Poll%3CResult%3CT%2C%20E%3E%3E" class="impl has-srclink"><a href="#impl-Try-for-Poll%3CResult%3CT%2C%20E%3E%3E" class="anchor"></a><h3 class="code-header">impl<T, E> Try for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<T, E>></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Output</a> = <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>The type of the value produced by <code>?</code> when <em>not</em> short-circuiting.</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.Residual" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Residual" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Residual</a> = Result<Infallible, E></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>The type of the value passed to [<code>FromResidual::from_residual</code>] |
| as part of <code>?</code> when short-circuiting. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_output" class="method trait-impl has-srclink"><a href="#method.from_output" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from_output</a>(c: <<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<T, E>> as Try>::Output) -> <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<T, E>></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>Constructs the type from its <code>Output</code> type. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.branch" class="method trait-impl has-srclink"><a href="#method.branch" class="anchor"></a><h4 class="code-header">fn <a class="fnname">branch</a>(<br> self<br>) -> ControlFlow<<<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<T, E>> as Try>::Residual, <<a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<T, E>> as Try>::Output></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>try_trait_v2</code>)</span></div></span><div class='docblock'>Used in <code>?</code> to decide whether the operator should produce a value |
| (because this returned [<code>ControlFlow::Continue</code>]) |
| or propagate a value back to the caller |
| (because this returned [<code>ControlFlow::Break</code>]). <a>Read more</a></div></details></div></details><section id="impl-Copy-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Copy-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Copy for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: Copy,</span></h3></section><section id="impl-Eq-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Eq-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Eq for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: Eq,</span></h3></section><section id="impl-StructuralEq-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-StructuralEq-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> StructuralEq for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T></h3></section><section id="impl-StructuralPartialEq-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-StructuralPartialEq-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> StructuralPartialEq for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T></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-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> RefUnwindSafe for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Send for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: Send,</span></h3></section><section id="impl-Sync-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Sync for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: Sync,</span></h3></section><section id="impl-Unpin-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Unpin for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> UnwindSafe for <a class="enum" href="enum.Poll.html" title="enum futures::task::Poll">Poll</a><T><span class="where fmt-newline">where<br> T: UnwindSafe,</span></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-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" 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>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3C!%3E-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-From%3C!%3E-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<!> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-2" 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-2" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: !) -> T</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Poll%3CT%3E-1" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Poll%3CT%3E-1" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-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) -> 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-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> 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>(&self) -> 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>(&self, target: &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-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Poll%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Poll%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
