37 lines
35 KiB
HTML
37 lines
35 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="Asynchronous streams."><title>futures_util::stream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Module stream</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures_util/index.html">futures_<wbr>util</a><span class="version">0.3.32</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module stream</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate futures_<wbr>util</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">futures_util</a></div><h1>Module <span>stream</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/futures_util/stream/mod.rs.html#1-148">Source</a> </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">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="futures_unordered/index.html" title="mod futures_util::stream::futures_unordered">futures_<wbr>unordered</a></dt><dd>An unbounded set of futures.</dd><dt><a class="mod" href="select_all/index.html" title="mod futures_util::stream::select_all">select_<wbr>all</a></dt><dd>An unbounded set of streams</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.AbortHandle.html" title="struct futures_util::stream::AbortHandle">Abort<wbr>Handle</a></dt><dd>A handle to an <code>Abortable</code> task.</dd><dt><a class="struct" href="struct.AbortRegistration.html" title="struct futures_util::stream::AbortRegistration">Abort<wbr>Registration</a></dt><dd>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>.</dd><dt><a class="struct" href="struct.Abortable.html" title="struct futures_util::stream::Abortable">Abortable</a></dt><dd>A future/stream which can be remotely short-circuited using an <code>AbortHandle</code>.</dd><dt><a class="struct" href="struct.Aborted.html" title="struct futures_util::stream::Aborted">Aborted</a></dt><dd>Indicator that the <code>Abortable</code> task was aborted.</dd><dt><a class="struct" href="struct.All.html" title="struct futures_util::stream::All">All</a></dt><dd>Future for the <a href="trait.StreamExt.html#method.all" title="method futures_util::stream::StreamExt::all"><code>all</code></a> method.</dd><dt><a class="struct" href="struct.AndThen.html" title="struct futures_util::stream::AndThen">AndThen</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Any.html" title="struct futures_util::stream::Any">Any</a></dt><dd>Future for the <a href="trait.StreamExt.html#method.any" title="method futures_util::stream::StreamExt::any"><code>any</code></a> method.</dd><dt><a class="struct" href="struct.BufferUnordered.html" title="struct futures_util::stream::BufferUnordered">Buffer<wbr>Unordered</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Buffered.html" title="struct futures_util::stream::Buffered">Buffered</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.buffered" title="method futures_util::stream::StreamExt::buffered"><code>buffered</code></a> method.</dd><dt><a class="struct" href="struct.CatchUnwind.html" title="struct futures_util::stream::CatchUnwind">Catch<wbr>Unwind</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Chain.html" title="struct futures_util::stream::Chain">Chain</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.chain" title="method futures_util::stream::StreamExt::chain"><code>chain</code></a> method.</dd><dt><a class="struct" href="struct.Chunks.html" title="struct futures_util::stream::Chunks">Chunks</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.chunks" title="method futures_util::stream::StreamExt::chunks"><code>chunks</code></a> method.</dd><dt><a class="struct" href="struct.Collect.html" title="struct futures_util::stream::Collect">Collect</a></dt><dd>Future for the <a href="trait.StreamExt.html#method.collect" title="method futures_util::stream::StreamExt::collect"><code>collect</code></a> method.</dd><dt><a class="struct" href="struct.Concat.html" title="struct futures_util::stream::Concat">Concat</a></dt><dd>Future for the <a href="trait.StreamExt.html#method.concat" title="method futures_util::stream::StreamExt::concat"><code>concat</code></a> method.</dd><dt><a class="struct" href="struct.Count.html" title="struct futures_util::stream::Count">Count</a></dt><dd>Future for the <a href="trait.StreamExt.html#method.count" title="method futures_util::stream::StreamExt::count"><code>count</code></a> method.</dd><dt><a class="struct" href="struct.Cycle.html" title="struct futures_util::stream::Cycle">Cycle</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.cycle" title="method futures_util::stream::StreamExt::cycle"><code>cycle</code></a> method.</dd><dt><a class="struct" href="struct.Empty.html" title="struct futures_util::stream::Empty">Empty</a></dt><dd>Stream for the <a href="fn.empty.html" title="fn futures_util::stream::empty"><code>empty</code></a> function.</dd><dt><a class="struct" href="struct.Enumerate.html" title="struct futures_util::stream::Enumerate">Enumerate</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.enumerate" title="method futures_util::stream::StreamExt::enumerate"><code>enumerate</code></a> method.</dd><dt><a class="struct" href="struct.ErrInto.html" title="struct futures_util::stream::ErrInto">ErrInto</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Filter.html" title="struct futures_util::stream::Filter">Filter</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.filter" title="method futures_util::stream::StreamExt::filter"><code>filter</code></a> method.</dd><dt><a class="struct" href="struct.FilterMap.html" title="struct futures_util::stream::FilterMap">Filter<wbr>Map</a></dt><dd>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.</dd><dt><a class="struct" href="struct.FlatMap.html" title="struct futures_util::stream::FlatMap">FlatMap</a></dt><dd>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.</dd><dt><a class="struct" href="struct.FlatMapUnordered.html" title="struct futures_util::stream::FlatMapUnordered">Flat<wbr>MapUnordered</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Flatten.html" title="struct futures_util::stream::Flatten">Flatten</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.flatten" title="method futures_util::stream::StreamExt::flatten"><code>flatten</code></a> method.</dd><dt><a class="struct" href="struct.Fold.html" title="struct futures_util::stream::Fold">Fold</a></dt><dd>Future for the <a href="trait.StreamExt.html#method.fold" title="method futures_util::stream::StreamExt::fold"><code>fold</code></a> method.</dd><dt><a class="struct" href="struct.ForEach.html" title="struct futures_util::stream::ForEach">ForEach</a></dt><dd>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.</dd><dt><a class="struct" href="struct.ForEachConcurrent.html" title="struct futures_util::stream::ForEachConcurrent">ForEach<wbr>Concurrent</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Forward.html" title="struct futures_util::stream::Forward">Forward</a></dt><dd>Future for the <a href="trait.StreamExt.html#method.forward" title="method futures_util::stream::StreamExt::forward"><code>forward</code></a> method.</dd><dt><a class="struct" href="struct.Fuse.html" title="struct futures_util::stream::Fuse">Fuse</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.fuse" title="method futures_util::stream::StreamExt::fuse"><code>fuse</code></a> method.</dd><dt><a class="struct" href="struct.FuturesOrdered.html" title="struct futures_util::stream::FuturesOrdered">Futures<wbr>Ordered</a></dt><dd>An unbounded queue of futures.</dd><dt><a class="struct" href="struct.FuturesUnordered.html" title="struct futures_util::stream::FuturesUnordered">Futures<wbr>Unordered</a></dt><dd>A set of futures which may complete in any order.</dd><dt><a class="struct" href="struct.Inspect.html" title="struct futures_util::stream::Inspect">Inspect</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.inspect" title="method futures_util::stream::StreamExt::inspect"><code>inspect</code></a> method.</dd><dt><a class="struct" href="struct.InspectErr.html" title="struct futures_util::stream::InspectErr">Inspect<wbr>Err</a></dt><dd>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.</dd><dt><a class="struct" href="struct.InspectOk.html" title="struct futures_util::stream::InspectOk">Inspect<wbr>Ok</a></dt><dd>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.</dd><dt><a class="struct" href="struct.IntoAsyncRead.html" title="struct futures_util::stream::IntoAsyncRead">Into<wbr>Async<wbr>Read</a></dt><dd>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.</dd><dt><a class="struct" href="struct.IntoStream.html" title="struct futures_util::stream::IntoStream">Into<wbr>Stream</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Iter.html" title="struct futures_util::stream::Iter">Iter</a></dt><dd>Stream for the <a href="fn.iter.html" title="fn futures_util::stream::iter"><code>iter</code></a> function.</dd><dt><a class="struct" href="struct.Map.html" title="struct futures_util::stream::Map">Map</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.map" title="method futures_util::stream::StreamExt::map"><code>map</code></a> method.</dd><dt><a class="struct" href="struct.MapErr.html" title="struct futures_util::stream::MapErr">MapErr</a></dt><dd>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.</dd><dt><a class="struct" href="struct.MapOk.html" title="struct futures_util::stream::MapOk">MapOk</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Next.html" title="struct futures_util::stream::Next">Next</a></dt><dd>Future for the <a href="trait.StreamExt.html#method.next" title="method futures_util::stream::StreamExt::next"><code>next</code></a> method.</dd><dt><a class="struct" href="struct.NextIf.html" title="struct futures_util::stream::NextIf">NextIf</a></dt><dd>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.</dd><dt><a class="struct" href="struct.NextIfEq.html" title="struct futures_util::stream::NextIfEq">Next<wbr>IfEq</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Once.html" title="struct futures_util::stream::Once">Once</a></dt><dd>A stream which emits single element and then EOF.</dd><dt><a class="struct" href="struct.OrElse.html" title="struct futures_util::stream::OrElse">OrElse</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Peek.html" title="struct futures_util::stream::Peek">Peek</a></dt><dd>Future for the <a href="struct.Peekable.html#method.peek" title="method futures_util::stream::Peekable::peek"><code>Peekable::peek</code></a> method.</dd><dt><a class="struct" href="struct.PeekMut.html" title="struct futures_util::stream::PeekMut">PeekMut</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Peekable.html" title="struct futures_util::stream::Peekable">Peekable</a></dt><dd>A <code>Stream</code> that implements a <code>peek</code> method.</dd><dt><a class="struct" href="struct.Pending.html" title="struct futures_util::stream::Pending">Pending</a></dt><dd>Stream for the <a href="fn.pending.html" title="fn futures_util::stream::pending"><code>pending()</code></a> function.</dd><dt><a class="struct" href="struct.PollFn.html" title="struct futures_util::stream::PollFn">PollFn</a></dt><dd>Stream for the <a href="fn.poll_fn.html" title="fn futures_util::stream::poll_fn"><code>poll_fn</code></a> function.</dd><dt><a class="struct" href="struct.PollImmediate.html" title="struct futures_util::stream::PollImmediate">Poll<wbr>Immediate</a></dt><dd>Stream for the <a href="fn.poll_immediate.html" title="fn futures_util::stream::poll_immediate">poll_immediate</a> function.</dd><dt><a class="struct" href="struct.ReadyChunks.html" title="struct futures_util::stream::ReadyChunks">Ready<wbr>Chunks</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Repeat.html" title="struct futures_util::stream::Repeat">Repeat</a></dt><dd>Stream for the <a href="fn.repeat.html" title="fn futures_util::stream::repeat"><code>repeat</code></a> function.</dd><dt><a class="struct" href="struct.RepeatWith.html" title="struct futures_util::stream::RepeatWith">Repeat<wbr>With</a></dt><dd>An stream that repeats elements of type <code>A</code> endlessly by
|
||
applying the provided closure <code>F: FnMut() -> A</code>.</dd><dt><a class="struct" href="struct.ReuniteError.html" title="struct futures_util::stream::ReuniteError">Reunite<wbr>Error</a></dt><dd>Error indicating a <code>SplitSink<S></code> and <code>SplitStream<S></code> were not two halves
|
||
of a <code>Stream + Split</code>, and thus could not be <code>reunite</code>d.</dd><dt><a class="struct" href="struct.Scan.html" title="struct futures_util::stream::Scan">Scan</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.scan" title="method futures_util::stream::StreamExt::scan"><code>scan</code></a> method.</dd><dt><a class="struct" href="struct.Select.html" title="struct futures_util::stream::Select">Select</a></dt><dd>Stream for the <a href="fn.select.html" title="fn futures_util::stream::select"><code>select()</code></a> function.</dd><dt><a class="struct" href="struct.SelectAll.html" title="struct futures_util::stream::SelectAll">Select<wbr>All</a></dt><dd>An unbounded set of streams</dd><dt><a class="struct" href="struct.SelectNextSome.html" title="struct futures_util::stream::SelectNextSome">Select<wbr>Next<wbr>Some</a></dt><dd>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.</dd><dt><a class="struct" href="struct.SelectWithStrategy.html" title="struct futures_util::stream::SelectWithStrategy">Select<wbr>With<wbr>Strategy</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Skip.html" title="struct futures_util::stream::Skip">Skip</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.skip" title="method futures_util::stream::StreamExt::skip"><code>skip</code></a> method.</dd><dt><a class="struct" href="struct.SkipWhile.html" title="struct futures_util::stream::SkipWhile">Skip<wbr>While</a></dt><dd>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.</dd><dt><a class="struct" href="struct.SplitSink.html" title="struct futures_util::stream::SplitSink">Split<wbr>Sink</a></dt><dd>A <code>Sink</code> part of the split pair</dd><dt><a class="struct" href="struct.SplitStream.html" title="struct futures_util::stream::SplitStream">Split<wbr>Stream</a></dt><dd>A <code>Stream</code> part of the split pair</dd><dt><a class="struct" href="struct.StreamFuture.html" title="struct futures_util::stream::StreamFuture">Stream<wbr>Future</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Take.html" title="struct futures_util::stream::Take">Take</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.take" title="method futures_util::stream::StreamExt::take"><code>take</code></a> method.</dd><dt><a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">Take<wbr>Until</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TakeWhile.html" title="struct futures_util::stream::TakeWhile">Take<wbr>While</a></dt><dd>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.</dd><dt><a class="struct" href="struct.Then.html" title="struct futures_util::stream::Then">Then</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.then" title="method futures_util::stream::StreamExt::then"><code>then</code></a> method.</dd><dt><a class="struct" href="struct.TryAll.html" title="struct futures_util::stream::TryAll">TryAll</a></dt><dd>Future for the <a href="trait.TryStreamExt.html#method.try_all" title="method futures_util::stream::TryStreamExt::try_all"><code>try_all</code></a> method.</dd><dt><a class="struct" href="struct.TryAny.html" title="struct futures_util::stream::TryAny">TryAny</a></dt><dd>Future for the <a href="trait.TryStreamExt.html#method.try_any" title="method futures_util::stream::TryStreamExt::try_any"><code>try_any</code></a> method.</dd><dt><a class="struct" href="struct.TryBufferUnordered.html" title="struct futures_util::stream::TryBufferUnordered">TryBuffer<wbr>Unordered</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryBuffered.html" title="struct futures_util::stream::TryBuffered">TryBuffered</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryChunks.html" title="struct futures_util::stream::TryChunks">TryChunks</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryChunksError.html" title="struct futures_util::stream::TryChunksError">TryChunks<wbr>Error</a></dt><dd>Error indicating, that while chunk was collected inner stream produced an error.</dd><dt><a class="struct" href="struct.TryCollect.html" title="struct futures_util::stream::TryCollect">TryCollect</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryConcat.html" title="struct futures_util::stream::TryConcat">TryConcat</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryFilter.html" title="struct futures_util::stream::TryFilter">TryFilter</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryFilterMap.html" title="struct futures_util::stream::TryFilterMap">TryFilter<wbr>Map</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryFlatten.html" title="struct futures_util::stream::TryFlatten">TryFlatten</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryFlattenUnordered.html" title="struct futures_util::stream::TryFlattenUnordered">TryFlatten<wbr>Unordered</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryFold.html" title="struct futures_util::stream::TryFold">TryFold</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryForEach.html" title="struct futures_util::stream::TryForEach">TryFor<wbr>Each</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryForEachConcurrent.html" title="struct futures_util::stream::TryForEachConcurrent">TryFor<wbr>Each<wbr>Concurrent</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryNext.html" title="struct futures_util::stream::TryNext">TryNext</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryReadyChunks.html" title="struct futures_util::stream::TryReadyChunks">TryReady<wbr>Chunks</a></dt><dd>Stream for the <a href="trait.TryStreamExt.html#method.try_ready_chunks" title="method futures_util::stream::TryStreamExt::try_ready_chunks"><code>try_ready_chunks</code></a> method.</dd><dt><a class="struct" href="struct.TryReadyChunksError.html" title="struct futures_util::stream::TryReadyChunksError">TryReady<wbr>Chunks<wbr>Error</a></dt><dd>Error indicating, that while chunk was collected inner stream produced an error.</dd><dt><a class="struct" href="struct.TrySkipWhile.html" title="struct futures_util::stream::TrySkipWhile">TrySkip<wbr>While</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryTakeWhile.html" title="struct futures_util::stream::TryTakeWhile">TryTake<wbr>While</a></dt><dd>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.</dd><dt><a class="struct" href="struct.TryUnfold.html" title="struct futures_util::stream::TryUnfold">TryUnfold</a></dt><dd>Stream for the <a href="fn.try_unfold.html" title="fn futures_util::stream::try_unfold"><code>try_unfold</code></a> function.</dd><dt><a class="struct" href="struct.Unfold.html" title="struct futures_util::stream::Unfold">Unfold</a></dt><dd>Stream for the <a href="fn.unfold.html" title="fn futures_util::stream::unfold"><code>unfold</code></a> function.</dd><dt><a class="struct" href="struct.Unzip.html" title="struct futures_util::stream::Unzip">Unzip</a></dt><dd>Future for the <a href="trait.StreamExt.html#method.unzip" title="method futures_util::stream::StreamExt::unzip"><code>unzip</code></a> method.</dd><dt><a class="struct" href="struct.Zip.html" title="struct futures_util::stream::Zip">Zip</a></dt><dd>Stream for the <a href="trait.StreamExt.html#method.zip" title="method futures_util::stream::StreamExt::zip"><code>zip</code></a> method.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.PollNext.html" title="enum futures_util::stream::PollNext">Poll<wbr>Next</a></dt><dd>Type to tell <a href="struct.SelectWithStrategy.html" title="struct futures_util::stream::SelectWithStrategy"><code>SelectWithStrategy</code></a> which stream to poll next.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.FusedStream.html" title="trait futures_util::stream::FusedStream">Fused<wbr>Stream</a></dt><dd>A stream which tracks whether or not the underlying stream
|
||
should no longer be polled.</dd><dt><a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a></dt><dd>A stream of values produced asynchronously.</dd><dt><a class="trait" href="trait.StreamExt.html" title="trait futures_util::stream::StreamExt">Stream<wbr>Ext</a></dt><dd>An extension trait for <code>Stream</code>s that provides a variety of convenient
|
||
combinator functions.</dd><dt><a class="trait" href="trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a></dt><dd>A convenience for streams that return <code>Result</code> values that includes
|
||
a variety of adapters tailored to such futures.</dd><dt><a class="trait" href="trait.TryStreamExt.html" title="trait futures_util::stream::TryStreamExt">TryStream<wbr>Ext</a></dt><dd>Adapters specific to <code>Result</code>-returning streams</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.abortable.html" title="fn futures_util::stream::abortable">abortable</a></dt><dd>Creates a new <code>Abortable</code> stream and an <code>AbortHandle</code> which can be used to stop it.</dd><dt><a class="fn" href="fn.empty.html" title="fn futures_util::stream::empty">empty</a></dt><dd>Creates a stream which contains no elements.</dd><dt><a class="fn" href="fn.iter.html" title="fn futures_util::stream::iter">iter</a></dt><dd>Converts an <code>Iterator</code> into a <code>Stream</code> which is always ready
|
||
to yield the next value.</dd><dt><a class="fn" href="fn.once.html" title="fn futures_util::stream::once">once</a></dt><dd>Creates a stream of a single element.</dd><dt><a class="fn" href="fn.pending.html" title="fn futures_util::stream::pending">pending</a></dt><dd>Creates a stream which never returns any elements.</dd><dt><a class="fn" href="fn.poll_fn.html" title="fn futures_util::stream::poll_fn">poll_fn</a></dt><dd>Creates a new stream wrapping a function returning <code>Poll<Option<T>></code>.</dd><dt><a class="fn" href="fn.poll_immediate.html" title="fn futures_util::stream::poll_immediate">poll_<wbr>immediate</a></dt><dd>Creates a new stream that always immediately returns <a href="https://doc.rust-lang.org/1.93.1/core/task/poll/enum.Poll.html#variant.Ready" title="variant core::task::poll::Poll::Ready">Poll::Ready</a> when awaiting it.</dd><dt><a class="fn" href="fn.repeat.html" title="fn futures_util::stream::repeat">repeat</a></dt><dd>Create a stream which produces the same item repeatedly.</dd><dt><a class="fn" href="fn.repeat_with.html" title="fn futures_util::stream::repeat_with">repeat_<wbr>with</a></dt><dd>Creates a new stream that repeats elements of type <code>A</code> endlessly by
|
||
applying the provided closure, the repeater, <code>F: FnMut() -> A</code>.</dd><dt><a class="fn" href="fn.select.html" title="fn futures_util::stream::select">select</a></dt><dd>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.</dd><dt><a class="fn" href="fn.select_all.html" title="fn futures_util::stream::select_all">select_<wbr>all</a></dt><dd>Convert a list of streams into a <code>Stream</code> of results from the streams.</dd><dt><a class="fn" href="fn.select_with_strategy.html" title="fn futures_util::stream::select_with_strategy">select_<wbr>with_<wbr>strategy</a></dt><dd>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>&mut</code> on every
|
||
invocation. This allows basing the strategy on prior choices.</dd><dt><a class="fn" href="fn.try_unfold.html" title="fn futures_util::stream::try_unfold">try_<wbr>unfold</a></dt><dd>Creates a <code>TryStream</code> from a seed and a closure returning a <code>TryFuture</code>.</dd><dt><a class="fn" href="fn.unfold.html" title="fn futures_util::stream::unfold">unfold</a></dt><dd>Creates a <code>Stream</code> from a seed and a closure returning a <code>Future</code>.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.BoxStream.html" title="type futures_util::stream::BoxStream">BoxStream</a></dt><dd>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.</dd><dt><a class="type" href="type.FlattenUnordered.html" title="type futures_util::stream::FlattenUnordered">Flatten<wbr>Unordered</a></dt><dd>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.</dd><dt><a class="type" href="type.LocalBoxStream.html" title="type futures_util::stream::LocalBoxStream">Local<wbr>BoxStream</a></dt><dd><code>BoxStream</code>, but without the <code>Send</code> requirement.</dd></dl></section></div></main></body></html> |