OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-28 12:51:55 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/futures_util/stream/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

38 lines
41 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Asynchronous streams."><title>futures_util::stream - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="futures_util" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures_util/index.html">futures_util</a><span class="version">0.3.28</span></h2></div><h2 class="location"><a href="#">Module stream</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crate futures_util</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../futures_util/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">futures_util</a>::<wbr><a class="mod" href="#">stream</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/futures_util/stream/mod.rs.html#1-148">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Asynchronous streams.</p>
<p>This module contains:</p>
<ul>
<li>The <a href="trait.Stream.html" title="trait futures_util::stream::Stream"><code>Stream</code></a> trait, for objects that can asynchronously produce a
sequence of values.</li>
<li>The <a href="trait.StreamExt.html" title="trait futures_util::stream::StreamExt"><code>StreamExt</code></a> and <a href="trait.TryStreamExt.html" title="trait futures_util::stream::TryStreamExt"><code>TryStreamExt</code></a> trait, which provides adapters for
chaining and composing streams.</li>
<li>Top-level stream constructors like <a href="fn.iter.html" title="fn futures_util::stream::iter"><code>iter</code></a> which creates a
stream from an iterator.</li>
</ul>
</div></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="futures_unordered/index.html" title="mod futures_util::stream::futures_unordered">futures_unordered</a></div><div class="desc docblock-short">An unbounded set of futures.</div></li><li><div class="item-name"><a class="mod" href="select_all/index.html" title="mod futures_util::stream::select_all">select_all</a></div><div class="desc docblock-short">An unbounded set of streams</div></li></ul><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AbortHandle.html" title="struct futures_util::stream::AbortHandle">AbortHandle</a></div><div class="desc docblock-short">A handle to an <code>Abortable</code> task.</div></li><li><div class="item-name"><a class="struct" href="struct.AbortRegistration.html" title="struct futures_util::stream::AbortRegistration">AbortRegistration</a></div><div class="desc docblock-short">A registration handle for an <code>Abortable</code> task.
Values of this type can be acquired from <code>AbortHandle::new</code> and are used
in calls to <code>Abortable::new</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Abortable.html" title="struct futures_util::stream::Abortable">Abortable</a></div><div class="desc docblock-short">A future/stream which can be remotely short-circuited using an <code>AbortHandle</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Aborted.html" title="struct futures_util::stream::Aborted">Aborted</a></div><div class="desc docblock-short">Indicator that the <code>Abortable</code> task was aborted.</div></li><li><div class="item-name"><a class="struct" href="struct.All.html" title="struct futures_util::stream::All">All</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.all" title="method futures_util::stream::StreamExt::all"><code>all</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.AndThen.html" title="struct futures_util::stream::AndThen">AndThen</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.and_then" title="method futures_util::stream::TryStreamExt::and_then"><code>and_then</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Any.html" title="struct futures_util::stream::Any">Any</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.any" title="method futures_util::stream::StreamExt::any"><code>any</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.BufferUnordered.html" title="struct futures_util::stream::BufferUnordered">BufferUnordered</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.buffer_unordered" title="method futures_util::stream::StreamExt::buffer_unordered"><code>buffer_unordered</code></a>
method.</div></li><li><div class="item-name"><a class="struct" href="struct.Buffered.html" title="struct futures_util::stream::Buffered">Buffered</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.buffered" title="method futures_util::stream::StreamExt::buffered"><code>buffered</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.CatchUnwind.html" title="struct futures_util::stream::CatchUnwind">CatchUnwind</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.catch_unwind" title="method futures_util::stream::StreamExt::catch_unwind"><code>catch_unwind</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Chain.html" title="struct futures_util::stream::Chain">Chain</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.chain" title="method futures_util::stream::StreamExt::chain"><code>chain</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Chunks.html" title="struct futures_util::stream::Chunks">Chunks</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.chunks" title="method futures_util::stream::StreamExt::chunks"><code>chunks</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Collect.html" title="struct futures_util::stream::Collect">Collect</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.collect" title="method futures_util::stream::StreamExt::collect"><code>collect</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Concat.html" title="struct futures_util::stream::Concat">Concat</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.concat" title="method futures_util::stream::StreamExt::concat"><code>concat</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Count.html" title="struct futures_util::stream::Count">Count</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.count" title="method futures_util::stream::StreamExt::count"><code>count</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Cycle.html" title="struct futures_util::stream::Cycle">Cycle</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.cycle" title="method futures_util::stream::StreamExt::cycle"><code>cycle</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Empty.html" title="struct futures_util::stream::Empty">Empty</a></div><div class="desc docblock-short">Stream for the <a href="fn.empty.html" title="fn futures_util::stream::empty"><code>empty</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Enumerate.html" title="struct futures_util::stream::Enumerate">Enumerate</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.enumerate" title="method futures_util::stream::StreamExt::enumerate"><code>enumerate</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.ErrInto.html" title="struct futures_util::stream::ErrInto">ErrInto</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.err_into" title="method futures_util::stream::TryStreamExt::err_into"><code>err_into</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Filter.html" title="struct futures_util::stream::Filter">Filter</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.filter" title="method futures_util::stream::StreamExt::filter"><code>filter</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.FilterMap.html" title="struct futures_util::stream::FilterMap">FilterMap</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.filter_map" title="method futures_util::stream::StreamExt::filter_map"><code>filter_map</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.FlatMap.html" title="struct futures_util::stream::FlatMap">FlatMap</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.flat_map" title="method futures_util::stream::StreamExt::flat_map"><code>flat_map</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.FlatMapUnordered.html" title="struct futures_util::stream::FlatMapUnordered">FlatMapUnordered</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.flat_map_unordered" title="method futures_util::stream::StreamExt::flat_map_unordered"><code>flat_map_unordered</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Flatten.html" title="struct futures_util::stream::Flatten">Flatten</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.flatten" title="method futures_util::stream::StreamExt::flatten"><code>flatten</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Fold.html" title="struct futures_util::stream::Fold">Fold</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.fold" title="method futures_util::stream::StreamExt::fold"><code>fold</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.ForEach.html" title="struct futures_util::stream::ForEach">ForEach</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.for_each" title="method futures_util::stream::StreamExt::for_each"><code>for_each</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.ForEachConcurrent.html" title="struct futures_util::stream::ForEachConcurrent">ForEachConcurrent</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.for_each_concurrent" title="method futures_util::stream::StreamExt::for_each_concurrent"><code>for_each_concurrent</code></a>
method.</div></li><li><div class="item-name"><a class="struct" href="struct.Forward.html" title="struct futures_util::stream::Forward">Forward</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.forward" title="method futures_util::stream::StreamExt::forward"><code>forward</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Fuse.html" title="struct futures_util::stream::Fuse">Fuse</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.fuse" title="method futures_util::stream::StreamExt::fuse"><code>fuse</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.FuturesOrdered.html" title="struct futures_util::stream::FuturesOrdered">FuturesOrdered</a></div><div class="desc docblock-short">An unbounded queue of futures.</div></li><li><div class="item-name"><a class="struct" href="struct.FuturesUnordered.html" title="struct futures_util::stream::FuturesUnordered">FuturesUnordered</a></div><div class="desc docblock-short">A set of futures which may complete in any order.</div></li><li><div class="item-name"><a class="struct" href="struct.Inspect.html" title="struct futures_util::stream::Inspect">Inspect</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.inspect" title="method futures_util::stream::StreamExt::inspect"><code>inspect</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.InspectErr.html" title="struct futures_util::stream::InspectErr">InspectErr</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.inspect_err" title="method futures_util::stream::TryStreamExt::inspect_err"><code>inspect_err</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.InspectOk.html" title="struct futures_util::stream::InspectOk">InspectOk</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.inspect_ok" title="method futures_util::stream::TryStreamExt::inspect_ok"><code>inspect_ok</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoAsyncRead.html" title="struct futures_util::stream::IntoAsyncRead">IntoAsyncRead</a></div><div class="desc docblock-short">Reader for the <a href="trait.TryStreamExt.html#method.into_async_read" title="method futures_util::stream::TryStreamExt::into_async_read"><code>into_async_read</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoStream.html" title="struct futures_util::stream::IntoStream">IntoStream</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.into_stream" title="method futures_util::stream::TryStreamExt::into_stream"><code>into_stream</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Iter.html" title="struct futures_util::stream::Iter">Iter</a></div><div class="desc docblock-short">Stream for the <a href="fn.iter.html" title="fn futures_util::stream::iter"><code>iter</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Map.html" title="struct futures_util::stream::Map">Map</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.map" title="method futures_util::stream::StreamExt::map"><code>map</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.MapErr.html" title="struct futures_util::stream::MapErr">MapErr</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.map_err" title="method futures_util::stream::TryStreamExt::map_err"><code>map_err</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.MapOk.html" title="struct futures_util::stream::MapOk">MapOk</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.map_ok" title="method futures_util::stream::TryStreamExt::map_ok"><code>map_ok</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Next.html" title="struct futures_util::stream::Next">Next</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.next" title="method futures_util::stream::StreamExt::next"><code>next</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.NextIf.html" title="struct futures_util::stream::NextIf">NextIf</a></div><div class="desc docblock-short">Future for the <a href="struct.Peekable.html#method.next_if" title="method futures_util::stream::Peekable::next_if"><code>Peekable::next_if</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.NextIfEq.html" title="struct futures_util::stream::NextIfEq">NextIfEq</a></div><div class="desc docblock-short">Future for the <a href="struct.Peekable.html#method.next_if_eq" title="method futures_util::stream::Peekable::next_if_eq"><code>Peekable::next_if_eq</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Once.html" title="struct futures_util::stream::Once">Once</a></div><div class="desc docblock-short">A stream which emits single element and then EOF.</div></li><li><div class="item-name"><a class="struct" href="struct.OrElse.html" title="struct futures_util::stream::OrElse">OrElse</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.or_else" title="method futures_util::stream::TryStreamExt::or_else"><code>or_else</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Peek.html" title="struct futures_util::stream::Peek">Peek</a></div><div class="desc docblock-short">Future for the <a href="struct.Peekable.html#method.peek" title="method futures_util::stream::Peekable::peek"><code>Peekable::peek</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.PeekMut.html" title="struct futures_util::stream::PeekMut">PeekMut</a></div><div class="desc docblock-short">Future for the <a href="struct.Peekable.html#method.peek_mut" title="method futures_util::stream::Peekable::peek_mut"><code>Peekable::peek_mut</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Peekable.html" title="struct futures_util::stream::Peekable">Peekable</a></div><div class="desc docblock-short">A <code>Stream</code> that implements a <code>peek</code> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Pending.html" title="struct futures_util::stream::Pending">Pending</a></div><div class="desc docblock-short">Stream for the <a href="fn.pending.html" title="fn futures_util::stream::pending"><code>pending()</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.PollFn.html" title="struct futures_util::stream::PollFn">PollFn</a></div><div class="desc docblock-short">Stream for the <a href="fn.poll_fn.html" title="fn futures_util::stream::poll_fn"><code>poll_fn</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.PollImmediate.html" title="struct futures_util::stream::PollImmediate">PollImmediate</a></div><div class="desc docblock-short">Stream for the <a href="fn.poll_immediate.html" title="fn futures_util::stream::poll_immediate">poll_immediate</a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.ReadyChunks.html" title="struct futures_util::stream::ReadyChunks">ReadyChunks</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.ready_chunks" title="method futures_util::stream::StreamExt::ready_chunks"><code>ready_chunks</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Repeat.html" title="struct futures_util::stream::Repeat">Repeat</a></div><div class="desc docblock-short">Stream for the <a href="fn.repeat.html" title="fn futures_util::stream::repeat"><code>repeat</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.RepeatWith.html" title="struct futures_util::stream::RepeatWith">RepeatWith</a></div><div class="desc docblock-short">An stream that repeats elements of type <code>A</code> endlessly by
applying the provided closure <code>F: FnMut() -&gt; A</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ReuniteError.html" title="struct futures_util::stream::ReuniteError">ReuniteError</a></div><div class="desc docblock-short">Error indicating a <code>SplitSink&lt;S&gt;</code> and <code>SplitStream&lt;S&gt;</code> were not two halves
of a <code>Stream + Split</code>, and thus could not be <code>reunite</code>d.</div></li><li><div class="item-name"><a class="struct" href="struct.Scan.html" title="struct futures_util::stream::Scan">Scan</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.scan" title="method futures_util::stream::StreamExt::scan"><code>scan</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Select.html" title="struct futures_util::stream::Select">Select</a></div><div class="desc docblock-short">Stream for the <a href="fn.select.html" title="fn futures_util::stream::select"><code>select()</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.SelectAll.html" title="struct futures_util::stream::SelectAll">SelectAll</a></div><div class="desc docblock-short">An unbounded set of streams</div></li><li><div class="item-name"><a class="struct" href="struct.SelectNextSome.html" title="struct futures_util::stream::SelectNextSome">SelectNextSome</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.select_next_some" title="method futures_util::stream::StreamExt::select_next_some"><code>select_next_some</code></a>
method.</div></li><li><div class="item-name"><a class="struct" href="struct.SelectWithStrategy.html" title="struct futures_util::stream::SelectWithStrategy">SelectWithStrategy</a></div><div class="desc docblock-short">Stream for the <a href="fn.select_with_strategy.html" title="fn futures_util::stream::select_with_strategy"><code>select_with_strategy()</code></a> function. See function docs for details.</div></li><li><div class="item-name"><a class="struct" href="struct.Skip.html" title="struct futures_util::stream::Skip">Skip</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.skip" title="method futures_util::stream::StreamExt::skip"><code>skip</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.SkipWhile.html" title="struct futures_util::stream::SkipWhile">SkipWhile</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.skip_while" title="method futures_util::stream::StreamExt::skip_while"><code>skip_while</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.SplitSink.html" title="struct futures_util::stream::SplitSink">SplitSink</a></div><div class="desc docblock-short">A <code>Sink</code> part of the split pair</div></li><li><div class="item-name"><a class="struct" href="struct.SplitStream.html" title="struct futures_util::stream::SplitStream">SplitStream</a></div><div class="desc docblock-short">A <code>Stream</code> part of the split pair</div></li><li><div class="item-name"><a class="struct" href="struct.StreamFuture.html" title="struct futures_util::stream::StreamFuture">StreamFuture</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.into_future" title="method futures_util::stream::StreamExt::into_future"><code>into_future</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Take.html" title="struct futures_util::stream::Take">Take</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.take" title="method futures_util::stream::StreamExt::take"><code>take</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.take_until" title="method futures_util::stream::StreamExt::take_until"><code>take_until</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TakeWhile.html" title="struct futures_util::stream::TakeWhile">TakeWhile</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.take_while" title="method futures_util::stream::StreamExt::take_while"><code>take_while</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Then.html" title="struct futures_util::stream::Then">Then</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.then" title="method futures_util::stream::StreamExt::then"><code>then</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryBufferUnordered.html" title="struct futures_util::stream::TryBufferUnordered">TryBufferUnordered</a></div><div class="desc docblock-short">Stream for the
<a href="trait.TryStreamExt.html#method.try_buffer_unordered" title="method futures_util::stream::TryStreamExt::try_buffer_unordered"><code>try_buffer_unordered</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryBuffered.html" title="struct futures_util::stream::TryBuffered">TryBuffered</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.try_buffered" title="method futures_util::stream::TryStreamExt::try_buffered"><code>try_buffered</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryChunks.html" title="struct futures_util::stream::TryChunks">TryChunks</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.try_chunks" title="method futures_util::stream::TryStreamExt::try_chunks"><code>try_chunks</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryChunksError.html" title="struct futures_util::stream::TryChunksError">TryChunksError</a></div><div class="desc docblock-short">Error indicating, that while chunk was collected inner stream produced an error.</div></li><li><div class="item-name"><a class="struct" href="struct.TryCollect.html" title="struct futures_util::stream::TryCollect">TryCollect</a></div><div class="desc docblock-short">Future for the <a href="trait.TryStreamExt.html#method.try_collect" title="method futures_util::stream::TryStreamExt::try_collect"><code>try_collect</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryConcat.html" title="struct futures_util::stream::TryConcat">TryConcat</a></div><div class="desc docblock-short">Future for the <a href="trait.TryStreamExt.html#method.try_concat" title="method futures_util::stream::TryStreamExt::try_concat"><code>try_concat</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryFilter.html" title="struct futures_util::stream::TryFilter">TryFilter</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.try_filter" title="method futures_util::stream::TryStreamExt::try_filter"><code>try_filter</code></a>
method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryFilterMap.html" title="struct futures_util::stream::TryFilterMap">TryFilterMap</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.try_filter_map" title="method futures_util::stream::TryStreamExt::try_filter_map"><code>try_filter_map</code></a>
method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryFlatten.html" title="struct futures_util::stream::TryFlatten">TryFlatten</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.try_flatten" title="method futures_util::stream::TryStreamExt::try_flatten"><code>try_flatten</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryFlattenUnordered.html" title="struct futures_util::stream::TryFlattenUnordered">TryFlattenUnordered</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.try_flatten_unordered" title="method futures_util::stream::TryStreamExt::try_flatten_unordered"><code>try_flatten_unordered</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryFold.html" title="struct futures_util::stream::TryFold">TryFold</a></div><div class="desc docblock-short">Future for the <a href="trait.TryStreamExt.html#method.try_fold" title="method futures_util::stream::TryStreamExt::try_fold"><code>try_fold</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryForEach.html" title="struct futures_util::stream::TryForEach">TryForEach</a></div><div class="desc docblock-short">Future for the <a href="trait.TryStreamExt.html#method.try_for_each" title="method futures_util::stream::TryStreamExt::try_for_each"><code>try_for_each</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryForEachConcurrent.html" title="struct futures_util::stream::TryForEachConcurrent">TryForEachConcurrent</a></div><div class="desc docblock-short">Future for the
<a href="trait.TryStreamExt.html#method.try_for_each_concurrent" title="method futures_util::stream::TryStreamExt::try_for_each_concurrent"><code>try_for_each_concurrent</code></a>
method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryNext.html" title="struct futures_util::stream::TryNext">TryNext</a></div><div class="desc docblock-short">Future for the <a href="trait.TryStreamExt.html#method.try_next" title="method futures_util::stream::TryStreamExt::try_next"><code>try_next</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.TrySkipWhile.html" title="struct futures_util::stream::TrySkipWhile">TrySkipWhile</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.try_skip_while" title="method futures_util::stream::TryStreamExt::try_skip_while"><code>try_skip_while</code></a>
method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryTakeWhile.html" title="struct futures_util::stream::TryTakeWhile">TryTakeWhile</a></div><div class="desc docblock-short">Stream for the <a href="trait.TryStreamExt.html#method.try_take_while" title="method futures_util::stream::TryStreamExt::try_take_while"><code>try_take_while</code></a>
method.</div></li><li><div class="item-name"><a class="struct" href="struct.TryUnfold.html" title="struct futures_util::stream::TryUnfold">TryUnfold</a></div><div class="desc docblock-short">Stream for the <a href="fn.try_unfold.html" title="fn futures_util::stream::try_unfold"><code>try_unfold</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Unfold.html" title="struct futures_util::stream::Unfold">Unfold</a></div><div class="desc docblock-short">Stream for the <a href="fn.unfold.html" title="fn futures_util::stream::unfold"><code>unfold</code></a> function.</div></li><li><div class="item-name"><a class="struct" href="struct.Unzip.html" title="struct futures_util::stream::Unzip">Unzip</a></div><div class="desc docblock-short">Future for the <a href="trait.StreamExt.html#method.unzip" title="method futures_util::stream::StreamExt::unzip"><code>unzip</code></a> method.</div></li><li><div class="item-name"><a class="struct" href="struct.Zip.html" title="struct futures_util::stream::Zip">Zip</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.zip" title="method futures_util::stream::StreamExt::zip"><code>zip</code></a> method.</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.PollNext.html" title="enum futures_util::stream::PollNext">PollNext</a></div><div class="desc docblock-short">Type to tell <a href="struct.SelectWithStrategy.html" title="struct futures_util::stream::SelectWithStrategy"><code>SelectWithStrategy</code></a> which stream to poll next.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.FusedStream.html" title="trait futures_util::stream::FusedStream">FusedStream</a></div><div class="desc docblock-short">A stream which tracks whether or not the underlying stream
should no longer be polled.</div></li><li><div class="item-name"><a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a></div><div class="desc docblock-short">A stream of values produced asynchronously.</div></li><li><div class="item-name"><a class="trait" href="trait.StreamExt.html" title="trait futures_util::stream::StreamExt">StreamExt</a></div><div class="desc docblock-short">An extension trait for <code>Stream</code>s that provides a variety of convenient
combinator functions.</div></li><li><div class="item-name"><a class="trait" href="trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a></div><div class="desc docblock-short">A convenience for streams that return <code>Result</code> values that includes
a variety of adapters tailored to such futures.</div></li><li><div class="item-name"><a class="trait" href="trait.TryStreamExt.html" title="trait futures_util::stream::TryStreamExt">TryStreamExt</a></div><div class="desc docblock-short">Adapters specific to <code>Result</code>-returning streams</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.abortable.html" title="fn futures_util::stream::abortable">abortable</a></div><div class="desc docblock-short">Creates a new <code>Abortable</code> stream and an <code>AbortHandle</code> which can be used to stop it.</div></li><li><div class="item-name"><a class="fn" href="fn.empty.html" title="fn futures_util::stream::empty">empty</a></div><div class="desc docblock-short">Creates a stream which contains no elements.</div></li><li><div class="item-name"><a class="fn" href="fn.iter.html" title="fn futures_util::stream::iter">iter</a></div><div class="desc docblock-short">Converts an <code>Iterator</code> into a <code>Stream</code> which is always ready
to yield the next value.</div></li><li><div class="item-name"><a class="fn" href="fn.once.html" title="fn futures_util::stream::once">once</a></div><div class="desc docblock-short">Creates a stream of a single element.</div></li><li><div class="item-name"><a class="fn" href="fn.pending.html" title="fn futures_util::stream::pending">pending</a></div><div class="desc docblock-short">Creates a stream which never returns any elements.</div></li><li><div class="item-name"><a class="fn" href="fn.poll_fn.html" title="fn futures_util::stream::poll_fn">poll_fn</a></div><div class="desc docblock-short">Creates a new stream wrapping a function returning <code>Poll&lt;Option&lt;T&gt;&gt;</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.poll_immediate.html" title="fn futures_util::stream::poll_immediate">poll_immediate</a></div><div class="desc docblock-short">Creates a new stream that always immediately returns <a href="https://doc.rust-lang.org/1.76.0/core/task/poll/enum.Poll.html#variant.Ready" title="variant core::task::poll::Poll::Ready">Poll::Ready</a> when awaiting it.</div></li><li><div class="item-name"><a class="fn" href="fn.repeat.html" title="fn futures_util::stream::repeat">repeat</a></div><div class="desc docblock-short">Create a stream which produces the same item repeatedly.</div></li><li><div class="item-name"><a class="fn" href="fn.repeat_with.html" title="fn futures_util::stream::repeat_with">repeat_with</a></div><div class="desc docblock-short">Creates a new stream that repeats elements of type <code>A</code> endlessly by
applying the provided closure, the repeater, <code>F: FnMut() -&gt; A</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.select.html" title="fn futures_util::stream::select">select</a></div><div class="desc docblock-short">This function will attempt to pull items from both streams. Each
stream will be polled in a round-robin fashion, and whenever a stream is
ready to yield an item that item is yielded.</div></li><li><div class="item-name"><a class="fn" href="fn.select_all.html" title="fn futures_util::stream::select_all">select_all</a></div><div class="desc docblock-short">Convert a list of streams into a <code>Stream</code> of results from the streams.</div></li><li><div class="item-name"><a class="fn" href="fn.select_with_strategy.html" title="fn futures_util::stream::select_with_strategy">select_with_strategy</a></div><div class="desc docblock-short">This function will attempt to pull items from both streams. You provide a
closure to tell <a href="struct.SelectWithStrategy.html" title="struct futures_util::stream::SelectWithStrategy"><code>SelectWithStrategy</code></a> which stream to poll. The closure can
store state on <code>SelectWithStrategy</code> to which it will receive a <code>&amp;mut</code> on every
invocation. This allows basing the strategy on prior choices.</div></li><li><div class="item-name"><a class="fn" href="fn.try_unfold.html" title="fn futures_util::stream::try_unfold">try_unfold</a></div><div class="desc docblock-short">Creates a <code>TryStream</code> from a seed and a closure returning a <code>TryFuture</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.unfold.html" title="fn futures_util::stream::unfold">unfold</a></div><div class="desc docblock-short">Creates a <code>Stream</code> from a seed and a closure returning a <code>Future</code>.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.BoxStream.html" title="type futures_util::stream::BoxStream">BoxStream</a></div><div class="desc docblock-short">An owned dynamically typed <a href="trait.Stream.html" title="trait futures_util::stream::Stream"><code>Stream</code></a> for use in cases where you can’t
statically type your result or need to add some indirection.</div></li><li><div class="item-name"><a class="type" href="type.FlattenUnordered.html" title="type futures_util::stream::FlattenUnordered">FlattenUnordered</a></div><div class="desc docblock-short">Stream for the <a href="trait.StreamExt.html#method.flatten_unordered" title="method futures_util::stream::StreamExt::flatten_unordered"><code>flatten_unordered</code></a>
method.</div></li><li><div class="item-name"><a class="type" href="type.LocalBoxStream.html" title="type futures_util::stream::LocalBoxStream">LocalBoxStream</a></div><div class="desc docblock-short"><code>BoxStream</code>, but without the <code>Send</code> requirement.</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink