162 lines
8.8 KiB
HTML
162 lines
8.8 KiB
HTML
|
<!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="API documentation for the Rust `izip` macro in crate `itertools`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, izip">
|
|||
|
|
|
|||
|
|
<title>itertools::izip - Rust</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="../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc macro">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'><a href='index.html'>itertools</a></p><script>window.sidebarCurrent = {name: 'izip', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../theme.js"></script>
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Macro <a href='index.html'>itertools</a>::<wbr><a class="macro" href=''>izip</a></span><span class='out-of-band'><span id='render-detail'>
|
|||
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|||
|
|
[<span class='inner'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../src/itertools/lib.rs.html#247-269' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class="rust macro">
|
|||
|
|
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">izip</span> {
|
|||
|
|
( @<span class="ident">closure</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">p</span>:<span class="ident">pat</span> <span class="op">=></span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">tup</span>:<span class="ident">expr</span> ) <span class="op">=></span> { ... };
|
|||
|
|
( @<span class="ident">closure</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">p</span>:<span class="ident">pat</span> <span class="op">=></span> ( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tup</span>:<span class="ident">tt</span>)<span class="op">*</span> ) , <span class="macro-nonterminal">$</span><span class="macro-nonterminal">_iter</span>:<span class="ident">expr</span> $( , <span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">expr</span> )<span class="op">*</span> ) <span class="op">=></span> { ... };
|
|||
|
|
( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">first</span>:<span class="ident">expr</span> $( , <span class="macro-nonterminal">$</span><span class="macro-nonterminal">rest</span>:<span class="ident">expr</span> )<span class="op">*</span> $(,)<span class="op">*</span> ) <span class="op">=></span> { ... };
|
|||
|
|
}</pre>
|
|||
|
|
<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 elment 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 an iterator composed of
|
|||
|
|
repeated <code>.zip()</code> and a <code>.map()</code>; it has an anonymous type.
|
|||
|
|
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>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">itertools</span>;
|
|||
|
|
|
|||
|
|
<span class="comment">// iterate over three sequences side-by-side</span>
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">results</span> <span class="op">=</span> [<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> <span class="ident">inputs</span> <span class="op">=</span> [<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> (<span class="ident">r</span>, <span class="ident">index</span>, <span class="ident">input</span>) <span class="kw">in</span> <span class="macro">izip</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">results</span>, <span class="number">0</span>..<span class="number">10</span>, <span class="kw-2">&</span><span class="ident">inputs</span>) {
|
|||
|
|
<span class="kw-2">*</span><span class="ident">r</span> <span class="op">=</span> <span class="ident">index</span> <span class="op">*</span> <span class="number">10</span> <span class="op">+</span> <span class="ident">input</span>;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">results</span>, [<span class="number">0</span> <span class="op">+</span> <span class="number">3</span>, <span class="number">10</span> <span class="op">+</span> <span class="number">7</span>, <span class="number">29</span>, <span class="number">36</span>]);</pre>
|
|||
|
|
<p><strong>Note:</strong> To enable the macros in this crate, use the <code>#[macro_use]</code>
|
|||
|
|
attribute when importing the crate:</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">itertools</span>;</pre>
|
|||
|
|
</div></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "itertools";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|