mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 12:20:17 +01:00
15 lines
11 KiB
HTML
15 lines
11 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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures_core/index.html">futures_core</a><span class="version">0.3.28</span></h2></div><h2 class="location"><a href="#">FusedStream</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-FusedStream-for-%26mut+F">&mut F</a></li><li><a href="#impl-FusedStream-for-Box%3CS%3E">Box<S></a></li><li><a href="#impl-FusedStream-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::stream</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../futures_core/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">futures_core</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="trait" href="#">FusedStream</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/futures_core/stream.rs.html#136-139">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></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.76.0/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#138">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.76.0/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#141-145">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.76.0/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.76.0/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.76.0/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#142-144">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.76.0/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#147-155">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.76.0/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.76.0/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
||
P::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/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#152-154">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.76.0/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#230-234">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.76.0/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.76.0/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.76.0/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#231-233">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.76.0/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="alloc,core" async></script></section></div></main></body></html> |