| <!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 future which tracks whether or not the underlying future should no longer be polled."><meta name="keywords" content="rust, rustlang, rust-lang, FusedFuture"><title>FusedFuture in futures_core::future - 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 trait"><!--[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_core/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_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">FusedFuture</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.is_terminated">is_terminated</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-FusedFuture-for-%26mut%20F">&mut F</a></li><li><a href="#impl-FusedFuture-for-AssertUnwindSafe%3CF%3E">AssertUnwindSafe<F></a></li><li><a href="#impl-FusedFuture-for-Box%3CF%3E">Box<F></a></li><li><a href="#impl-FusedFuture-for-Pin%3CP%3E">Pin<P></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In futures_core::future</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">Trait <a href="../index.html">futures_core</a>::<wbr><a href="index.html">future</a>::<wbr><a class="trait" href="#">FusedFuture</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/future.rs.html#27-30">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 trait"><code>pub trait FusedFuture: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> { |
| fn <a href="#tymethod.is_terminated" class="fnname">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A future which tracks whether or not the underlying future |
| should no longer be polled.</p> |
| <p><code>is_terminated</code> will return <code>true</code> if a future should no longer be polled. |
| Usually, this state occurs after <code>poll</code> (or <code>try_poll</code>) returned |
| <code>Poll::Ready</code>. However, <code>is_terminated</code> may also return <code>true</code> if a future |
| has become inactive and can no longer make progress and should be ignored |
| or dropped rather than being <code>poll</code>ed again.</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.is_terminated" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#29">source</a><h4 class="code-header">fn <a href="#tymethod.is_terminated" class="fnname">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the underlying future should no longer be polled.</p> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FusedFuture-for-%26mut%20F" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#32-36">source</a><a href="#impl-FusedFuture-for-%26mut%20F" class="anchor"></a><h3 class="code-header">impl<F: <a class="trait" href="trait.FusedFuture.html" title="trait futures_core::future::FusedFuture">FusedFuture</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="trait" href="trait.FusedFuture.html" title="trait futures_core::future::FusedFuture">FusedFuture</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>F</h3></section></summary><div class="impl-items"><section id="method.is_terminated" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#33-35">source</a><a href="#method.is_terminated" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_terminated" class="fnname">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FusedFuture-for-Pin%3CP%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#38-46">source</a><a href="#impl-FusedFuture-for-Pin%3CP%3E" class="anchor"></a><h3 class="code-header">impl<P> <a class="trait" href="trait.FusedFuture.html" title="trait futures_core::future::FusedFuture">FusedFuture</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,<br> P::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>: <a class="trait" href="trait.FusedFuture.html" title="trait futures_core::future::FusedFuture">FusedFuture</a>,</span></h3></section></summary><div class="impl-items"><section id="method.is_terminated-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#43-45">source</a><a href="#method.is_terminated-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_terminated" class="fnname">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FusedFuture-for-Box%3CF%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#91-95">source</a><a href="#impl-FusedFuture-for-Box%3CF%3E" class="anchor"></a><h3 class="code-header">impl<F: <a class="trait" href="trait.FusedFuture.html" title="trait futures_core::future::FusedFuture">FusedFuture</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="trait" href="trait.FusedFuture.html" title="trait futures_core::future::FusedFuture">FusedFuture</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><F></h3></section></summary><div class="impl-items"><section id="method.is_terminated-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#92-94">source</a><a href="#method.is_terminated-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_terminated" class="fnname">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FusedFuture-for-AssertUnwindSafe%3CF%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#98-102">source</a><a href="#impl-FusedFuture-for-AssertUnwindSafe%3CF%3E" class="anchor"></a><h3 class="code-header">impl<F: <a class="trait" href="trait.FusedFuture.html" title="trait futures_core::future::FusedFuture">FusedFuture</a>> <a class="trait" href="trait.FusedFuture.html" title="trait futures_core::future::FusedFuture">FusedFuture</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/struct.AssertUnwindSafe.html" title="struct core::panic::unwind_safe::AssertUnwindSafe">AssertUnwindSafe</a><F></h3></section></summary><div class="impl-items"><section id="method.is_terminated-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#99-101">source</a><a href="#method.is_terminated-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_terminated" class="fnname">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../../implementors/futures_core/future/trait.FusedFuture.js" data-ignore-extern-crates="alloc,core" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
