156 lines
No EOL
9.3 KiB
HTML
156 lines
No EOL
9.3 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 `rciter` fn in crate `itertools`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, rciter">
|
||
|
||
<title>itertools::rciter - 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 fn">
|
||
<!--[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: 'rciter', ty: 'fn', 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'>Function <a href='index.html'>itertools</a>::<wbr><a class="fn" href=''>rciter</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/rciter_impl.rs.html#47-51' title='goto source code'>[src]</a></span></h1>
|
||
<div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../itertools/structs/struct.RcIter.html" title="struct itertools::structs::RcIter">RcIter</a><I></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../itertools/structs/struct.RcIter.html" title="struct itertools::structs::RcIter">RcIter</a><I></h3><code class="content"><span class="where fmt-newline">impl<A, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../itertools/structs/struct.RcIter.html" title="struct itertools::structs::RcIter">RcIter</a><I> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a><Item = A>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = A;</span></code></div></div><pre class='rust fn'>pub fn rciter<I>(iterable: I) -> <a class="struct" href="../itertools/structs/struct.RcIter.html" title="struct itertools::structs::RcIter">RcIter</a><I::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::IntoIterator::IntoIter">IntoIter</a>> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>, </span></pre><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>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">itertools</span>::<span class="ident">rciter</span>;
|
||
<span class="kw">use</span> <span class="ident">itertools</span>::<span class="ident">zip</span>;
|
||
|
||
<span class="comment">// In this example a range iterator is created and we iterate it using</span>
|
||
<span class="comment">// three separate handles (two of them given to zip).</span>
|
||
<span class="comment">// We also use the IntoIterator implementation for `&RcIter`.</span>
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">iter</span> <span class="op">=</span> <span class="ident">rciter</span>(<span class="number">0</span>..<span class="number">9</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">z</span> <span class="op">=</span> <span class="ident">zip</span>(<span class="kw-2">&</span><span class="ident">iter</span>, <span class="kw-2">&</span><span class="ident">iter</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">z</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>((<span class="number">0</span>, <span class="number">1</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">z</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>((<span class="number">2</span>, <span class="number">3</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">z</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>((<span class="number">4</span>, <span class="number">5</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="number">6</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">z</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>((<span class="number">7</span>, <span class="number">8</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">z</span>.<span class="ident">next</span>(), <span class="prelude-val">None</span>);</pre>
|
||
<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></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> |