mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-31 07:30:39 +00:00
40 lines
9.1 KiB
HTML
40 lines
9.1 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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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><a href='../itertools/index.html'><img src='../rust-logo.png' alt='logo' width='100'></a><div class="sidebar-elems"><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></div></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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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#280-314' title='goto source code'>[src]</a></span><span class='in-band'>Macro <a href='index.html'>itertools</a>::<wbr><a class="macro" href=''>izip</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><div class="example-wrap"><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="kw-2">*</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">second</span>:<span class="ident">expr</span> $(,)<span class="kw-2">*</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>
|
||
</div><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">
|
||
<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></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">
|
||
<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>
|
||
</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "itertools";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |