14 lines
9.9 KiB
HTML
14 lines
9.9 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A stream which tracks whether or not the underlying stream should no longer be polled."><title>FusedStream in futures_core::stream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="futures_core" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">FusedStream</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures_core/index.html">futures_<wbr>core</a><span class="version">0.3.32</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Fused<wbr>Stream</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.is_terminated" title="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-FusedStream-for-%26mut+F" title="&mut F">&mut F</a></li><li><a href="#impl-FusedStream-for-Box%3CS%3E" title="Box<S>">Box<S></a></li><li><a href="#impl-FusedStream-for-Pin%3CP%3E" title="Pin<P>">Pin<P></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In futures_<wbr>core::<wbr>stream</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">futures_core</a>::<wbr><a href="index.html">stream</a></div><h1>Trait <span class="trait">Fused<wbr>Stream</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/futures_core/stream.rs.html#146-149">Source</a> </span></div><pre class="rust item-decl"><code>pub trait FusedStream: <a class="trait" href="trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a> {
|
|
// Required method
|
|
fn <a href="#tymethod.is_terminated" class="fn">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A stream which tracks whether or not the underlying stream
|
|
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_next</code> (or <code>try_poll_next</code>) returned
|
|
<code>Poll::Ready(None)</code>. However, <code>is_terminated</code> may also return <code>true</code> if a
|
|
stream has become inactive and can no longer make progress and should be
|
|
ignored or dropped rather than being polled again.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.is_terminated" class="method"><a class="src rightside" href="../../src/futures_core/stream.rs.html#148">Source</a><h4 class="code-header">fn <a href="#tymethod.is_terminated" class="fn">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the stream should no longer be polled.</p>
|
|
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-FusedStream-for-%26mut+F" class="impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#151-155">Source</a><a href="#impl-FusedStream-for-%26mut+F" class="anchor">§</a><h3 class="code-header">impl<F: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="trait" href="trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut F</a></h3></section></summary><div class="impl-items"><section id="method.is_terminated" class="method trait-impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#152-154">Source</a><a href="#method.is_terminated" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_terminated" class="fn">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-FusedStream-for-Pin%3CP%3E" class="impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#157-165">Source</a><a href="#impl-FusedStream-for-Pin%3CP%3E" class="anchor">§</a><h3 class="code-header">impl<P> <a class="trait" href="trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</a> for <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><P><div class="where">where
|
|
P: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
|
P::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>: <a class="trait" href="trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</a>,</div></h3></section></summary><div class="impl-items"><section id="method.is_terminated-1" class="method trait-impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#162-164">Source</a><a href="#method.is_terminated-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_terminated" class="fn">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-FusedStream-for-Box%3CS%3E" class="impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#240-244">Source</a><a href="#impl-FusedStream-for-Box%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="trait" href="trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</a> for <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><S></h3></section></summary><div class="impl-items"><section id="method.is_terminated-2" class="method trait-impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#241-243">Source</a><a href="#method.is_terminated-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_terminated" class="fn">is_terminated</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/futures_core/stream/trait.FusedStream.js" data-ignore-extern-crates="core,alloc" async></script></section></div></main></body></html> |