mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
15 lines
10 KiB
HTML
15 lines
10 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="API documentation for the Rust `FusedStream` trait in crate `futures_core`."><meta name="keywords" content="rust, rustlang, rust-lang, FusedStream"><title>futures_core::stream::FusedStream - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../futures_core/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait FusedStream</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.is_terminated">is_terminated</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-FusedStream-for-%26mut%20F">&mut F</a><a href="#impl-FusedStream-for-Box%3CS%3E">Box<S></a><a href="#impl-FusedStream-for-Pin%3CP%3E">Pin<P></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">futures_core</a>::<wbr><a href="index.html">stream</a></p><div id="sidebar-vars" data-name="FusedStream" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">futures_core</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="trait" href="">FusedStream</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/futures_core/stream.rs.html#145-148" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait FusedStream: <a class="trait" href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</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>;
|
||
}</pre></div><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><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.is_terminated" class="method"><code>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><a class="srclink" href="../../src/futures_core/stream.rs.html#147" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns <code>true</code> if the stream should no longer be polled.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-FusedStream-for-%26mut%20F" class="impl"><code class="in-band">impl<F: ?<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="../../futures_core/stream/trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</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="../../futures_core/stream/trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>F</code><a href="#impl-FusedStream-for-%26mut%20F" class="anchor"></a><a class="srclink" href="../../src/futures_core/stream.rs.html#150-154" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.is_terminated" class="method hidden"><code>fn <a href="#method.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><a class="srclink" href="../../src/futures_core/stream.rs.html#151-153" title="goto source code">[src]</a></h4></div><h3 id="impl-FusedStream-for-Pin%3CP%3E" class="impl"><code class="in-band">impl<P> <a class="trait" href="../../futures_core/stream/trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</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="type" 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="../../futures_core/stream/trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</a>, </span></code><a href="#impl-FusedStream-for-Pin%3CP%3E" class="anchor"></a><a class="srclink" href="../../src/futures_core/stream.rs.html#156-164" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.is_terminated-1" class="method hidden"><code>fn <a href="#method.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><a class="srclink" href="../../src/futures_core/stream.rs.html#161-163" title="goto source code">[src]</a></h4></div><h3 id="impl-FusedStream-for-Box%3CS%3E" class="impl"><code class="in-band">impl<S: ?<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="../../futures_core/stream/trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</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="../../futures_core/stream/trait.FusedStream.html" title="trait futures_core::stream::FusedStream">FusedStream</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><S></code><a href="#impl-FusedStream-for-Box%3CS%3E" class="anchor"></a><a class="srclink" href="../../src/futures_core/stream.rs.html#241-245" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.is_terminated-2" class="method hidden"><code>fn <a href="#method.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><a class="srclink" href="../../src/futures_core/stream.rs.html#242-244" title="goto source code">[src]</a></h4></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/futures_core/stream/trait.FusedStream.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures_core"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |