mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 00:18:24 +00:00
31 lines
7.7 KiB
HTML
31 lines
7.7 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="Return an iterator inside a `Rc<RefCell<_>>` wrapper."><title>rciter in itertools - Rust</title><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"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-5bc39a1768837dd0.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.77.0 (aedd173a2 2024-03-17)" data-channel="1.77.0" data-search-js="search-dd67cee4cfa65049.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-48f368f3872407c8.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 fn"><!--[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>Function <a href="index.html">itertools</a>::<wbr><a class="fn" href="#">rciter</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/rciter_impl.rs.html#47-54">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn rciter<I>(iterable: I) -> <a class="struct" href="structs/struct.RcIter.html" title="struct itertools::structs::RcIter">RcIter</a><I::<a class="associatedtype" href="https://doc.rust-lang.org/1.77.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a>> <a href="#" class="tooltip" data-notable-ty="RcIter<I::IntoIter>">ⓘ</a><div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/1.77.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Return an iterator inside a <code>Rc<RefCell<_>></code> wrapper.</p>
|
||
<p>The returned <code>RcIter</code> can be cloned, and each clone will refer back to the
|
||
same original iterator.</p>
|
||
<p><code>RcIter</code> allows doing interesting things like using <code>.zip()</code> on an iterator with
|
||
itself, at the cost of runtime borrow checking which may have a performance
|
||
penalty.</p>
|
||
<p>Iterator element type is <code>Self::Item</code>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::rciter;
|
||
<span class="kw">use </span>itertools::zip;
|
||
|
||
<span class="comment">// In this example a range iterator is created and we iterate it using
|
||
// three separate handles (two of them given to zip).
|
||
// We also use the IntoIterator implementation for `&RcIter`.
|
||
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>iter = rciter(<span class="number">0</span>..<span class="number">9</span>);
|
||
<span class="kw">let </span><span class="kw-2">mut </span>z = zip(<span class="kw-2">&</span>iter, <span class="kw-2">&</span>iter);
|
||
|
||
<span class="macro">assert_eq!</span>(z.next(), <span class="prelude-val">Some</span>((<span class="number">0</span>, <span class="number">1</span>)));
|
||
<span class="macro">assert_eq!</span>(z.next(), <span class="prelude-val">Some</span>((<span class="number">2</span>, <span class="number">3</span>)));
|
||
<span class="macro">assert_eq!</span>(z.next(), <span class="prelude-val">Some</span>((<span class="number">4</span>, <span class="number">5</span>)));
|
||
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="number">6</span>));
|
||
<span class="macro">assert_eq!</span>(z.next(), <span class="prelude-val">Some</span>((<span class="number">7</span>, <span class="number">8</span>)));
|
||
<span class="macro">assert_eq!</span>(z.next(), <span class="prelude-val">None</span>);</code></pre></div>
|
||
<p><strong>Panics</strong> in iterator methods if a borrow error is encountered in the
|
||
iterator methods. It can only happen if the <code>RcIter</code> is reentered in
|
||
<code>.next()</code>, i.e. if it somehow participates in an “iterator knot”
|
||
where it is an adaptor of itself.</p>
|
||
</div></details><script type="text/json" id="notable-traits-data">{"RcIter<I::IntoIter>":"<h3>Notable traits for <code><a class=\"struct\" href=\"structs/struct.RcIter.html\" title=\"struct itertools::structs::RcIter\">RcIter</a><I></code></h3><pre><code><div class=\"where\">impl<A, I> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.77.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"structs/struct.RcIter.html\" title=\"struct itertools::structs::RcIter\">RcIter</a><I><div class=\"where\">where\n I: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.77.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a><Item = A>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.77.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = A;</div>"}</script></section></div></main></body></html> |