blob: e51692d87ac2ac45f95e8e0060551c05b9598a2a [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/stream/zip.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>zip.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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::stream::{Fuse, StreamExt};
<span class="kw">use </span>core::cmp;
<span class="kw">use </span>core::pin::Pin;
<span class="kw">use </span>futures_core::stream::{FusedStream, Stream};
<span class="kw">use </span>futures_core::task::{Context, Poll};
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project! </span>{
<span class="doccomment">/// Stream for the [`zip`](super::StreamExt::zip) 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>Zip&lt;St1: Stream, St2: Stream&gt; {
<span class="attribute">#[pin]
</span>stream1: Fuse&lt;St1&gt;,
<span class="attribute">#[pin]
</span>stream2: Fuse&lt;St2&gt;,
queued1: <span class="prelude-ty">Option</span>&lt;St1::Item&gt;,
queued2: <span class="prelude-ty">Option</span>&lt;St2::Item&gt;,
}
}
<span class="kw">impl</span>&lt;St1: Stream, St2: Stream&gt; Zip&lt;St1, St2&gt; {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(stream1: St1, stream2: St2) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{ stream1: stream1.fuse(), stream2: stream2.fuse(), queued1: <span class="prelude-val">None</span>, queued2: <span class="prelude-val">None </span>}
}
<span class="doccomment">/// Acquires a reference to the underlying streams that this combinator is
/// pulling from.
</span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (<span class="kw-2">&amp;</span>St1, <span class="kw-2">&amp;</span>St2) {
(<span class="self">self</span>.stream1.get_ref(), <span class="self">self</span>.stream2.get_ref())
}
<span class="doccomment">/// Acquires a mutable reference to the underlying streams that this
/// combinator is pulling from.
///
/// Note that care must be taken to avoid tampering with the state of the
/// stream which may otherwise confuse this combinator.
</span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; (<span class="kw-2">&amp;mut </span>St1, <span class="kw-2">&amp;mut </span>St2) {
(<span class="self">self</span>.stream1.get_mut(), <span class="self">self</span>.stream2.get_mut())
}
<span class="doccomment">/// Acquires a pinned mutable reference to the underlying streams that this
/// combinator is pulling from.
///
/// Note that care must be taken to avoid tampering with the state of the
/// stream which may otherwise confuse this combinator.
</span><span class="kw">pub fn </span>get_pin_mut(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) -&gt; (Pin&lt;<span class="kw-2">&amp;mut </span>St1&gt;, Pin&lt;<span class="kw-2">&amp;mut </span>St2&gt;) {
<span class="kw">let </span>this = <span class="self">self</span>.project();
(this.stream1.get_pin_mut(), this.stream2.get_pin_mut())
}
<span class="doccomment">/// Consumes this combinator, returning the underlying streams.
///
/// Note that this may discard intermediate state of this combinator, so
/// care should be taken to avoid losing resources when this is called.
</span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -&gt; (St1, St2) {
(<span class="self">self</span>.stream1.into_inner(), <span class="self">self</span>.stream2.into_inner())
}
}
<span class="kw">impl</span>&lt;St1, St2&gt; FusedStream <span class="kw">for </span>Zip&lt;St1, St2&gt;
<span class="kw">where
</span>St1: Stream,
St2: Stream,
{
<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>.stream1.is_terminated() &amp;&amp; <span class="self">self</span>.stream2.is_terminated()
}
}
<span class="kw">impl</span>&lt;St1, St2&gt; Stream <span class="kw">for </span>Zip&lt;St1, St2&gt;
<span class="kw">where
</span>St1: Stream,
St2: Stream,
{
<span class="kw">type </span>Item = (St1::Item, St2::Item);
<span class="kw">fn </span>poll_next(<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>.project();
<span class="kw">if </span>this.queued1.is_none() {
<span class="kw">match </span>this.stream1.as_mut().poll_next(cx) {
Poll::Ready(<span class="prelude-val">Some</span>(item1)) =&gt; <span class="kw-2">*</span>this.queued1 = <span class="prelude-val">Some</span>(item1),
Poll::Ready(<span class="prelude-val">None</span>) | Poll::Pending =&gt; {}
}
}
<span class="kw">if </span>this.queued2.is_none() {
<span class="kw">match </span>this.stream2.as_mut().poll_next(cx) {
Poll::Ready(<span class="prelude-val">Some</span>(item2)) =&gt; <span class="kw-2">*</span>this.queued2 = <span class="prelude-val">Some</span>(item2),
Poll::Ready(<span class="prelude-val">None</span>) | Poll::Pending =&gt; {}
}
}
<span class="kw">if </span>this.queued1.is_some() &amp;&amp; this.queued2.is_some() {
<span class="kw">let </span>pair = (this.queued1.take().unwrap(), this.queued2.take().unwrap());
Poll::Ready(<span class="prelude-val">Some</span>(pair))
} <span class="kw">else if </span>this.stream1.is_done() || this.stream2.is_done() {
Poll::Ready(<span class="prelude-val">None</span>)
} <span class="kw">else </span>{
Poll::Pending
}
}
<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>queued1_len = usize::from(<span class="self">self</span>.queued1.is_some());
<span class="kw">let </span>queued2_len = usize::from(<span class="self">self</span>.queued2.is_some());
<span class="kw">let </span>(stream1_lower, stream1_upper) = <span class="self">self</span>.stream1.size_hint();
<span class="kw">let </span>(stream2_lower, stream2_upper) = <span class="self">self</span>.stream2.size_hint();
<span class="kw">let </span>stream1_lower = stream1_lower.saturating_add(queued1_len);
<span class="kw">let </span>stream2_lower = stream2_lower.saturating_add(queued2_len);
<span class="kw">let </span>lower = cmp::min(stream1_lower, stream2_lower);
<span class="kw">let </span>upper = <span class="kw">match </span>(stream1_upper, stream2_upper) {
(<span class="prelude-val">Some</span>(x), <span class="prelude-val">Some</span>(y)) =&gt; {
<span class="kw">let </span>x = x.saturating_add(queued1_len);
<span class="kw">let </span>y = y.saturating_add(queued2_len);
<span class="prelude-val">Some</span>(cmp::min(x, y))
}
(<span class="prelude-val">Some</span>(x), <span class="prelude-val">None</span>) =&gt; x.checked_add(queued1_len),
(<span class="prelude-val">None</span>, <span class="prelude-val">Some</span>(y)) =&gt; y.checked_add(queued2_len),
(<span class="prelude-val">None</span>, <span class="prelude-val">None</span>) =&gt; <span class="prelude-val">None</span>,
};
(lower, upper)
}
}
</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>