Auto Generated Documentation

This commit is contained in:
github-actions[bot]
2021-03-26 19:20:48 +00:00
parent 8193a198a1
commit a4995c672b
12030 changed files with 74602 additions and 154846 deletions
@@ -1,7 +1,7 @@
<!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 `StreamExt` trait in crate `futures_util`."><meta name="keywords" content="rust, rustlang, rust-lang, StreamExt"><title>futures_util::stream::StreamExt - 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">&#9776;</div><a href='../../futures_util/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait StreamExt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.by_ref">by_ref</a><a href="#method.chain">chain</a><a href="#method.collect">collect</a><a href="#method.concat">concat</a><a href="#method.cycle">cycle</a><a href="#method.enumerate">enumerate</a><a href="#method.filter">filter</a><a href="#method.filter_map">filter_map</a><a href="#method.flat_map">flat_map</a><a href="#method.flatten">flatten</a><a href="#method.fold">fold</a><a href="#method.for_each">for_each</a><a href="#method.fuse">fuse</a><a href="#method.inspect">inspect</a><a href="#method.into_future">into_future</a><a href="#method.left_stream">left_stream</a><a href="#method.map">map</a><a href="#method.next">next</a><a href="#method.peekable">peekable</a><a href="#method.poll_next_unpin">poll_next_unpin</a><a href="#method.right_stream">right_stream</a><a href="#method.scan">scan</a><a href="#method.select_next_some">select_next_some</a><a href="#method.skip">skip</a><a href="#method.skip_while">skip_while</a><a href="#method.take">take</a><a href="#method.take_until">take_until</a><a href="#method.take_while">take_while</a><a href="#method.then">then</a><a href="#method.unzip">unzip</a><a href="#method.zip">zip</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">futures_util</a>::<wbr><a href="index.html">stream</a></p><script>window.sidebarCurrent = {name: "StreamExt", ty: "trait", relpath: ""};</script><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="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/futures_util/stream/stream/mod.rs.html#212-1472" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">futures_util</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="trait" href="">StreamExt</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait StreamExt: <a class="trait" href="../../futures_util/stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> {
<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">&#9776;</div><a href='../../futures_util/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait StreamExt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.concat">concat</a><a href="#method.map">map</a><a href="#method.next">next</a><a href="#method.flatten">flatten</a><a href="#method.fuse">fuse</a><a href="#method.then">then</a><a href="#method.inspect">inspect</a><a href="#method.into_future">into_future</a><a href="#method.take">take</a><a href="#method.chain">chain</a><a href="#method.collect">collect</a><a href="#method.unzip">unzip</a><a href="#method.cycle">cycle</a><a href="#method.enumerate">enumerate</a><a href="#method.filter">filter</a><a href="#method.filter_map">filter_map</a><a href="#method.fold">fold</a><a href="#method.for_each">for_each</a><a href="#method.select_next_some">select_next_some</a><a href="#method.skip">skip</a><a href="#method.skip_while">skip_while</a><a href="#method.take_while">take_while</a><a href="#method.take_until">take_until</a><a href="#method.zip">zip</a><a href="#method.scan">scan</a><a href="#method.flat_map">flat_map</a><a href="#method.by_ref">by_ref</a><a href="#method.peekable">peekable</a><a href="#method.left_stream">left_stream</a><a href="#method.right_stream">right_stream</a><a href="#method.poll_next_unpin">poll_next_unpin</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">futures_util</a>::<wbr><a href="index.html">stream</a></p><div id="sidebar-vars" data-name="StreamExt" 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_util</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="trait" href="">StreamExt</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">&#x2212;</span>]</a></span><a class="srclink" href="../../src/futures_util/stream/stream/mod.rs.html#212-1472" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait StreamExt: <a class="trait" href="../../futures_util/stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> {
fn <a href="#method.next" class="fnname">next</a>(&amp;mut self) -&gt; <a class="struct" href="../../futures_util/stream/struct.Next.html" title="struct futures_util::stream::Next">Next</a>&lt;'_, Self&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures_util/stream/struct.Next.html" title="struct futures_util::stream::Next">Next</a>&lt;'_, St&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;St:&nbsp;?<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_util/stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../futures_util/stream/struct.Next.html" title="struct futures_util::stream::Next">Next</a>&lt;'_, St&gt;</span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;St::<a class="type" href="../../futures_util/stream/trait.Stream.html#associatedtype.Item" title="type futures_util::stream::Stream::Item">Item</a>&gt;;</span></code></span></div></span></span><br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a></span>,
{ ... }
<div class="item-spacer"></div> fn <a href="#method.into_future" class="fnname">into_future</a>(self) -&gt; <a class="struct" href="../../futures_util/stream/struct.StreamFuture.html" title="struct futures_util::stream::StreamFuture">StreamFuture</a>&lt;Self&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures_util/stream/struct.StreamFuture.html" title="struct futures_util::stream::StreamFuture">StreamFuture</a>&lt;St&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;St:&nbsp;<a class="trait" href="../../futures_util/stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../futures_util/stream/struct.StreamFuture.html" title="struct futures_util::stream::StreamFuture">StreamFuture</a>&lt;St&gt;</span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;St::<a class="type" href="../../futures_util/stream/trait.Stream.html#associatedtype.Item" title="type futures_util::stream::Stream::Item">Item</a>&gt;, St<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></span></div></span></span><br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Self: <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></span>,
@@ -605,4 +605,5 @@ Using the future with a <a href="../../futures_util/future/trait.FusedFuture.htm
}
}
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">total</span>, <span class="number">6</span>);</pre></div>
</div></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"><h3 id="impl-StreamExt" class="impl"><code class="in-band">impl&lt;T:&nbsp;?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; StreamExt for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../futures_util/stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>,&nbsp;</span></code><a href="#impl-StreamExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/stream/stream/mod.rs.html#208" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/futures_util/stream/trait.StreamExt.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "futures_util";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
</div></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"><h3 id="impl-StreamExt" class="impl"><code class="in-band">impl&lt;T:&nbsp;?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; StreamExt for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../futures_util/stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>,&nbsp;</span></code><a href="#impl-StreamExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/stream/stream/mod.rs.html#208" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/futures_util/stream/trait.StreamExt.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_util"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>