blob: c0c304fbe21b340d50ec391c2ff68fff11c04f98 [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/futures-util-0.3.28/src/stream/try_stream/try_chunks.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>try_chunks.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../../normalize.css"><link rel="stylesheet" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../../ayu.css" disabled><link rel="stylesheet" href="../../../../dark.css" disabled><link rel="stylesheet" href="../../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../../storage.js"></script><script defer src="../../../../source-script.js"></script><script defer src="../../../../source-files.js"></script><script defer src="../../../../main.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../futures_util/index.html"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::stream::{Fuse, IntoStream, StreamExt};
<span class="kw">use </span>alloc::vec::Vec;
<span class="kw">use </span>core::pin::Pin;
<span class="kw">use </span>core::{fmt, mem};
<span class="kw">use </span>futures_core::ready;
<span class="kw">use </span>futures_core::stream::{FusedStream, Stream, TryStream};
<span class="kw">use </span>futures_core::task::{Context, Poll};
<span class="attribute">#[cfg(feature = <span class="string">&quot;sink&quot;</span>)]
</span><span class="kw">use </span>futures_sink::Sink;
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project! </span>{
<span class="doccomment">/// Stream for the [`try_chunks`](super::TryStreamExt::try_chunks) method.
</span><span class="attribute">#[derive(Debug)]
#[must_use = <span class="string">&quot;streams do nothing unless polled&quot;</span>]
</span><span class="kw">pub struct </span>TryChunks&lt;St: TryStream&gt; {
<span class="attribute">#[pin]
</span>stream: Fuse&lt;IntoStream&lt;St&gt;&gt;,
items: Vec&lt;St::Ok&gt;,
cap: usize, <span class="comment">// https://github.com/rust-lang/futures-rs/issues/1475
</span>}
}
<span class="kw">impl</span>&lt;St: TryStream&gt; TryChunks&lt;St&gt; {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(stream: St, capacity: usize) -&gt; <span class="self">Self </span>{
<span class="macro">assert!</span>(capacity &gt; <span class="number">0</span>);
<span class="self">Self </span>{
stream: IntoStream::new(stream).fuse(),
items: Vec::with_capacity(capacity),
cap: capacity,
}
}
<span class="kw">fn </span>take(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) -&gt; Vec&lt;St::Ok&gt; {
<span class="kw">let </span>cap = <span class="self">self</span>.cap;
mem::replace(<span class="self">self</span>.project().items, Vec::with_capacity(cap))
}
<span class="macro">delegate_access_inner!</span>(stream, St, (. .));
}
<span class="kw">type </span>TryChunksStreamError&lt;St&gt; = TryChunksError&lt;&lt;St <span class="kw">as </span>TryStream&gt;::Ok, &lt;St <span class="kw">as </span>TryStream&gt;::Error&gt;;
<span class="kw">impl</span>&lt;St: TryStream&gt; Stream <span class="kw">for </span>TryChunks&lt;St&gt; {
<span class="kw">type </span>Item = <span class="prelude-ty">Result</span>&lt;Vec&lt;St::Ok&gt;, TryChunksStreamError&lt;St&gt;&gt;;
<span class="kw">fn </span>poll_next(<span class="kw-2">mut </span><span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>this = <span class="self">self</span>.as_mut().project();
<span class="kw">loop </span>{
<span class="kw">match </span><span class="macro">ready!</span>(this.stream.as_mut().try_poll_next(cx)) {
<span class="comment">// Push the item into the buffer and check whether it is full.
// If so, replace our buffer with a new and empty one and return
// the full one.
</span><span class="prelude-val">Some</span>(item) =&gt; <span class="kw">match </span>item {
<span class="prelude-val">Ok</span>(item) =&gt; {
this.items.push(item);
<span class="kw">if </span>this.items.len() &gt;= <span class="kw-2">*</span>this.cap {
<span class="kw">return </span>Poll::Ready(<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(<span class="self">self</span>.take())));
}
}
<span class="prelude-val">Err</span>(e) =&gt; {
<span class="kw">return </span>Poll::Ready(<span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(TryChunksError(<span class="self">self</span>.take(), e))));
}
},
<span class="comment">// Since the underlying stream ran out of values, return what we
// have buffered, if we have anything.
</span><span class="prelude-val">None </span>=&gt; {
<span class="kw">let </span>last = <span class="kw">if </span>this.items.is_empty() {
<span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="kw">let </span>full_buf = mem::take(this.items);
<span class="prelude-val">Some</span>(full_buf)
};
<span class="kw">return </span>Poll::Ready(last.map(<span class="prelude-val">Ok</span>));
}
}
}
}
<span class="kw">fn </span>size_hint(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (usize, <span class="prelude-ty">Option</span>&lt;usize&gt;) {
<span class="kw">let </span>chunk_len = usize::from(!<span class="self">self</span>.items.is_empty());
<span class="kw">let </span>(lower, upper) = <span class="self">self</span>.stream.size_hint();
<span class="kw">let </span>lower = (lower / <span class="self">self</span>.cap).saturating_add(chunk_len);
<span class="kw">let </span>upper = <span class="kw">match </span>upper {
<span class="prelude-val">Some</span>(x) =&gt; x.checked_add(chunk_len),
<span class="prelude-val">None </span>=&gt; <span class="prelude-val">None</span>,
};
(lower, upper)
}
}
<span class="kw">impl</span>&lt;St: TryStream + FusedStream&gt; FusedStream <span class="kw">for </span>TryChunks&lt;St&gt; {
<span class="kw">fn </span>is_terminated(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.stream.is_terminated() &amp;&amp; <span class="self">self</span>.items.is_empty()
}
}
<span class="comment">// Forwarding impl of Sink from the underlying stream
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;sink&quot;</span>)]
</span><span class="kw">impl</span>&lt;S, Item&gt; Sink&lt;Item&gt; <span class="kw">for </span>TryChunks&lt;S&gt;
<span class="kw">where
</span>S: TryStream + Sink&lt;Item&gt;,
{
<span class="kw">type </span>Error = &lt;S <span class="kw">as </span>Sink&lt;Item&gt;&gt;::Error;
<span class="macro">delegate_sink!</span>(stream, Item);
}
<span class="doccomment">/// Error indicating, that while chunk was collected inner stream produced an error.
///
/// Contains all items that were collected before an error occurred, and the stream error itself.
</span><span class="attribute">#[derive(PartialEq, Eq)]
</span><span class="kw">pub struct </span>TryChunksError&lt;T, E&gt;(<span class="kw">pub </span>Vec&lt;T&gt;, <span class="kw">pub </span>E);
<span class="kw">impl</span>&lt;T, E: fmt::Debug&gt; fmt::Debug <span class="kw">for </span>TryChunksError&lt;T, E&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
<span class="self">self</span>.<span class="number">1</span>.fmt(f)
}
}
<span class="kw">impl</span>&lt;T, E: fmt::Display&gt; fmt::Display <span class="kw">for </span>TryChunksError&lt;T, E&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
<span class="self">self</span>.<span class="number">1</span>.fmt(f)
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">impl</span>&lt;T, E: fmt::Debug + fmt::Display&gt; std::error::Error <span class="kw">for </span>TryChunksError&lt;T, E&gt; {}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>