| <!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="Create an iterator running multiple iterators in lockstep."><meta name="keywords" content="rust, rustlang, rust-lang, izip"><title>izip in itertools - Rust</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="sidebar-items.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 macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../itertools/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><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><div class="sidebar-elems"><h2><a href="index.html">In itertools</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Macro <a href="index.html">itertools</a>::<wbr><a class="macro" href="#">izip</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/itertools/lib.rs.html#293-327">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules! </span>izip { |
| ( @closure <span class="macro-nonterminal">$p</span>:pat => <span class="macro-nonterminal">$tup</span>:expr ) => { ... }; |
| ( @closure <span class="macro-nonterminal">$p</span>:pat => ( $(<span class="macro-nonterminal">$tup</span>:tt)* ) , <span class="macro-nonterminal">$_iter</span>:expr $( , <span class="macro-nonterminal">$tail</span>:expr )* ) => { ... }; |
| (<span class="macro-nonterminal">$first</span>:expr $(,)<span class="kw-2">*</span>) => { ... }; |
| (<span class="macro-nonterminal">$first</span>:expr, <span class="macro-nonterminal">$second</span>:expr $(,)<span class="kw-2">*</span>) => { ... }; |
| ( <span class="macro-nonterminal">$first</span>:expr $( , <span class="macro-nonterminal">$rest</span>:expr )* $(,)* ) => { ... }; |
| }</code></pre></div> |
| </div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create an iterator running multiple iterators in lockstep.</p> |
| <p>The <code>izip!</code> iterator yields elements until any subiterator |
| returns <code>None</code>.</p> |
| <p>This is a version of the standard <code>.zip()</code> that’s supporting more than |
| two iterators. The iterator element type is a tuple with one element |
| from each of the input iterators. Just like <code>.zip()</code>, the iteration stops |
| when the shortest of the inputs reaches its end.</p> |
| <p><strong>Note:</strong> The result of this macro is in the general case an iterator |
| composed of repeated <code>.zip()</code> and a <code>.map()</code>; it has an anonymous type. |
| The special cases of one and two arguments produce the equivalent of |
| <code>$a.into_iter()</code> and <code>$a.into_iter().zip($b)</code> respectively.</p> |
| <p>Prefer this macro <code>izip!()</code> over <a href="fn.multizip.html"><code>multizip</code></a> for the performance benefits |
| of using the standard library <code>.zip()</code>.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attribute">#[macro_use] </span><span class="kw">extern crate </span>itertools; |
| |
| <span class="comment">// iterate over three sequences side-by-side |
| </span><span class="kw">let </span><span class="kw-2">mut </span>results = [<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]; |
| <span class="kw">let </span>inputs = [<span class="number">3</span>, <span class="number">7</span>, <span class="number">9</span>, <span class="number">6</span>]; |
| |
| <span class="kw">for </span>(r, index, input) <span class="kw">in </span><span class="macro">izip!</span>(<span class="kw-2">&mut </span>results, <span class="number">0</span>..<span class="number">10</span>, <span class="kw-2">&</span>inputs) { |
| <span class="kw-2">*</span>r = index * <span class="number">10 </span>+ input; |
| } |
| |
| <span class="macro">assert_eq!</span>(results, [<span class="number">0 </span>+ <span class="number">3</span>, <span class="number">10 </span>+ <span class="number">7</span>, <span class="number">29</span>, <span class="number">36</span>]);</code></pre></div> |
| <p><strong>Note:</strong> To enable the macros in this crate, use the <code>#[macro_use]</code> |
| attribute when importing the crate:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attribute">#[macro_use] </span><span class="kw">extern crate </span>itertools;</code></pre></div> |
| </div></details></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> |
