<!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 `/home/sangenya/.cargo/registry/src/github.com-1ecc6299db9ec823/itertools-0.7.11/src/ziptuple.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ziptuple.rs - source</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><script src="../../crates.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 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"><div class="sidebar-menu" role="button">☰</div><a href='../../itertools/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><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" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><pre class="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>
</pre><pre class="rust">
<span class="kw">use</span> <span class="kw">super</span><span class="ident">::size_hint</span>;
<span class="doccomment">/// See [`multizip`](../fn.multizip.html) for more information.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"iterator adaptors are lazy and do nothing unless consumed"</span>]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Zip</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">t</span>: <span class="ident">T</span>,
}
<span class="doccomment">/// An iterator that generalizes *.zip()* and allows running multiple iterators in lockstep.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The iterator `Zip<(I, J, ..., M)>` is formed from a tuple of iterators (or values that</span>
<span class="doccomment">/// implement `IntoIterator`) and yields elements</span>
<span class="doccomment">/// until any of the subiterators yields `None`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The iterator element type is a tuple like like `(A, B, ..., E)` where `A` to `E` are the</span>
<span class="doccomment">/// element types of the subiterator.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Note:** The result of this macro is a value of a named type (`Zip<(I, J,</span>
<span class="doccomment">/// ..)>` of each component iterator `I, J, ...`) if each component iterator is</span>
<span class="doccomment">/// nameable.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Prefer [`izip!()`] over `multizip` for the performance benefits of using the</span>
<span class="doccomment">/// standard library `.zip()`. Prefer `multizip` if a nameable type is needed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`izip!()`]: macro.izip.html</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use itertools::multizip;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // iterate over three sequences side-by-side</span>
<span class="doccomment">/// let mut results = [0, 0, 0, 0];</span>
<span class="doccomment">/// let inputs = [3, 7, 9, 6];</span>
<span class="doccomment">///</span>
<span class="doccomment">/// for (r, index, input) in multizip((&mut results, 0..10, &inputs)) {</span>
<span class="doccomment">/// *r = index * 10 + input;</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(results, [0 + 3, 10 + 7, 29, 36]);</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">multizip</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span>(<span class="ident">t</span>: <span class="ident">U</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Zip</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Zip</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>: <span class="ident">From</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>,
<span class="ident">Zip</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>: <span class="ident">Iterator</span>,
{
<span class="ident">Zip::from</span>(<span class="ident">t</span>)
}
<span class="macro">macro_rules!</span> <span class="ident">impl_zip_iter</span> {
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>:<span class="ident">ident</span>),<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> (
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_snake_case</span>)]</span>
<span class="kw">impl</span><span class="op"><</span>$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>: <span class="ident">IntoIterator</span>),<span class="kw-2">*</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>,)<span class="kw-2">*</span>)<span class="op">></span> <span class="kw">for</span> <span class="ident">Zip</span><span class="op"><</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B::IntoIter</span>,)<span class="kw-2">*</span>)<span class="op">></span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">t</span>: ($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>,)<span class="kw-2">*</span>)) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="kw">let</span> ($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>,)<span class="kw-2">*</span>) <span class="op">=</span> <span class="ident">t</span>;
<span class="ident">Zip</span> { <span class="ident">t</span>: ($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>.<span class="ident">into_iter</span>(),)<span class="kw-2">*</span>) }
}
}
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_snake_case</span>)]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_assignments</span>)]</span>
<span class="kw">impl</span><span class="op"><</span>$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>),<span class="kw-2">*</span><span class="op">></span> <span class="ident">Iterator</span> <span class="kw">for</span> <span class="ident">Zip</span><span class="op"><</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>,)<span class="kw-2">*</span>)<span class="op">></span>
<span class="kw">where</span>
$(
<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>: <span class="ident">Iterator</span>,
)<span class="op">*</span>
{
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> ($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B::Item</span>,)<span class="kw-2">*</span>);
<span class="kw">fn</span> <span class="ident">next</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="ident">::Item</span><span class="op">></span>
{
<span class="kw">let</span> ($(<span class="kw-2">ref</span> <span class="kw-2">mut</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>,)<span class="kw-2">*</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">t</span>;
<span class="comment">// NOTE: Just like iter::Zip, we check the iterators</span>
<span class="comment">// for None in order. We may finish unevenly (some</span>
<span class="comment">// iterators gave n + 1 elements, some only n).</span>
$(
<span class="kw">let</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span> <span class="op">=</span> <span class="kw">match</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>.<span class="ident">next</span>() {
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="prelude-val">None</span>,
<span class="prelude-val">Some</span>(<span class="ident">elt</span>) <span class="op">=</span><span class="op">></span> <span class="ident">elt</span>
};
)<span class="op">*</span>
<span class="prelude-val">Some</span>(($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>,)<span class="kw-2">*</span>))
}
<span class="kw">fn</span> <span class="ident">size_hint</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">usize</span>, <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>)
{
<span class="kw">let</span> <span class="ident">sh</span> <span class="op">=</span> (<span class="ident">::std::usize::MAX</span>, <span class="prelude-val">None</span>);
<span class="kw">let</span> ($(<span class="kw-2">ref</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>,)<span class="kw-2">*</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">t</span>;
$(
<span class="kw">let</span> <span class="ident">sh</span> <span class="op">=</span> <span class="ident">size_hint::min</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>.<span class="ident">size_hint</span>(), <span class="ident">sh</span>);
)<span class="op">*</span>
<span class="ident">sh</span>
}
}
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_snake_case</span>)]</span>
<span class="kw">impl</span><span class="op"><</span>$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>),<span class="kw-2">*</span><span class="op">></span> <span class="ident">ExactSizeIterator</span> <span class="kw">for</span> <span class="ident">Zip</span><span class="op"><</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>,)<span class="kw-2">*</span>)<span class="op">></span> <span class="kw">where</span>
$(
<span class="macro-nonterminal">$</span><span class="macro-nonterminal">B</span>: <span class="ident">ExactSizeIterator</span>,
)<span class="op">*</span>
{ }
);
}
<span class="macro">impl_zip_iter!</span>(<span class="ident">A</span>);
<span class="macro">impl_zip_iter!</span>(<span class="ident">A</span>, <span class="ident">B</span>);
<span class="macro">impl_zip_iter!</span>(<span class="ident">A</span>, <span class="ident">B</span>, <span class="ident">C</span>);
<span class="macro">impl_zip_iter!</span>(<span class="ident">A</span>, <span class="ident">B</span>, <span class="ident">C</span>, <span class="ident">D</span>);
<span class="macro">impl_zip_iter!</span>(<span class="ident">A</span>, <span class="ident">B</span>, <span class="ident">C</span>, <span class="ident">D</span>, <span class="ident">E</span>);
<span class="macro">impl_zip_iter!</span>(<span class="ident">A</span>, <span class="ident">B</span>, <span class="ident">C</span>, <span class="ident">D</span>, <span class="ident">E</span>, <span class="ident">F</span>);
<span class="macro">impl_zip_iter!</span>(<span class="ident">A</span>, <span class="ident">B</span>, <span class="ident">C</span>, <span class="ident">D</span>, <span class="ident">E</span>, <span class="ident">F</span>, <span class="ident">G</span>);
<span class="macro">impl_zip_iter!</span>(<span class="ident">A</span>, <span class="ident">B</span>, <span class="ident">C</span>, <span class="ident">D</span>, <span class="ident">E</span>, <span class="ident">F</span>, <span class="ident">G</span>, <span class="ident">H</span>);
</pre></div>
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="itertools" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>