mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-27 17:52:56 +01:00
268 lines
109 KiB
HTML
268 lines
109 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="A streaming payload."><title>Payload in actix_http - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_http" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (bdbbb6c6a 2024-05-26)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc enum"><!--[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" title="show sidebar"></button><a class="logo-container" href="../actix_http/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../actix_http/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_http/index.html">actix_http</a><span class="version">3.7.0</span></h2></div><h2 class="location"><a href="#">Payload</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.H1">H1</a></li><li><a href="#variant.H2">H2</a></li><li><a href="#variant.None">None</a></li><li><a href="#variant.Stream">Stream</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.take">take</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-From%3CPayload%3E-for-Payload%3CS%3E">From<Payload></a></li><li><a href="#impl-From%3CPayload%3E-for-Payload%3CS%3E-1">From<Payload></a></li><li><a href="#impl-From%3CPin%3CBox%3Cdyn+Stream%3CItem+=+Result%3CBytes,+PayloadError%3E%3E%3E%3E%3E-for-Payload">From<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>>>>></a></li><li><a href="#impl-From%3CRecvStream%3E-for-Payload%3CS%3E">From<RecvStream></a></li><li><a href="#impl-Stream-for-Payload%3CS%3E">Stream</a></li><li><a href="#impl-Unpin-for-Payload%3CS%3E">Unpin</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-Payload%3CS%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Payload%3CS%3E">!Send</a></li><li><a href="#impl-Sync-for-Payload%3CS%3E">!Sync</a></li><li><a href="#impl-UnwindSafe-for-Payload%3CS%3E">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-Payload%3CS%3E">Freeze</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From&l
|
|||
|
|
None,
|
|||
|
|
H1 {
|
|||
|
|
payload: <a class="struct" href="h1/struct.Payload.html" title="struct actix_http::h1::Payload">Payload</a>,
|
|||
|
|
},
|
|||
|
|
H2 {
|
|||
|
|
payload: <a class="struct" href="h2/struct.Payload.html" title="struct actix_http::h2::Payload">Payload</a>,
|
|||
|
|
},
|
|||
|
|
Stream {
|
|||
|
|
payload: S,
|
|||
|
|
},
|
|||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A streaming payload.</p>
|
|||
|
|
</div></details><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.None" class="variant"><a href="#variant.None" class="anchor">§</a><h3 class="code-header">None</h3></section><section id="variant.H1" class="variant"><a href="#variant.H1" class="anchor">§</a><h3 class="code-header">H1</h3></section><div class="sub-variant" id="variant.H1.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.H1.field.payload" class="section-header"><a href="#variant.H1.field.payload" class="anchor field">§</a><code>payload: <a class="struct" href="h1/struct.Payload.html" title="struct actix_http::h1::Payload">Payload</a></code></span></div></div><section id="variant.H2" class="variant"><a href="#variant.H2" class="anchor">§</a><h3 class="code-header">H2</h3></section><div class="sub-variant" id="variant.H2.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.H2.field.payload" class="section-header"><a href="#variant.H2.field.payload" class="anchor field">§</a><code>payload: <a class="struct" href="h2/struct.Payload.html" title="struct actix_http::h2::Payload">Payload</a></code></span></div></div><section id="variant.Stream" class="variant"><a href="#variant.Stream" class="anchor">§</a><h3 class="code-header">Stream</h3></section><div class="sub-variant" id="variant.Stream.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.Stream.field.payload" class="section-header"><a href="#variant.Stream.field.payload" class="anchor field">§</a><code>payload: S</code></span></div></div></div><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Payload%3CS%3E" class="impl"><a class="src rightside" href="../src/actix_http/payload.rs.html#71-76">source</a><a href="#impl-Payload%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a><S></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.take" class="method"><a class="src rightside" href="../src/actix_http/payload.rs.html#73-75">source</a><h4 class="code-header">pub fn <a href="#method.take" class="fn">take</a>(&mut self) -> <a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a><S></h4></section></summary><div class="docblock"><p>Takes current payload and replaces it with <code>None</code> value</p>
|
|||
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CPayload%3E-for-Payload%3CS%3E" class="impl"><a class="src rightside" href="../src/actix_http/payload.rs.html#50-54">source</a><a href="#impl-From%3CPayload%3E-for-Payload%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="h2/struct.Payload.html" title="struct actix_http::h2::Payload">Payload</a>> for <a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a><S></h3><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>http2</code></strong> only.</div></span></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../src/actix_http/payload.rs.html#51-53">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(payload: <a class="struct" href="h2/struct.Payload.html" title="struct actix_http::h2::Payload">Payload</a>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CPayload%3E-for-Payload%3CS%3E-1" class="impl"><a class="src rightside" href="../src/actix_http/payload.rs.html#43-47">source</a><a href="#impl-From%3CPayload%3E-for-Payload%3CS%3E-1" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="h1/struct.Payload.html" title="struct actix_http::h1::Payload">Payload</a>> for <a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a><S></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="../src/actix_http/payload.rs.html#44-46">source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(payload: <a class="struct" href="h1/struct.Payload.html" title="struct actix_http::h1::Payload">Payload</a>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CPin%3CBox%3Cdyn+Stream%3CItem+=+Result%3CBytes,+PayloadError%3E%3E%3E%3E%3E-for-Payload" class="impl"><a class="src rightside" href="../src/actix_http/payload.rs.html#65-69">source</a><a href="#impl-From%3CPin%3CBox%3Cdyn+Stream%3CItem+=+Result%3CBytes,+PayloadError%3E%3E%3E%3E%3E-for-Payload" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, <a class="enum" href="error/enum.PayloadError.html" title="enum actix_http::error::PayloadError">PayloadError</a>>>>>> for <a class="
|
|||
|
|
S: Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, <a class="enum" href="error/enum.PayloadError.html" title="enum actix_http::error::PayloadError">PayloadError</a>>>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Item</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, <a class="enum" href="error/enum.PayloadError.html" title="enum actix_http::error::PayloadError">PayloadError</a>></h4></section></summary><div class='docblock'>Values yielded by the stream.</div></details><details class="toggle method-toggle" open><summary><section id="method.poll_next" class="method trait-impl"><a class="src rightside" href="../src/actix_http/payload.rs.html#85-95">source</a><a href="#method.poll_next" class="anchor">§</a><h4 class="code-header">fn <a class="fn">poll_next</a>(
|
|||
|
|
self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut Self</a>>,
|
|||
|
|
cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::Item>></h4></section></summary><div class='docblock'>Attempt to pull out the next value of this stream, registering the
|
|||
|
|
current task for wakeup if the value is not yet available, and returning
|
|||
|
|
<code>None</code> if the stream is exhausted. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.size_hint" class="method trait-impl"><a href="#method.size_hint" class="anchor">§</a><h4 class="code-header">fn <a class="fn">size_hint</a>(&self) -> (<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>)</h4></section></summary><div class='docblock'>Returns the bounds on the remaining length of the stream. <a>Read more</a></div></details></div></details><section id="impl-Unpin-for-Payload%3CS%3E" class="impl"><a class="src rightside" href="../src/actix_http/payload.rs.html#32-41">source</a><a href="#impl-Unpin-for-Payload%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<'__pin, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a><S><div class="where">where
|
|||
|
|
__Origin<'__pin, S>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Payload%3CS%3E" class="impl"><a href="#impl-Freeze-for-Payload%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a><S><div class="where">where
|
|||
|
|
S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-Payload%3CS%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Payload%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S = <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, <a class="enum" href="error/enum.PayloadError.html" title="enum actix_http::error::PayloadError">PayloadError</a>>>>>> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a><S></h3></section><section id="impl-Send-for-Payload%3CS%3E" class="impl"><a href="#impl-Send-for-Payload%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S = <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, <a class="enum" href="error/enum.PayloadError.html" title="enum actix_http::error::PayloadError">PayloadError</a>>>>>> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a><S></h3></section><section id="impl-Sync-for-Payload%3CS%3E" class="impl"><a href="#impl-Sync-for-Payload%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S = <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, <a class="enum" href="error/enum.PayloadError.html" title="enum actix_http::error::PayloadError">PayloadError</a>>>>>> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a><S></h3></section><section id="impl-UnwindSafe-for-Payload%3CS%3E" class="impl"><a href="#impl-UnwindSafe-for-Payload%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S = <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, <a class="enum" href="error/enum.PayloadError.html" title="enum actix_http::error::PayloadError">PayloadError</a>>>>>> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a><S></h3></section></div><h2 id="blanket-im
|
|||
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-4" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#768">source</a><a href="#method.from-4" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Instrument-for-T" class="impl"><a href="#impl-Instrument-for-T" class="anchor">§</a><h3 class="code-header">impl<T> Instrument for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl"><a href="#method.instrument" class="anchor">§</a><h4 class="code-header">fn <a class="fn">instrument</a>(self, span: Span) -> Instrumented<Self></h4></section></summary><div class='docblock'>Instruments this type with the provided [<code>Span</code>], returning an
|
|||
|
|
<code>Instrumented</code> wrapper. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl"><a href="#method.in_current_span" class="anchor">§</a><h4 class="code-header">fn <a class="fn">in_current_span</a>(self) -> Instrumented<Self></h4></section></summary><div class='docblock'>Instruments this type with the <a href="super::Span::current()">current</a> <a href="crate::Span"><code>Span</code></a>, returning an
|
|||
|
|
<code>Instrumented</code> wrapper. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|||
|
|
<p>That is, this conversion is whatever the implementation of
|
|||
|
|
<code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Same-for-T" class="impl"><a class="src rightside" href="https://docs.rs/typenum/1.17.0/src/typenum/type_operators.rs.html#34">source</a><a href="#impl-Same-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://docs.rs/typenum/1.17.0/typenum/type_operators/trait.Same.html" title="trait typenum::type_operators::Same">Same</a> for T</h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a href="https://docs.rs/typenum/1.17.0/typenum/type_operators/trait.Same.html#associatedtype.Output" class="associatedtype">Output</a> = T</h4></section></summary><div class='docblock'>Should always be <code>Self</code></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-StreamExt-for-T" class="impl"><a href="#impl-StreamExt-for-T" class="anchor">§</a><h3 class="code-header">impl<T> StreamExt for T<div class="where">where
|
|||
|
|
T: Stream + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.next" class="method trait-impl"><a href="#method.next" class="anchor">§</a><h4 class="code-header">fn <a class="fn">next</a>(&mut self) -> Next<'_, Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Creates a future that resolves to the next item in the stream. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.into_future" class="method trait-impl"><a href="#method.into_future" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into_future</a>(self) -> StreamFuture<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Converts this stream into a future of <code>(next_item, tail_of_stream)</code>.
|
|||
|
|
If the stream terminates, then the next item is <a href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.map" class="method trait-impl"><a href="#method.map" class="anchor">§</a><h4 class="code-header">fn <a class="fn">map</a><T, F>(self, f: F) -> Map<Self, F><div class="where">where
|
|||
|
|
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::Item) -> T,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Maps this stream’s items to a different type, returning a new stream of
|
|||
|
|
the resulting type. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.enumerate" class="method trait-impl"><a href="#method.enumerate" class="anchor">§</a><h4 class="code-header">fn <a class="fn">enumerate</a>(self) -> Enumerate<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Creates a stream which gives the current iteration count as well as
|
|||
|
|
the next value. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.filter" class="method trait-impl"><a href="#method.filter" class="anchor">§</a><h4 class="code-header">fn <a class="fn">filter</a><Fut, F>(self, f: F) -> Filter<Self, Fut, F><div class="where">where
|
|||
|
|
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::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Filters the values produced by this stream according to the provided
|
|||
|
|
asynchronous predicate. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.filter_map" class="method trait-impl"><a href="#method.filter_map" class="anchor">§</a><h4 class="code-header">fn <a class="fn">filter_map</a><Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F><div class="where">where
|
|||
|
|
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::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T>>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Filters the values produced by this stream while simultaneously mapping
|
|||
|
|
them to a different type according to the provided asynchronous closure. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.then" class="method trait-impl"><a href="#method.then" class="anchor">§</a><h4 class="code-header">fn <a class="fn">then</a><Fut, F>(self, f: F) -> Then<Self, Fut, F><div class="where">where
|
|||
|
|
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::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Computes from this stream’s items new items of a different type using
|
|||
|
|
an asynchronous closure. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.collect" class="method trait-impl"><a href="#method.collect" class="anchor">§</a><h4 class="code-header">fn <a class="fn">collect</a><C>(self) -> Collect<Self, C><div class="where">where
|
|||
|
|
C: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><Self::Item>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Transforms a stream into a collection, returning a
|
|||
|
|
future representing the result of that computation. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.unzip" class="method trait-impl"><a href="#method.unzip" class="anchor">§</a><h4 class="code-header">fn <a class="fn">unzip</a><A, B, FromA, FromB>(self) -> Unzip<Self, FromA, FromB><div class="where">where
|
|||
|
|
FromA: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><A>,
|
|||
|
|
FromB: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><B>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + Stream<Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(A, B)</a>>,</div></h4></section></summary><div class='docblock'>Converts a stream of pairs into a future, which
|
|||
|
|
resolves to pair of containers. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.concat" class="method trait-impl"><a href="#method.concat" class="anchor">§</a><h4 class="code-header">fn <a class="fn">concat</a>(self) -> Concat<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|||
|
|
Self::Item: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><<Self::Item as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></h4></section></summary><div class='docblock'>Concatenate all items of a stream into a single extendable
|
|||
|
|
destination, returning a future representing the end result. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.count" class="method trait-impl"><a href="#method.count" class="anchor">§</a><h4 class="code-header">fn <a class="fn">count</a>(self) -> Count<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Drives the stream to completion, counting the number of items. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.cycle" class="method trait-impl"><a href="#method.cycle" class="anchor">§</a><h4 class="code-header">fn <a class="fn">cycle</a>(self) -> Cycle<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class='docblock'>Repeats a stream endlessly. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.fold" class="method trait-impl"><a href="#method.fold" class="anchor">§</a><h4 class="code-header">fn <a class="fn">fold</a><T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F><div class="where">where
|
|||
|
|
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::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Execute an accumulating asynchronous computation over a stream,
|
|||
|
|
collecting all the values into one final result. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.any" class="method trait-impl"><a href="#method.any" class="anchor">§</a><h4 class="code-header">fn <a class="fn">any</a><Fut, F>(self, f: F) -> Any<Self, Fut, F><div class="where">where
|
|||
|
|
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::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Execute predicate over asynchronous stream, and return <code>true</code> if any element in stream satisfied a predicate. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.all" class="method trait-impl"><a href="#method.all" class="anchor">§</a><h4 class="code-header">fn <a class="fn">all</a><Fut, F>(self, f: F) -> All<Self, Fut, F><div class="where">where
|
|||
|
|
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::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Execute predicate over asynchronous stream, and return <code>true</code> if all element in stream satisfied a predicate. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.flatten" class="method trait-impl"><a href="#method.flatten" class="anchor">§</a><h4 class="code-header">fn <a class="fn">flatten</a>(self) -> Flatten<Self><div class="where">where
|
|||
|
|
Self::Item: Stream,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Flattens a stream of streams into just one continuous stream. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.flatten_unordered" class="method trait-impl"><a href="#method.flatten_unordered" class="anchor">§</a><h4 class="code-header">fn <a class="fn">flatten_unordered</a>(
|
|||
|
|
self,
|
|||
|
|
limit: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>>
|
|||
|
|
) -> FlattenUnorderedWithFlowController<Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><div class="where">where
|
|||
|
|
Self::Item: Stream + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>Flattens a stream of streams into just one continuous stream. Polls
|
|||
|
|
inner streams produced by the base stream concurrently. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.flat_map" class="method trait-impl"><a href="#method.flat_map" class="anchor">§</a><h4 class="code-header">fn <a class="fn">flat_map</a><U, F>(self, f: F) -> FlatMap<Self, U, F><div class="where">where
|
|||
|
|
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::Item) -> U,
|
|||
|
|
U: Stream,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Maps a stream like [<code>StreamExt::map</code>] but flattens nested <code>Stream</code>s. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.flat_map_unordered" class="method trait-impl"><a href="#method.flat_map_unordered" class="anchor">§</a><h4 class="code-header">fn <a class="fn">flat_map_unordered</a><U, F>(
|
|||
|
|
self,
|
|||
|
|
limit: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>>,
|
|||
|
|
f: F
|
|||
|
|
) -> FlatMapUnordered<Self, U, F><div class="where">where
|
|||
|
|
U: Stream + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
|||
|
|
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::Item) -> U,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>Maps a stream like [<code>StreamExt::map</code>] but flattens nested <code>Stream</code>s
|
|||
|
|
and polls them concurrently, yielding items in any order, as they made
|
|||
|
|
available. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.scan" class="method trait-impl"><a href="#method.scan" class="anchor">§</a><h4 class="code-header">fn <a class="fn">scan</a><S, B, Fut, F>(self, initial_state: S, f: F) -> Scan<Self, S, Fut, F><div class="where">where
|
|||
|
|
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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut S</a>, Self::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><B>>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Combinator similar to [<code>StreamExt::fold</code>] that holds internal state
|
|||
|
|
and produces a new stream. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.skip_while" class="method trait-impl"><a href="#method.skip_while" class="anchor">§</a><h4 class="code-header">fn <a class="fn">skip_while</a><Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F><div class="where">where
|
|||
|
|
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::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Skip elements on this stream while the provided asynchronous predicate
|
|||
|
|
resolves to <code>true</code>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.take_while" class="method trait-impl"><a href="#method.take_while" class="anchor">§</a><h4 class="code-header">fn <a class="fn">take_while</a><Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F><div class="where">where
|
|||
|
|
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::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Take elements from this stream while the provided asynchronous predicate
|
|||
|
|
resolves to <code>true</code>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.take_until" class="method trait-impl"><a href="#method.take_until" class="anchor">§</a><h4 class="code-header">fn <a class="fn">take_until</a><Fut>(self, fut: Fut) -> TakeUntil<Self, Fut><div class="where">where
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Take elements from this stream until the provided future resolves. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.for_each" class="method trait-impl"><a href="#method.for_each" class="anchor">§</a><h4 class="code-header">fn <a class="fn">for_each</a><Fut, F>(self, f: F) -> ForEach<Self, Fut, F><div class="where">where
|
|||
|
|
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::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Runs this stream to completion, executing the provided asynchronous
|
|||
|
|
closure for each element on the stream. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.for_each_concurrent" class="method trait-impl"><a href="#method.for_each_concurrent" class="anchor">§</a><h4 class="code-header">fn <a class="fn">for_each_concurrent</a><Fut, F>(
|
|||
|
|
self,
|
|||
|
|
limit: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>>,
|
|||
|
|
f: F
|
|||
|
|
) -> ForEachConcurrent<Self, Fut, F><div class="where">where
|
|||
|
|
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::Item) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>Runs this stream to completion, executing the provided asynchronous
|
|||
|
|
closure for each element on the stream concurrently as elements become
|
|||
|
|
available. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.take-1" class="method trait-impl"><a href="#method.take-1" class="anchor">§</a><h4 class="code-header">fn <a class="fn">take</a>(self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Take<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Creates a new stream of at most <code>n</code> items of the underlying stream. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.skip" class="method trait-impl"><a href="#method.skip" class="anchor">§</a><h4 class="code-header">fn <a class="fn">skip</a>(self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Skip<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Creates a new stream which skips <code>n</code> items of the underlying stream. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.fuse" class="method trait-impl"><a href="#method.fuse" class="anchor">§</a><h4 class="code-header">fn <a class="fn">fuse</a>(self) -> Fuse<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Fuse a stream such that <a href="Stream::poll_next"><code>poll_next</code></a> will never
|
|||
|
|
again be called once it has finished. This method can be used to turn
|
|||
|
|
any <code>Stream</code> into a <code>FusedStream</code>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.by_ref" class="method trait-impl"><a href="#method.by_ref" class="anchor">§</a><h4 class="code-header">fn <a class="fn">by_ref</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut Self</a></h4></section></summary><div class='docblock'>Borrows a stream, rather than consuming it. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.catch_unwind" class="method trait-impl"><a href="#method.catch_unwind" class="anchor">§</a><h4 class="code-header">fn <a class="fn">catch_unwind</a>(self) -> CatchUnwind<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>std</code></strong> only.</div></span><div class='docblock'>Catches unwinding panics while polling the stream. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.boxed" class="method trait-impl"><a href="#method.boxed" class="anchor">§</a><h4 class="code-header">fn <a class="fn">boxed</a><'a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn Stream<Item = Self::Item> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'a>><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'a,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>Wrap the stream in a Box, pinning it. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.boxed_local" class="method trait-impl"><a href="#method.boxed_local" class="anchor">§</a><h4 class="code-header">fn <a class="fn">boxed_local</a><'a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn Stream<Item = Self::Item> + 'a>><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>Wrap the stream in a Box, pinning it. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.buffered" class="method trait-impl"><a href="#method.buffered" class="anchor">§</a><h4 class="code-header">fn <a class="fn">buffered</a>(self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Buffered<Self><div class="where">where
|
|||
|
|
Self::Item: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>An adaptor for creating a buffered list of pending futures. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.buffer_unordered" class="method trait-impl"><a href="#method.buffer_unordered" class="anchor">§</a><h4 class="code-header">fn <a class="fn">buffer_unordered</a>(self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> BufferUnordered<Self><div class="where">where
|
|||
|
|
Self::Item: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>An adaptor for creating a buffered list of pending futures (unordered). <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.zip" class="method trait-impl"><a href="#method.zip" class="anchor">§</a><h4 class="code-header">fn <a class="fn">zip</a><St>(self, other: St) -> Zip<Self, St><div class="where">where
|
|||
|
|
St: Stream,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>An adapter for zipping two streams together. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.chain" class="method trait-impl"><a href="#method.chain" class="anchor">§</a><h4 class="code-header">fn <a class="fn">chain</a><St>(self, other: St) -> Chain<Self, St><div class="where">where
|
|||
|
|
St: Stream<Item = Self::Item>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Adapter for chaining two streams. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.peekable" class="method trait-impl"><a href="#method.peekable" class="anchor">§</a><h4 class="code-header">fn <a class="fn">peekable</a>(self) -> Peekable<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Creates a new stream which exposes a <code>peek</code> method. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.chunks" class="method trait-impl"><a href="#method.chunks" class="anchor">§</a><h4 class="code-header">fn <a class="fn">chunks</a>(self, capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Chunks<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>An adaptor for chunking up items of the stream inside a vector. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.ready_chunks" class="method trait-impl"><a href="#method.ready_chunks" class="anchor">§</a><h4 class="code-header">fn <a class="fn">ready_chunks</a>(self, capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> ReadyChunks<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>An adaptor for chunking up ready items of the stream inside a vector. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.forward" class="method trait-impl"><a href="#method.forward" class="anchor">§</a><h4 class="code-header">fn <a class="fn">forward</a><S>(self, sink: S) -> Forward<Self, S><div class="where">where
|
|||
|
|
S: Sink<Self::Ok, Error = Self::Error>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + TryStream,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>sink</code></strong> only.</div></span><div class='docblock'>A future that completes after the given stream has been fully processed
|
|||
|
|
into the sink and the sink has been flushed and closed. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.split" class="method trait-impl"><a href="#method.split" class="anchor">§</a><h4 class="code-header">fn <a class="fn">split</a><Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>)<div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + Sink<Item>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate features <code>sink</code> and <code>alloc</code></strong> only.</div></span><div class='docblock'>Splits this <code>Stream + Sink</code> object into separate <code>Sink</code> and <code>Stream</code>
|
|||
|
|
objects. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.inspect" class="method trait-impl"><a href="#method.inspect" class="anchor">§</a><h4 class="code-header">fn <a class="fn">inspect</a><F>(self, f: F) -> Inspect<Self, F><div class="where">where
|
|||
|
|
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::Item),
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Do something with each item of this stream, afterwards passing it on. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.left_stream" class="method trait-impl"><a href="#method.left_stream" class="anchor">§</a><h4 class="code-header">fn <a class="fn">left_stream</a><B>(self) -> Either<Self, B><div class="where">where
|
|||
|
|
B: Stream<Item = Self::Item>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Wrap this stream in an <code>Either</code> stream, making it the left-hand variant
|
|||
|
|
of that <code>Either</code>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.right_stream" class="method trait-impl"><a href="#method.right_stream" class="anchor">§</a><h4 class="code-header">fn <a class="fn">right_stream</a><B>(self) -> Either<B, Self><div class="where">where
|
|||
|
|
B: Stream<Item = Self::Item>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Wrap this stream in an <code>Either</code> stream, making it the right-hand variant
|
|||
|
|
of that <code>Either</code>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.poll_next_unpin" class="method trait-impl"><a href="#method.poll_next_unpin" class="anchor">§</a><h4 class="code-header">fn <a class="fn">poll_next_unpin</a>(&mut self, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::Item>><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>A convenience method for calling [<code>Stream::poll_next</code>] on <a href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin"><code>Unpin</code></a>
|
|||
|
|
stream types.</div></details><details class="toggle method-toggle" open><summary><section id="method.select_next_some" class="method trait-impl"><a href="#method.select_next_some" class="anchor">§</a><h4 class="code-header">fn <a class="fn">select_next_some</a>(&mut self) -> SelectNextSome<'_, Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + FusedStream,</div></h4></section></summary><div class='docblock'>Returns a <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future"><code>Future</code></a> that resolves when the next item in this stream is
|
|||
|
|
ready. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryStream-for-S" class="impl"><a href="#impl-TryStream-for-S" class="anchor">§</a><h3 class="code-header">impl<S, T, E> TryStream for S<div class="where">where
|
|||
|
|
S: Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, E>> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Ok" class="associatedtype trait-impl"><a href="#associatedtype.Ok" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Ok</a> = T</h4></section></summary><div class='docblock'>The type of successful values yielded by this future</div></details><details class="toggle" open><summary><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Error</a> = E</h4></section></summary><div class='docblock'>The type of failures yielded by this future</div></details><details class="toggle method-toggle" open><summary><section id="method.try_poll_next" class="method trait-impl"><a href="#method.try_poll_next" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_poll_next</a>(
|
|||
|
|
self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut S</a>>,
|
|||
|
|
cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<S as TryStream>::Ok, <S as TryStream>::Error>>></h4></section></summary><div class='docblock'>Poll this <code>TryStream</code> as if it were a <code>Stream</code>. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryStreamExt-for-S" class="impl"><a href="#impl-TryStreamExt-for-S" class="anchor">§</a><h3 class="code-header">impl<S> TryStreamExt for S<div class="where">where
|
|||
|
|
S: TryStream + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.err_into" class="method trait-impl"><a href="#method.err_into" class="anchor">§</a><h4 class="code-header">fn <a class="fn">err_into</a><E>(self) -> ErrInto<Self, E><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|||
|
|
Self::Error: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><E>,</div></h4></section></summary><div class='docblock'>Wraps the current stream in a new stream which converts the error type
|
|||
|
|
into the one provided. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.map_ok" class="method trait-impl"><a href="#method.map_ok" class="anchor">§</a><h4 class="code-header">fn <a class="fn">map_ok</a><T, F>(self, f: F) -> MapOk<Self, F><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|||
|
|
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::Ok) -> T,</div></h4></section></summary><div class='docblock'>Wraps the current stream in a new stream which maps the success value
|
|||
|
|
using the provided closure. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.map_err" class="method trait-impl"><a href="#method.map_err" class="anchor">§</a><h4 class="code-header">fn <a class="fn">map_err</a><E, F>(self, f: F) -> MapErr<Self, F><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|||
|
|
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::Error) -> E,</div></h4></section></summary><div class='docblock'>Wraps the current stream in a new stream which maps the error value
|
|||
|
|
using the provided closure. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.and_then" class="method trait-impl"><a href="#method.and_then" class="anchor">§</a><h4 class="code-header">fn <a class="fn">and_then</a><Fut, F>(self, f: F) -> AndThen<Self, Fut, F><div class="where">where
|
|||
|
|
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::Ok) -> Fut,
|
|||
|
|
Fut: TryFuture<Error = Self::Error>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Chain on a computation for when a value is ready, passing the successful
|
|||
|
|
results to the provided closure <code>f</code>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.or_else" class="method trait-impl"><a href="#method.or_else" class="anchor">§</a><h4 class="code-header">fn <a class="fn">or_else</a><Fut, F>(self, f: F) -> OrElse<Self, Fut, F><div class="where">where
|
|||
|
|
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::Error) -> Fut,
|
|||
|
|
Fut: TryFuture<Ok = Self::Ok>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Chain on a computation for when an error happens, passing the
|
|||
|
|
erroneous result to the provided closure <code>f</code>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.inspect_ok" class="method trait-impl"><a href="#method.inspect_ok" class="anchor">§</a><h4 class="code-header">fn <a class="fn">inspect_ok</a><F>(self, f: F) -> InspectOk<Self, F><div class="where">where
|
|||
|
|
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::Ok),
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Do something with the success value of this stream, afterwards passing
|
|||
|
|
it on. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.inspect_err" class="method trait-impl"><a href="#method.inspect_err" class="anchor">§</a><h4 class="code-header">fn <a class="fn">inspect_err</a><F>(self, f: F) -> InspectErr<Self, F><div class="where">where
|
|||
|
|
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::Error),
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Do something with the error value of this stream, afterwards passing it on. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.into_stream" class="method trait-impl"><a href="#method.into_stream" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into_stream</a>(self) -> IntoStream<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Wraps a [<code>TryStream</code>] into a type that implements
|
|||
|
|
<a href="futures_core::stream::Stream"><code>Stream</code></a> <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_next" class="method trait-impl"><a href="#method.try_next" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_next</a>(&mut self) -> TryNext<'_, Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Creates a future that attempts to resolve the next item in the stream.
|
|||
|
|
If an error is encountered before the next item, the error is returned
|
|||
|
|
instead. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_for_each" class="method trait-impl"><a href="#method.try_for_each" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_for_each</a><Fut, F>(self, f: F) -> TryForEach<Self, Fut, F><div class="where">where
|
|||
|
|
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::Ok) -> Fut,
|
|||
|
|
Fut: TryFuture<Ok = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error = Self::Error>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Attempts to run this stream to completion, executing the provided
|
|||
|
|
asynchronous closure for each element on the stream. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_skip_while" class="method trait-impl"><a href="#method.try_skip_while" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_skip_while</a><Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F><div class="where">where
|
|||
|
|
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::Ok) -> Fut,
|
|||
|
|
Fut: TryFuture<Ok = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Error = Self::Error>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Skip elements on this stream while the provided asynchronous predicate
|
|||
|
|
resolves to <code>true</code>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_take_while" class="method trait-impl"><a href="#method.try_take_while" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_take_while</a><Fut, F>(self, f: F) -> TryTakeWhile<Self, Fut, F><div class="where">where
|
|||
|
|
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::Ok) -> Fut,
|
|||
|
|
Fut: TryFuture<Ok = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Error = Self::Error>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Take elements on this stream while the provided asynchronous predicate
|
|||
|
|
resolves to <code>true</code>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_for_each_concurrent" class="method trait-impl"><a href="#method.try_for_each_concurrent" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_for_each_concurrent</a><Fut, F>(
|
|||
|
|
self,
|
|||
|
|
limit: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>>,
|
|||
|
|
f: F
|
|||
|
|
) -> TryForEachConcurrent<Self, Fut, F><div class="where">where
|
|||
|
|
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::Ok) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <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>, Self::Error>>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>Attempts to run this stream to completion, executing the provided asynchronous
|
|||
|
|
closure for each element on the stream concurrently as elements become
|
|||
|
|
available, exiting as soon as an error occurs. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_collect" class="method trait-impl"><a href="#method.try_collect" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_collect</a><C>(self) -> TryCollect<Self, C><div class="where">where
|
|||
|
|
C: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><Self::Ok>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Attempt to transform a stream into a collection,
|
|||
|
|
returning a future representing the result of that computation. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_chunks" class="method trait-impl"><a href="#method.try_chunks" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_chunks</a>(self, capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> TryChunks<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>An adaptor for chunking up successful items of the stream inside a vector. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_ready_chunks" class="method trait-impl"><a href="#method.try_ready_chunks" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_ready_chunks</a>(self, capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> TryReadyChunks<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>An adaptor for chunking up successful, ready items of the stream inside a vector. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_filter" class="method trait-impl"><a href="#method.try_filter" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_filter</a><Fut, F>(self, f: F) -> TryFilter<Self, Fut, F><div class="where">where
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>>,
|
|||
|
|
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::Ok) -> Fut,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Attempt to filter the values produced by this stream according to the
|
|||
|
|
provided asynchronous closure. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_filter_map" class="method trait-impl"><a href="#method.try_filter_map" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_filter_map</a><Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F><div class="where">where
|
|||
|
|
Fut: TryFuture<Ok = <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T>, Error = Self::Error>,
|
|||
|
|
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::Ok) -> Fut,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Attempt to filter the values produced by this stream while
|
|||
|
|
simultaneously mapping them to a different type according to the
|
|||
|
|
provided asynchronous closure. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_flatten_unordered" class="method trait-impl"><a href="#method.try_flatten_unordered" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_flatten_unordered</a>(
|
|||
|
|
self,
|
|||
|
|
limit: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>>
|
|||
|
|
) -> TryFlattenUnordered<Self><div class="where">where
|
|||
|
|
Self::Ok: TryStream + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
|||
|
|
<Self::Ok as TryStream>::Error: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::Error>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>Flattens a stream of streams into just one continuous stream. Produced streams
|
|||
|
|
will be polled concurrently and any errors will be passed through without looking at them.
|
|||
|
|
If the underlying base stream returns an error, it will be <strong>immediately</strong> propagated. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_flatten" class="method trait-impl"><a href="#method.try_flatten" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_flatten</a>(self) -> TryFlatten<Self><div class="where">where
|
|||
|
|
Self::Ok: TryStream,
|
|||
|
|
<Self::Ok as TryStream>::Error: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::Error>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Flattens a stream of streams into just one continuous stream. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_fold" class="method trait-impl"><a href="#method.try_fold" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_fold</a><T, Fut, F>(self, init: T, f: F) -> TryFold<Self, Fut, T, F><div class="where">where
|
|||
|
|
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::Ok) -> Fut,
|
|||
|
|
Fut: TryFuture<Ok = T, Error = Self::Error>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Attempt to execute an accumulating asynchronous computation over a
|
|||
|
|
stream, collecting all the values into one final result. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_concat" class="method trait-impl"><a href="#method.try_concat" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_concat</a>(self) -> TryConcat<Self><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|||
|
|
Self::Ok: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><<Self::Ok as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></h4></section></summary><div class='docblock'>Attempt to concatenate all items of a stream into a single
|
|||
|
|
extendable destination, returning a future representing the end result. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_buffer_unordered" class="method trait-impl"><a href="#method.try_buffer_unordered" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_buffer_unordered</a>(self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> TryBufferUnordered<Self><div class="where">where
|
|||
|
|
Self::Ok: TryFuture<Error = Self::Error>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>Attempt to execute several futures from a stream concurrently (unordered). <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_buffered" class="method trait-impl"><a href="#method.try_buffered" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_buffered</a>(self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> TryBuffered<Self><div class="where">where
|
|||
|
|
Self::Ok: TryFuture<Error = Self::Error>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span><div class='docblock'>Attempt to execute several futures from a stream concurrently. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_poll_next_unpin" class="method trait-impl"><a href="#method.try_poll_next_unpin" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_poll_next_unpin</a>(
|
|||
|
|
&mut self,
|
|||
|
|
cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::Ok, Self::Error>>><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>A convenience method for calling [<code>TryStream::try_poll_next</code>] on <a href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin"><code>Unpin</code></a>
|
|||
|
|
stream types.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_all" class="method trait-impl"><a href="#method.try_all" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_all</a><Fut, F>(self, f: F) -> TryAll<Self, Fut, F><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|||
|
|
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::Ok) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>>,</div></h4></section></summary><div class='docblock'>Attempt to execute a predicate over an asynchronous stream and evaluate if all items
|
|||
|
|
satisfy the predicate. Exits early if an <code>Err</code> is encountered or if an <code>Ok</code> item is found
|
|||
|
|
that does not satisfy the predicate. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.try_any" class="method trait-impl"><a href="#method.try_any" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_any</a><Fut, F>(self, f: F) -> TryAny<Self, Fut, F><div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|||
|
|
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::Ok) -> Fut,
|
|||
|
|
Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>>,</div></h4></section></summary><div class='docblock'>Attempt to execute a predicate over an asynchronous stream and evaluate if any items
|
|||
|
|
satisfy the predicate. Exits early if an <code>Err</code> is encountered or if an <code>Ok</code> item is found
|
|||
|
|
that satisfies the predicate. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-T" class="impl"><a href="#impl-VZip%3CV%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<V, T> VZip<V> for T<div class="where">where
|
|||
|
|
V: MultiLane<T>,</div></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl"><a href="#method.vzip" class="anchor">§</a><h4 class="code-header">fn <a class="fn">vzip</a>(self) -> V</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-T" class="impl"><a href="#impl-WithSubscriber-for-T" class="anchor">§</a><h3 class="code-header">impl<T> WithSubscriber for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl"><a href="#method.with_subscriber" class="anchor">§</a><h4 class="code-header">fn <a class="fn">with_subscriber</a><S>(self, subscriber: S) -> WithDispatch<Self><div class="where">where
|
|||
|
|
S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Dispatch>,</div></h4></section></summary><div class='docblock'>Attaches the provided <a href="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
|
|||
|
|
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl"><a href="#method.with_current_subscriber" class="anchor">§</a><h4 class="code-header">fn <a class="fn">with_current_subscriber</a>(self) -> WithDispatch<Self></h4></section></summary><div class='docblock'>Attaches the current <a href="crate::dispatcher#setting-the-default-subscriber">default</a> <a href="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
|
|||
|
|
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details></div></details></div></section></div></main></body></html>
|