mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-10 01:58:23 +00:00
39 lines
8.2 KiB
HTML
39 lines
8.2 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="Chain zero or more iterators together into one sequence."><title>chain in itertools - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="itertools" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../itertools/index.html">itertools</a><span class="version">0.12.1</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../itertools/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Macro <a href="index.html">itertools</a>::<wbr><a class="macro" href="#">chain</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/itertools/lib.rs.html#379-395">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><span class="macro">macro_rules!</span> chain {
|
||
() => { ... };
|
||
(<span class="macro-nonterminal">$first</span>:expr $(, <span class="macro-nonterminal">$rest</span>:expr )* $(,)<span class="question-mark">?</span>) => { ... };
|
||
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="https://doc.rust-lang.org/1.78.0/core/iter/traits/iterator/trait.Iterator.html#method.chain" title="method core::iter::traits::iterator::Iterator::chain">Chain</a> zero or more iterators together into one sequence.</p>
|
||
<p>The comma-separated arguments must implement <a href="https://doc.rust-lang.org/1.78.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator"><code>IntoIterator</code></a>.
|
||
The final argument may be followed by a trailing comma.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<p>Empty invocations of <code>chain!</code> expand to an invocation of <a href="https://doc.rust-lang.org/1.78.0/core/iter/sources/empty/fn.empty.html" title="fn core::iter::sources::empty::empty"><code>std::iter::empty</code></a>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::iter;
|
||
<span class="kw">use </span>itertools::chain;
|
||
|
||
<span class="kw">let _</span>: iter::Empty<()> = <span class="macro">chain!</span>();
|
||
<span class="kw">let _</span>: iter::Empty<i8> = <span class="macro">chain!</span>();</code></pre></div>
|
||
<p>Invocations of <code>chain!</code> with one argument expand to <a href="https://doc.rust-lang.org/1.78.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator"><code>arg.into_iter()</code></a>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::{ops::Range, slice};
|
||
<span class="kw">use </span>itertools::chain;
|
||
<span class="kw">let _</span>: <Range<<span class="kw">_</span>> <span class="kw">as </span>IntoIterator>::IntoIter = <span class="macro">chain!</span>((<span class="number">2</span>..<span class="number">6</span>),); <span class="comment">// trailing comma optional!
|
||
</span><span class="kw">let _</span>: <<span class="kw-2">&</span>[<span class="kw">_</span>] <span class="kw">as </span>IntoIterator>::IntoIter = <span class="macro">chain!</span>(<span class="kw-2">&</span>[<span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);</code></pre></div>
|
||
<p>Invocations of <code>chain!</code> with multiple arguments <a href="https://doc.rust-lang.org/1.78.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator"><code>.into_iter()</code></a> each
|
||
argument, and then <a href="https://doc.rust-lang.org/1.78.0/core/iter/traits/iterator/trait.Iterator.html#method.chain" title="method core::iter::traits::iterator::Iterator::chain"><code>chain</code></a> them together:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::{iter::<span class="kw-2">*</span>, ops::Range, slice};
|
||
<span class="kw">use </span>itertools::{assert_equal, chain};
|
||
|
||
<span class="comment">// e.g., this:
|
||
</span><span class="kw">let </span>with_macro: Chain<Chain<Once<<span class="kw">_</span>>, Take<Repeat<<span class="kw">_</span>>>>, slice::Iter<<span class="kw">_</span>>> =
|
||
<span class="macro">chain!</span>[once(<span class="kw-2">&</span><span class="number">0</span>), repeat(<span class="kw-2">&</span><span class="number">1</span>).take(<span class="number">2</span>), <span class="kw-2">&</span>[<span class="number">2</span>, <span class="number">3</span>, <span class="number">5</span>],];
|
||
|
||
<span class="comment">// ...is equivalent to this:
|
||
</span><span class="kw">let </span>with_method: Chain<Chain<Once<<span class="kw">_</span>>, Take<Repeat<<span class="kw">_</span>>>>, slice::Iter<<span class="kw">_</span>>> =
|
||
once(<span class="kw-2">&</span><span class="number">0</span>)
|
||
.chain(repeat(<span class="kw-2">&</span><span class="number">1</span>).take(<span class="number">2</span>))
|
||
.chain(<span class="kw-2">&</span>[<span class="number">2</span>, <span class="number">3</span>, <span class="number">5</span>]);
|
||
|
||
assert_equal(with_macro, with_method);</code></pre></div>
|
||
</div></details></section></div></main></body></html> |