blob: b7707ba8423caf84d76f13170d47aae20c5a7266 [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/itertools-0.10.5/src/ziptuple.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ziptuple.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="../../itertools/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="../../itertools/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>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::size_hint;
<span class="doccomment">/// See [`multizip`] for more information.
</span><span class="attribute">#[derive(Clone, Debug)]
#[must_use = <span class="string">&quot;iterator adaptors are lazy and do nothing unless consumed&quot;</span>]
</span><span class="kw">pub struct </span>Zip&lt;T&gt; {
t: T,
}
<span class="doccomment">/// An iterator that generalizes *.zip()* and allows running multiple iterators in lockstep.
///
/// The iterator `Zip&lt;(I, J, ..., M)&gt;` is formed from a tuple of iterators (or values that
/// implement [`IntoIterator`]) and yields elements
/// until any of the subiterators yields `None`.
///
/// The iterator element type is a tuple like like `(A, B, ..., E)` where `A` to `E` are the
/// element types of the subiterator.
///
/// **Note:** The result of this macro is a value of a named type (`Zip&lt;(I, J,
/// ..)&gt;` of each component iterator `I, J, ...`) if each component iterator is
/// nameable.
///
/// Prefer [`izip!()`] over `multizip` for the performance benefits of using the
/// standard library `.zip()`. Prefer `multizip` if a nameable type is needed.
///
/// ```
/// use itertools::multizip;
///
/// // iterate over three sequences side-by-side
/// let mut results = [0, 0, 0, 0];
/// let inputs = [3, 7, 9, 6];
///
/// for (r, index, input) in multizip((&amp;mut results, 0..10, &amp;inputs)) {
/// *r = index * 10 + input;
/// }
///
/// assert_eq!(results, [0 + 3, 10 + 7, 29, 36]);
/// ```
/// [`izip!()`]: crate::izip
</span><span class="kw">pub fn </span>multizip&lt;T, U&gt;(t: U) -&gt; Zip&lt;T&gt;
<span class="kw">where </span>Zip&lt;T&gt;: From&lt;U&gt;,
Zip&lt;T&gt;: Iterator,
{
Zip::from(t)
}
<span class="macro">macro_rules! </span>impl_zip_iter {
($(<span class="macro-nonterminal">$B</span>:ident),<span class="kw-2">*</span>) =&gt; (
<span class="attribute">#[allow(non_snake_case)]
</span><span class="kw">impl</span>&lt;$(<span class="macro-nonterminal">$B</span>: IntoIterator),<span class="kw-2">*</span>&gt; From&lt;($(<span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</span>)&gt; <span class="kw">for </span>Zip&lt;($(<span class="macro-nonterminal">$B::IntoIter</span>,)<span class="kw-2">*</span>)&gt; {
<span class="kw">fn </span>from(t: ($(<span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</span>)) -&gt; <span class="self">Self </span>{
<span class="kw">let </span>($(<span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</span>) = t;
Zip { t: ($(<span class="macro-nonterminal">$B</span>.into_iter(),)<span class="kw-2">*</span>) }
}
}
<span class="attribute">#[allow(non_snake_case)]
#[allow(unused_assignments)]
</span><span class="kw">impl</span>&lt;$(<span class="macro-nonterminal">$B</span>),<span class="kw-2">*</span>&gt; Iterator <span class="kw">for </span>Zip&lt;($(<span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</span>)&gt;
<span class="kw">where
</span>$(
<span class="macro-nonterminal">$B</span>: Iterator,
)*
{
<span class="kw">type </span>Item = ($(<span class="macro-nonterminal">$B::Item</span>,)<span class="kw-2">*</span>);
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt;
{
<span class="kw">let </span>($(<span class="kw-2">ref mut </span><span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</span>) = <span class="self">self</span>.t;
<span class="comment">// NOTE: Just like iter::Zip, we check the iterators
// for None in order. We may finish unevenly (some
// iterators gave n + 1 elements, some only n).
</span>$(
<span class="kw">let </span><span class="macro-nonterminal">$B </span>= <span class="kw">match </span><span class="macro-nonterminal">$B</span>.next() {
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">None</span>,
<span class="prelude-val">Some</span>(elt) =&gt; elt
};
)*
<span class="prelude-val">Some</span>(($(<span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</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>sh = (::std::usize::MAX, <span class="prelude-val">None</span>);
<span class="kw">let </span>($(<span class="kw-2">ref </span><span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</span>) = <span class="self">self</span>.t;
$(
<span class="kw">let </span>sh = size_hint::min(<span class="macro-nonterminal">$B</span>.size_hint(), sh);
)*
sh
}
}
<span class="attribute">#[allow(non_snake_case)]
</span><span class="kw">impl</span>&lt;$(<span class="macro-nonterminal">$B</span>),<span class="kw-2">*</span>&gt; ExactSizeIterator <span class="kw">for </span>Zip&lt;($(<span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</span>)&gt; <span class="kw">where
</span>$(
<span class="macro-nonterminal">$B</span>: ExactSizeIterator,
)*
{ }
<span class="attribute">#[allow(non_snake_case)]
</span><span class="kw">impl</span>&lt;$(<span class="macro-nonterminal">$B</span>),<span class="kw-2">*</span>&gt; DoubleEndedIterator <span class="kw">for </span>Zip&lt;($(<span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</span>)&gt; <span class="kw">where
</span>$(
<span class="macro-nonterminal">$B</span>: DoubleEndedIterator + ExactSizeIterator,
)*
{
<span class="attribute">#[inline]
</span><span class="kw">fn </span>next_back(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt; {
<span class="kw">let </span>($(<span class="kw-2">ref mut </span><span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</span>) = <span class="self">self</span>.t;
<span class="kw">let </span>size = <span class="kw-2">*</span>[$( <span class="macro-nonterminal">$B</span>.len(), )<span class="kw-2">*</span>].iter().min().unwrap();
$(
<span class="kw">if </span><span class="macro-nonterminal">$B</span>.len() != size {
<span class="kw">for _ in </span><span class="number">0</span>..<span class="macro-nonterminal">$B</span>.len() - size { <span class="macro-nonterminal">$B</span>.next_back(); }
}
)*
<span class="kw">match </span>($(<span class="macro-nonterminal">$B</span>.next_back(),)<span class="kw-2">*</span>) {
($(<span class="prelude-val">Some</span>(<span class="macro-nonterminal">$B</span>),)<span class="kw-2">*</span>) =&gt; <span class="prelude-val">Some</span>(($(<span class="macro-nonterminal">$B</span>,)<span class="kw-2">*</span>)),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
}
);
}
<span class="macro">impl_zip_iter!</span>(A);
<span class="macro">impl_zip_iter!</span>(A, B);
<span class="macro">impl_zip_iter!</span>(A, B, C);
<span class="macro">impl_zip_iter!</span>(A, B, C, D);
<span class="macro">impl_zip_iter!</span>(A, B, C, D, E);
<span class="macro">impl_zip_iter!</span>(A, B, C, D, E, F);
<span class="macro">impl_zip_iter!</span>(A, B, C, D, E, F, G);
<span class="macro">impl_zip_iter!</span>(A, B, C, D, E, F, G, H);
<span class="macro">impl_zip_iter!</span>(A, B, C, D, E, F, G, H, I);
<span class="macro">impl_zip_iter!</span>(A, B, C, D, E, F, G, H, I, J);
<span class="macro">impl_zip_iter!</span>(A, B, C, D, E, F, G, H, I, J, K);
<span class="macro">impl_zip_iter!</span>(A, B, C, D, E, F, G, H, I, J, K, L);
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="itertools" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>