Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Adapters specific to `Result`-returning streams"><meta name="keywords" content="rust, rustlang, rust-lang, TryStreamExt"><title>futures_util::stream::TryStreamExt - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `TryStreamExt` trait in crate `futures_util`."><meta name="keywords" content="rust, rustlang, rust-lang, TryStreamExt"><title>futures_util::stream::TryStreamExt - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../futures_util/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait TryStreamExt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.and_then">and_then</a><a href="#method.into_stream">into_stream</a><a href="#method.try_flatten">try_flatten</a><a href="#method.map_ok">map_ok</a><a href="#method.map_err">map_err</a><a href="#method.err_into">err_into</a><a href="#method.or_else">or_else</a><a href="#method.inspect_ok">inspect_ok</a><a href="#method.inspect_err">inspect_err</a><a href="#method.try_next">try_next</a><a href="#method.try_for_each">try_for_each</a><a href="#method.try_filter">try_filter</a><a href="#method.try_filter_map">try_filter_map</a><a href="#method.try_collect">try_collect</a><a href="#method.try_concat">try_concat</a><a href="#method.try_fold">try_fold</a><a href="#method.try_skip_while">try_skip_while</a><a href="#method.try_take_while">try_take_while</a><a href="#method.try_poll_next_unpin">try_poll_next_unpin</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">futures_util</a>::<wbr><a href="index.html">stream</a></p><div id="sidebar-vars" data-name="TryStreamExt" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">futures_util</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="trait" href="">TryStreamExt</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/futures_util/stream/try_stream/mod.rs.html#144-1002" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait TryStreamExt: <a class="trait" href="../../futures_util/stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a> {
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../futures_util/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait TryStreamExt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.and_then">and_then</a><a href="#method.err_into">err_into</a><a href="#method.inspect_err">inspect_err</a><a href="#method.inspect_ok">inspect_ok</a><a href="#method.into_stream">into_stream</a><a href="#method.map_err">map_err</a><a href="#method.map_ok">map_ok</a><a href="#method.or_else">or_else</a><a href="#method.try_collect">try_collect</a><a href="#method.try_concat">try_concat</a><a href="#method.try_filter">try_filter</a><a href="#method.try_filter_map">try_filter_map</a><a href="#method.try_flatten">try_flatten</a><a href="#method.try_fold">try_fold</a><a href="#method.try_for_each">try_for_each</a><a href="#method.try_next">try_next</a><a href="#method.try_poll_next_unpin">try_poll_next_unpin</a><a href="#method.try_skip_while">try_skip_while</a><a href="#method.try_take_while">try_take_while</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">futures_util</a>::<wbr><a href="index.html">stream</a></p><script>window.sidebarCurrent = {name: "TryStreamExt", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/futures_util/stream/try_stream/mod.rs.html#144-1002" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">futures_util</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="trait" href="">TryStreamExt</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait TryStreamExt: <a class="trait" href="../../futures_util/stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a> {
|
||||
fn <a href="#method.err_into" class="fnname">err_into</a><E>(self) -> <a class="struct" href="../../futures_util/stream/struct.ErrInto.html" title="struct futures_util::stream::ErrInto">ErrInto</a><Self, E><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> Self::<a class="type" href="../../futures_util/stream/trait.TryStream.html#associatedtype.Error" title="type futures_util::stream::TryStream::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><E></span>,
|
||||
{ ... }
|
||||
<div class="item-spacer"></div> fn <a href="#method.map_ok" class="fnname">map_ok</a><T, F>(self, f: F) -> <a class="struct" href="../../futures_util/stream/struct.MapOk.html" title="struct futures_util::stream::MapOk">MapOk</a><Self, F><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../../futures_util/stream/trait.TryStream.html#associatedtype.Ok" title="type futures_util::stream::TryStream::Ok">Ok</a>) -> T</span>,
|
||||
@@ -124,11 +124,11 @@ wrapped version of it.</p>
|
||||
it on.</p>
|
||||
<p>This is similar to the <code>StreamExt::inspect</code> method where it allows
|
||||
easily inspecting the success value as it passes through the stream, for
|
||||
example to debug what’s going on.</p>
|
||||
example to debug what's going on.</p>
|
||||
</div><h3 id="method.inspect_err" class="method"><code>fn <a href="#method.inspect_err" class="fnname">inspect_err</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/stream/struct.InspectErr.html" title="struct futures_util::stream::InspectErr">InspectErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../../futures_util/stream/trait.TryStream.html#associatedtype.Error" title="type futures_util::stream::TryStream::Error">Error</a>),<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a class="srclink" href="../../src/futures_util/stream/try_stream/mod.rs.html#312-318" title="goto source code">[src]</a></h3><div class="docblock"><p>Do something with the error value of this stream, afterwards passing it on.</p>
|
||||
<p>This is similar to the <code>StreamExt::inspect</code> method where it allows
|
||||
easily inspecting the error value as it passes through the stream, for
|
||||
example to debug what’s going on.</p>
|
||||
example to debug what's going on.</p>
|
||||
</div><h3 id="method.into_stream" class="method"><code>fn <a href="#method.into_stream" class="fnname">into_stream</a>(self) -> <a class="struct" href="../../futures_util/stream/struct.IntoStream.html" title="struct futures_util::stream::IntoStream">IntoStream</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a class="srclink" href="../../src/futures_util/stream/try_stream/mod.rs.html#341-346" title="goto source code">[src]</a></h3><div class="docblock"><p>Wraps a <a href="../../futures_util/stream/trait.TryStream.html" title="TryStream"><code>TryStream</code></a> into a type that implements
|
||||
<a href="../../futures_util/stream/trait.Stream.html"><code>Stream</code></a></p>
|
||||
<p><a href="../../futures_util/stream/trait.TryStream.html" title="TryStream"><code>TryStream</code></a>s currently do not implement the
|
||||
@@ -284,7 +284,7 @@ the standard library.</p>
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">halves</span>.<span class="ident">next</span>().<span class="kw">await</span>, <span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(<span class="number">3</span>)));
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">halves</span>.<span class="ident">next</span>().<span class="kw">await</span>, <span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(<span class="string">"error"</span>)));</pre></div>
|
||||
</div><h3 id="method.try_flatten" class="method"><code>fn <a href="#method.try_flatten" class="fnname">try_flatten</a>(self) -> <a class="struct" href="../../futures_util/stream/struct.TryFlatten.html" title="struct futures_util::stream::TryFlatten">TryFlatten</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_util/stream/trait.TryStream.html#associatedtype.Ok" title="type futures_util::stream::TryStream::Ok">Ok</a>: <a class="trait" href="../../futures_util/stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a>,<br> <Self::<a class="type" href="../../futures_util/stream/trait.TryStream.html#associatedtype.Ok" title="type futures_util::stream::TryStream::Ok">Ok</a> as <a class="trait" href="../../futures_util/stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a>>::<a class="type" href="../../futures_util/stream/trait.TryStream.html#associatedtype.Error" title="type futures_util::stream::TryStream::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<a class="type" href="../../futures_util/stream/trait.TryStream.html#associatedtype.Error" title="type futures_util::stream::TryStream::Error">Error</a>>,<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a class="srclink" href="../../src/futures_util/stream/try_stream/mod.rs.html#692-701" title="goto source code">[src]</a></h3><div class="docblock"><p>Flattens a stream of streams into just one continuous stream.</p>
|
||||
<p>If this stream’s elements are themselves streams then this combinator
|
||||
<p>If this stream's elements are themselves streams then this combinator
|
||||
will flatten out the entire stream to one long chain of elements. Any
|
||||
errors are passed through without looking at them, but otherwise each
|
||||
individual stream will get exhausted before moving on to the next.</p>
|
||||
@@ -364,5 +364,4 @@ exit early if an error is encountered in the stream.</p>
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>, <span class="prelude-val">Ok</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]));</pre></div>
|
||||
</div><h3 id="method.try_poll_next_unpin" class="method"><code>fn <a href="#method.try_poll_next_unpin" class="fnname">try_poll_next_unpin</a>(<br> &mut self, <br> 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><'_><br>) -> <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::<a class="type" href="../../futures_util/stream/trait.TryStream.html#associatedtype.Ok" title="type futures_util::stream::TryStream::Ok">Ok</a>, Self::<a class="type" href="../../futures_util/stream/trait.TryStream.html#associatedtype.Error" title="type futures_util::stream::TryStream::Error">Error</a>>>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a class="srclink" href="../../src/futures_util/stream/try_stream/mod.rs.html#929-937" title="goto source code">[src]</a></h3><div class="docblock"><p>A convenience method for calling <a href="../../futures_util/stream/trait.TryStream.html#tymethod.try_poll_next" title="TryStream::try_poll_next"><code>TryStream::try_poll_next</code></a> on <a href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="Unpin"><code>Unpin</code></a>
|
||||
stream types.</p>
|
||||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-TryStreamExt" class="impl"><code class="in-band">impl<S: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../futures_util/stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a>> <a class="trait" href="../../futures_util/stream/trait.TryStreamExt.html" title="trait futures_util::stream::TryStreamExt">TryStreamExt</a> for S</code><a href="#impl-TryStreamExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/stream/try_stream/mod.rs.html#141" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/futures_util/stream/trait.TryStreamExt.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures_util"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-TryStreamExt" class="impl"><code class="in-band">impl<S: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../futures_util/stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a>> TryStreamExt for S</code><a href="#impl-TryStreamExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/stream/try_stream/mod.rs.html#141" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/futures_util/stream/trait.TryStreamExt.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "futures_util";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
Reference in New Issue
Block a user