266 lines
No EOL
68 KiB
HTML
266 lines
No EOL
68 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 `FuturesOrdered` struct in crate `tokio`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, FuturesOrdered">
|
||
|
||
<title>tokio::prelude::stream::FuturesOrdered - 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="../../../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle">
|
||
<script src="../../../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc struct">
|
||
<!--[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>
|
||
|
||
<p class='location'>Struct FuturesOrdered</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.len">len</a><a href="#method.is_empty">is_empty</a><a href="#method.push">push</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-FromIterator%3CF%3E">FromIterator<F></a><a href="#impl-Debug">Debug</a><a href="#impl-Stream">Stream</a></div></div><p class='location'><a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>prelude</a>::<wbr><a href='index.html'>stream</a></p><script>window.sidebarCurrent = {name: 'FuturesOrdered', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../../../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../../../theme.js"></script>
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>prelude</a>::<wbr><a href='index.html'>stream</a>::<wbr><a class="struct" href=''>FuturesOrdered</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/stream/futures_ordered.rs.html#84-91' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'><div class="docblock attributes">#[must_use = "streams do nothing unless polled"]
|
||
</div>pub struct FuturesOrdered<T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>, </span> { /* fields omitted */ }</pre><div class='docblock'><p>An unbounded queue of futures.</p>
|
||
<p>This "combinator" is similar to <code>FuturesUnordered</code>, but it imposes an order
|
||
on top of the set of futures. While futures in the set will race to
|
||
completion in parallel, results will only be returned in the order their
|
||
originating futures were added to the queue.</p>
|
||
<p>Futures are pushed into this queue and their realized values are yielded in
|
||
order. This structure is optimized to manage a large number of futures.
|
||
Futures managed by <code>FuturesOrdered</code> will only be polled when they generate
|
||
notifications. This reduces the required amount of work needed to coordinate
|
||
large numbers of futures.</p>
|
||
<p>When a <code>FuturesOrdered</code> is first created, it does not contain any futures.
|
||
Calling <code>poll</code> in this state will result in <code>Ok(Async::Ready(None))</code> to be
|
||
returned. Futures are submitted to the queue using <code>push</code>; however, the
|
||
future will <strong>not</strong> be polled at this point. <code>FuturesOrdered</code> will only
|
||
poll managed futures when <code>FuturesOrdered::poll</code> is called. As such, it
|
||
is important to call <code>poll</code> after pushing new futures.</p>
|
||
<p>If <code>FuturesOrdered::poll</code> returns <code>Ok(Async::Ready(None))</code> this means that
|
||
the queue is currently not managing any futures. A future may be submitted
|
||
to the queue at a later time. At that point, a call to
|
||
<code>FuturesOrdered::poll</code> will either return the future's resolved value
|
||
<strong>or</strong> <code>Ok(Async::NotReady)</code> if the future has not yet completed. When
|
||
multiple futures are submitted to the queue, <code>FuturesOrdered::poll</code> will
|
||
return <code>Ok(Async::NotReady)</code> until the first future completes, even if
|
||
some of the later futures have already completed.</p>
|
||
<p>Note that you can create a ready-made <code>FuturesOrdered</code> via the
|
||
<code>futures_ordered</code> function in the <code>stream</code> module, or you can start with an
|
||
empty queue with the <code>FuturesOrdered::new</code> constructor.</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><code>impl<T> <a class="struct" href="../../../tokio/prelude/stream/struct.FuturesOrdered.html" title="struct tokio::prelude::stream::FuturesOrdered">FuturesOrdered</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>, </span></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#117-161' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../../../tokio/prelude/stream/struct.FuturesOrdered.html" title="struct tokio::prelude::stream::FuturesOrdered">FuturesOrdered</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#124-131' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Constructs a new, empty <code>FuturesOrdered</code></p>
|
||
<p>The returned <code>FuturesOrdered</code> does not contain any futures and, in this
|
||
state, <code>FuturesOrdered::poll</code> will return <code>Ok(Async::Ready(None))</code>.</p>
|
||
</div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>pub fn <a href='#method.len' class='fnname'>len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#138-140' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the number of futures contained in the queue.</p>
|
||
<p>This represents the total number of in-flight futures, both
|
||
those currently processing and those that have completed but
|
||
which are waiting for earlier futures to complete.</p>
|
||
</div><h4 id='method.is_empty' class="method"><span id='is_empty.v' class='invisible'><code>pub fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#143-145' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns <code>true</code> if the queue contains no futures</p>
|
||
</div><h4 id='method.push' class="method"><span id='push.v' class='invisible'><code>pub fn <a href='#method.push' class='fnname'>push</a>(&mut self, future: T)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#153-160' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Push a future into the queue.</p>
|
||
<p>This function submits the given future to the internal set for managing.
|
||
This function will not call <code>poll</code> on the submitted future. The caller
|
||
must ensure that <code>FuturesOrdered::poll</code> is called in order to receive
|
||
task notifications.</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-FromIterator%3CF%3E' class='impl'><span class='in-band'><code>impl<F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.FromIterator.html" title="trait core::iter::traits::FromIterator">FromIterator</a><F> for <a class="struct" href="../../../tokio/prelude/stream/struct.FuturesOrdered.html" title="struct tokio::prelude::stream::FuturesOrdered">FuturesOrdered</a><F> <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>, </span></code><a href='#impl-FromIterator%3CF%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#203-213' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.from_iter' class="method"><span id='from_iter.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.FromIterator.html#tymethod.from_iter' class='fnname'>from_iter</a><T>(iter: T) -> <a class="struct" href="../../../tokio/prelude/stream/struct.FuturesOrdered.html" title="struct tokio::prelude::stream::FuturesOrdered">FuturesOrdered</a><F> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a><Item = F>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#204-212' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a value from an iterator. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.FromIterator.html#tymethod.from_iter">Read more</a></p>
|
||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../tokio/prelude/stream/struct.FuturesOrdered.html" title="struct tokio::prelude::stream::FuturesOrdered">FuturesOrdered</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>, </span></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#195-201' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#198-200' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-Stream' class='impl'><span class='in-band'><code>impl<T> <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a> for <a class="struct" href="../../../tokio/prelude/stream/struct.FuturesOrdered.html" title="struct tokio::prelude::stream::FuturesOrdered">FuturesOrdered</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>, </span></code><a href='#impl-Stream' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#163-193' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item' class="type">Item</a> = <T as <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>>::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a></code></span></h4>
|
||
<div class='docblock'><p>The type of item this stream will yield on success.</p>
|
||
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error' class="type">Error</a> = <T as <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>>::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a></code></span></h4>
|
||
<div class='docblock'><p>The type of error this stream may generate.</p>
|
||
</div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#tymethod.poll' class='fnname'>poll</a>(<br> &mut self<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../../tokio/prelude/enum.Async.html" title="enum tokio::prelude::Async">Async</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<<a class="struct" href="../../../tokio/prelude/stream/struct.FuturesOrdered.html" title="struct tokio::prelude::stream::FuturesOrdered">FuturesOrdered</a><T> as <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>>::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>>>, <<a class="struct" href="../../../tokio/prelude/stream/struct.FuturesOrdered.html" title="struct tokio::prelude::stream::FuturesOrdered">FuturesOrdered</a><T> as <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>>::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/futures_ordered.rs.html#169-192' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Attempt to pull out the next value of this stream, returning <code>None</code> if the stream is finished. <a href="../../../tokio/prelude/stream/trait.Stream.html#tymethod.poll">Read more</a></p>
|
||
</div><h4 id='method.wait' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../../tokio/prelude/stream/struct.Wait.html" title="struct tokio::prelude::stream::Wait">Wait</a><S></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../../tokio/prelude/stream/struct.Wait.html" title="struct tokio::prelude::stream::Wait">Wait</a><S></h3><code class="content"><span class="where fmt-newline">impl<S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../../../tokio/prelude/stream/struct.Wait.html" title="struct tokio::prelude::stream::Wait">Wait</a><S> <span class="where fmt-newline">where<br> S: <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<S as <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>>::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>, <S as <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>>::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>;</span></code></div></div><span id='wait.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.wait' class='fnname'>wait</a>(self) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Wait.html" title="struct tokio::prelude::stream::Wait">Wait</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#244-248' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates an iterator which blocks the current thread until each item of this stream is resolved. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.wait">Read more</a></p>
|
||
</div><h4 id='method.into_future' class="method"><span id='into_future.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.into_future' class='fnname'>into_future</a>(self) -> <a class="struct" href="../../../tokio/prelude/stream/struct.StreamFuture.html" title="struct tokio::prelude::stream::StreamFuture">StreamFuture</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#291-295' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Converts this stream into a <code>Future</code>. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.into_future">Read more</a></p>
|
||
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.map' class='fnname'>map</a><U, F>(self, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Map.html" title="struct tokio::prelude::stream::Map">Map</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>) -> U, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#316-321' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Converts a stream of type <code>T</code> to a stream of type <code>U</code>. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.map">Read more</a></p>
|
||
</div><h4 id='method.map_err' class="method"><span id='map_err.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.map_err' class='fnname'>map_err</a><U, F>(self, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.MapErr.html" title="struct tokio::prelude::stream::MapErr">MapErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>) -> U, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#342-347' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Converts a stream of error type <code>T</code> to a stream of error type <code>U</code>. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.map_err">Read more</a></p>
|
||
</div><h4 id='method.filter' class="method"><span id='filter.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.filter' class='fnname'>filter</a><F>(self, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Filter.html" title="struct tokio::prelude::stream::Filter">Filter</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#372-377' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Filters the values produced by this stream according to the provided predicate. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.filter">Read more</a></p>
|
||
</div><h4 id='method.filter_map' class="method"><span id='filter_map.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.filter_map' class='fnname'>filter_map</a><F, B>(self, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.FilterMap.html" title="struct tokio::prelude::stream::FilterMap">FilterMap</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><B>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#408-413' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Filters the values produced by this stream while simultaneously mapping them to a different type. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.filter_map">Read more</a></p>
|
||
</div><h4 id='method.then' class="method"><span id='then.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.then' class='fnname'>then</a><F, U>(self, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Then.html" title="struct tokio::prelude::stream::Then">Then</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>, Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>) -> U,<br> U: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#447-453' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Chain on a computation for when a value is ready, passing the resulting item to the provided closure <code>f</code>. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.then">Read more</a></p>
|
||
</div><h4 id='method.and_then' class="method"><span id='and_then.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.and_then' class='fnname'>and_then</a><F, U>(self, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.AndThen.html" title="struct tokio::prelude::stream::AndThen">AndThen</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>) -> U,<br> U: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#494-500' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Chain on a computation for when a value is ready, passing the successful results to the provided closure <code>f</code>. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.and_then">Read more</a></p>
|
||
</div><h4 id='method.or_else' class="method"><span id='or_else.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.or_else' class='fnname'>or_else</a><F, U>(self, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.OrElse.html" title="struct tokio::prelude::stream::OrElse">OrElse</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>) -> U,<br> U: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a><Item = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#521-527' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Chain on a computation for when an error happens, passing the erroneous result to the provided closure <code>f</code>. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.or_else">Read more</a></p>
|
||
</div><h4 id='method.collect' class="method"><span id='collect.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.collect' class='fnname'>collect</a>(self) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Collect.html" title="struct tokio::prelude::stream::Collect">Collect</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#562-566' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Collect all of the values of this stream into a vector, returning a future representing the result of that computation. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.collect">Read more</a></p>
|
||
</div><h4 id='method.concat2' class="method"><span id='concat2.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.concat2' class='fnname'>concat2</a>(self) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Concat2.html" title="struct tokio::prelude::stream::Concat2">Concat2</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html" title="trait core::iter::traits::Extend">Extend</a><<Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::IntoIterator::Item">Item</a>>,<br> Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>,<br> Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#598-603' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.concat2">Read more</a></p>
|
||
</div><h4 id='method.concat' class="method"><span id='concat.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.concat' class='fnname'>concat</a>(self) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Concat.html" title="struct tokio::prelude::stream::Concat">Concat</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html" title="trait core::iter::traits::Extend">Extend</a><<Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::IntoIterator::Item">Item</a>>,<br> Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#638-643' title='goto source code'>[src]</a></span></h4>
|
||
<div class='stability'><div class='stab deprecated'>Deprecated since 0.1.14<p>: please use <code>Stream::concat2</code> instead</p>
|
||
</div></div><div class='docblock'><p>Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.concat">Read more</a></p>
|
||
</div><h4 id='method.fold' class="method"><span id='fold.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.fold' class='fnname'>fold</a><F, T, Fut>(self, init: T, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Fold.html" title="struct tokio::prelude::stream::Fold">Fold</a><Self, F, Fut, T> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(T, Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>) -> Fut,<br> Fut: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a><Item = T>,<br> Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<Fut as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>>::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Error" title="type tokio::prelude::IntoFuture::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#668-675' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Execute an accumulating computation over a stream, collecting all the values into one final result. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.fold">Read more</a></p>
|
||
</div><h4 id='method.flatten' class="method"><span id='flatten.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.flatten' class='fnname'>flatten</a>(self) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Flatten.html" title="struct tokio::prelude::stream::Flatten">Flatten</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>: <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>,<br> <Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a> as <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>>::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#710-716' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Flattens a stream of streams into just one continuous stream. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.flatten">Read more</a></p>
|
||
</div><h4 id='method.skip_while' class="method"><span id='skip_while.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.skip_while' class='fnname'>skip_while</a><P, R>(self, pred: P) -> <a class="struct" href="../../../tokio/prelude/stream/struct.SkipWhile.html" title="struct tokio::prelude::stream::SkipWhile">SkipWhile</a><Self, P, R> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>) -> R,<br> R: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Error = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#725-731' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Skip elements on this stream while the predicate provided resolves to <code>true</code>. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.skip_while">Read more</a></p>
|
||
</div><h4 id='method.take_while' class="method"><span id='take_while.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.take_while' class='fnname'>take_while</a><P, R>(self, pred: P) -> <a class="struct" href="../../../tokio/prelude/stream/struct.TakeWhile.html" title="struct tokio::prelude::stream::TakeWhile">TakeWhile</a><Self, P, R> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>) -> R,<br> R: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Error = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#739-745' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Take elements from this stream while the predicate provided resolves to <code>true</code>. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.take_while">Read more</a></p>
|
||
</div><h4 id='method.for_each' class="method"><span id='for_each.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.for_each' class='fnname'>for_each</a><F, U>(self, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.ForEach.html" title="struct tokio::prelude::stream::ForEach">ForEach</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>) -> U,<br> U: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#761-767' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Runs this stream to completion, executing the provided closure for each element on the stream. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.for_each">Read more</a></p>
|
||
</div><h4 id='method.from_err' class="method"><span id='from_err.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.from_err' class='fnname'>from_err</a><E>(self) -> <a class="struct" href="../../../tokio/prelude/stream/struct.FromErr.html" title="struct tokio::prelude::stream::FromErr">FromErr</a><Self, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#780-784' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Map this stream's error to any error implementing <code>From</code> for this stream's <code>Error</code>, returning a new stream. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.from_err">Read more</a></p>
|
||
</div><h4 id='method.take' class="method"><span id='take.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.take' class='fnname'>take</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Take.html" title="struct tokio::prelude::stream::Take">Take</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#796-800' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new stream of at most <code>amt</code> items of the underlying stream. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.take">Read more</a></p>
|
||
</div><h4 id='method.skip' class="method"><span id='skip.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.skip' class='fnname'>skip</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Skip.html" title="struct tokio::prelude::stream::Skip">Skip</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#811-815' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new stream which skips <code>amt</code> items of the underlying stream. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.skip">Read more</a></p>
|
||
</div><h4 id='method.fuse' class="method"><span id='fuse.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.fuse' class='fnname'>fuse</a>(self) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Fuse.html" title="struct tokio::prelude::stream::Fuse">Fuse</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#832-836' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Fuse a stream such that <code>poll</code> will never again be called once it has finished. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.fuse">Read more</a></p>
|
||
</div><h4 id='method.by_ref' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="../../../tokio/prelude/trait.Read.html" title="trait tokio::prelude::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="../../../tokio/prelude/trait.Read.html" title="trait tokio::prelude::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="../../../tokio/prelude/trait.Write.html" title="trait tokio::prelude::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="../../../tokio/prelude/trait.Write.html" title="trait tokio::prelude::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='by_ref.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.by_ref' class='fnname'>by_ref</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#857-861' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Borrows a stream, rather than consuming it. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.by_ref">Read more</a></p>
|
||
</div><h4 id='method.catch_unwind' class="method"><span id='catch_unwind.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.catch_unwind' class='fnname'>catch_unwind</a>(self) -> <a class="struct" href="../../../tokio/prelude/stream/struct.CatchUnwind.html" title="struct tokio::prelude::stream::CatchUnwind">CatchUnwind</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#897-901' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Catches unwinding panics while polling the stream. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.catch_unwind">Read more</a></p>
|
||
</div><h4 id='method.buffered' class="method"><span id='buffered.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.buffered' class='fnname'>buffered</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Buffered.html" title="struct tokio::prelude::stream::Buffered">Buffered</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>,<br> <Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a> as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>>::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Error" title="type tokio::prelude::IntoFuture::Error">Error</a> == Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#917-922' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>An adaptor for creating a buffered list of pending futures. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.buffered">Read more</a></p>
|
||
</div><h4 id='method.buffer_unordered' class="method"><span id='buffer_unordered.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.buffer_unordered' class='fnname'>buffer_unordered</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../../tokio/prelude/stream/struct.BufferUnordered.html" title="struct tokio::prelude::stream::BufferUnordered">BufferUnordered</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>,<br> <Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a> as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>>::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Error" title="type tokio::prelude::IntoFuture::Error">Error</a> == Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#938-943' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>An adaptor for creating a buffered list of pending futures (unordered). <a href="../../../tokio/prelude/stream/trait.Stream.html#method.buffer_unordered">Read more</a></p>
|
||
</div><h4 id='method.merge' class="method"><span id='merge.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.merge' class='fnname'>merge</a><S>(self, other: S) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Merge.html" title="struct tokio::prelude::stream::Merge">Merge</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a><Error = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#952-957' title='goto source code'>[src]</a></span></h4>
|
||
<div class='stability'><div class='stab deprecated'>Deprecated<p>: functionality provided by <code>select</code> now</p>
|
||
</div></div><div class='docblock'><p>An adapter for merging the output of two streams. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.merge">Read more</a></p>
|
||
</div><h4 id='method.zip' class="method"><span id='zip.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.zip' class='fnname'>zip</a><S>(self, other: S) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Zip.html" title="struct tokio::prelude::stream::Zip">Zip</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a><Error = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#964-969' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>An adapter for zipping two streams together. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.zip">Read more</a></p>
|
||
</div><h4 id='method.chain' class="method"><span id='chain.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.chain' class='fnname'>chain</a><S>(self, other: S) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Chain.html" title="struct tokio::prelude::stream::Chain">Chain</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a><Item = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>, Error = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#990-995' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Adapter for chaining two stream. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.chain">Read more</a></p>
|
||
</div><h4 id='method.peekable' class="method"><span id='peekable.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.peekable' class='fnname'>peekable</a>(self) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Peekable.html" title="struct tokio::prelude::stream::Peekable">Peekable</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#1000-1004' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new stream which exposes a <code>peek</code> method. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.peekable">Read more</a></p>
|
||
</div><h4 id='method.chunks' class="method"><span id='chunks.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.chunks' class='fnname'>chunks</a>(self, capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Chunks.html" title="struct tokio::prelude::stream::Chunks">Chunks</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#1027-1031' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>An adaptor for chunking up items of the stream inside a vector. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.chunks">Read more</a></p>
|
||
</div><h4 id='method.select' class="method"><span id='select.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.select' class='fnname'>select</a><S>(self, other: S) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Select.html" title="struct tokio::prelude::stream::Select">Select</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a><Item = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>, Error = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#1044-1049' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.select">Read more</a></p>
|
||
</div><h4 id='method.forward' class="method"><span id='forward.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.forward' class='fnname'>forward</a><S>(self, sink: S) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Forward.html" title="struct tokio::prelude::stream::Forward">Forward</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a><SinkItem = Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>>,<br> Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<S as <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>>::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#1065-1071' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>A future that completes after the given stream has been fully processed into the sink, including flushing. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.forward">Read more</a></p>
|
||
</div><h4 id='method.split' class="method"><span id='split.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.split' class='fnname'>split</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../../tokio/prelude/stream/struct.SplitSink.html" title="struct tokio::prelude::stream::SplitSink">SplitSink</a><Self>, <a class="struct" href="../../../tokio/prelude/stream/struct.SplitStream.html" title="struct tokio::prelude::stream::SplitStream">SplitStream</a><Self><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#1083-1087' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Splits this <code>Stream + Sink</code> object into separate <code>Stream</code> and <code>Sink</code> objects. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.split">Read more</a></p>
|
||
</div><h4 id='method.inspect' class="method"><span id='inspect.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.inspect' class='fnname'>inspect</a><F>(self, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.Inspect.html" title="struct tokio::prelude::stream::Inspect">Inspect</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Item" title="type tokio::prelude::stream::Stream::Item">Item</a>), </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#1094-1099' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Do something with each item of this stream, afterwards passing it on. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.inspect">Read more</a></p>
|
||
</div><h4 id='method.inspect_err' class="method"><span id='inspect_err.v' class='invisible'><code>fn <a href='../../../tokio/prelude/stream/trait.Stream.html#method.inspect_err' class='fnname'>inspect_err</a><F>(self, f: F) -> <a class="struct" href="../../../tokio/prelude/stream/struct.InspectErr.html" title="struct tokio::prelude::stream::InspectErr">InspectErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>), </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/mod.rs.html#1106-1111' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Do something with the error of this stream, afterwards passing it on. <a href="../../../tokio/prelude/stream/trait.Stream.html#method.inspect_err">Read more</a></p>
|
||
</div></div></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt><kbd>?</kbd></dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt><kbd>S</kbd></dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt><kbd>↑</kbd></dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt><kbd>↓</kbd></dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt><kbd>↹</kbd></dt>
|
||
<dd>Switch tab</dd>
|
||
<dt><kbd>⏎</kbd></dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt><kbd>+</kbd></dt>
|
||
<dd>Expand all sections</dd>
|
||
<dt><kbd>-</kbd></dt>
|
||
<dd>Collapse all sections</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../../";
|
||
window.currentCrate = "tokio";
|
||
</script>
|
||
<script src="../../../main.js"></script>
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |