blob: 2685ca61640919521da5a269a87e2b4077fc4062 [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/itertools-0.10.5/src/intersperse.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>intersperse.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../itertools/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../itertools/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::iter::{Fuse, FusedIterator};
<span class="kw">use </span><span class="kw">super</span>::size_hint;
<span class="kw">pub trait </span>IntersperseElement&lt;Item&gt; {
<span class="kw">fn </span>generate(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; Item;
}
<span class="attribute">#[derive(Debug, Clone)]
</span><span class="kw">pub struct </span>IntersperseElementSimple&lt;Item&gt;(Item);
<span class="kw">impl</span>&lt;Item: Clone&gt; IntersperseElement&lt;Item&gt; <span class="kw">for </span>IntersperseElementSimple&lt;Item&gt; {
<span class="kw">fn </span>generate(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; Item {
<span class="self">self</span>.<span class="number">0</span>.clone()
}
}
<span class="doccomment">/// An iterator adaptor to insert a particular value
/// between each element of the adapted iterator.
///
/// Iterator element type is `I::Item`
///
/// This iterator is *fused*.
///
/// See [`.intersperse()`](crate::Itertools::intersperse) for more information.
</span><span class="kw">pub type </span>Intersperse&lt;I&gt; = IntersperseWith&lt;I, IntersperseElementSimple&lt;&lt;I <span class="kw">as </span>Iterator&gt;::Item&gt;&gt;;
<span class="doccomment">/// Create a new Intersperse iterator
</span><span class="kw">pub fn </span>intersperse&lt;I&gt;(iter: I, elt: I::Item) -&gt; Intersperse&lt;I&gt;
<span class="kw">where </span>I: Iterator,
{
intersperse_with(iter, IntersperseElementSimple(elt))
}
<span class="kw">impl</span>&lt;Item, F: FnMut()-&gt;Item&gt; IntersperseElement&lt;Item&gt; <span class="kw">for </span>F {
<span class="kw">fn </span>generate(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; Item {
<span class="self">self</span>()
}
}
<span class="doccomment">/// An iterator adaptor to insert a particular value created by a function
/// between each element of the adapted iterator.
///
/// Iterator element type is `I::Item`
///
/// This iterator is *fused*.
///
/// See [`.intersperse_with()`](crate::Itertools::intersperse_with) for more information.
</span><span class="attribute">#[must_use = <span class="string">&quot;iterator adaptors are lazy and do nothing unless consumed&quot;</span>]
#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>IntersperseWith&lt;I, ElemF&gt;
<span class="kw">where </span>I: Iterator,
{
element: ElemF,
iter: Fuse&lt;I&gt;,
peek: <span class="prelude-ty">Option</span>&lt;I::Item&gt;,
}
<span class="doccomment">/// Create a new `IntersperseWith` iterator
</span><span class="kw">pub fn </span>intersperse_with&lt;I, ElemF&gt;(iter: I, elt: ElemF) -&gt; IntersperseWith&lt;I, ElemF&gt;
<span class="kw">where </span>I: Iterator,
{
<span class="kw">let </span><span class="kw-2">mut </span>iter = iter.fuse();
IntersperseWith {
peek: iter.next(),
iter,
element: elt,
}
}
<span class="kw">impl</span>&lt;I, ElemF&gt; Iterator <span class="kw">for </span>IntersperseWith&lt;I, ElemF&gt;
<span class="kw">where </span>I: Iterator,
ElemF: IntersperseElement&lt;I::Item&gt;
{
<span class="kw">type </span>Item = I::Item;
<span class="attribute">#[inline]
</span><span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt; {
<span class="kw">if </span><span class="self">self</span>.peek.is_some() {
<span class="self">self</span>.peek.take()
} <span class="kw">else </span>{
<span class="self">self</span>.peek = <span class="self">self</span>.iter.next();
<span class="kw">if </span><span class="self">self</span>.peek.is_some() {
<span class="prelude-val">Some</span>(<span class="self">self</span>.element.generate())
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
}
<span class="kw">fn </span>size_hint(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (usize, <span class="prelude-ty">Option</span>&lt;usize&gt;) {
<span class="comment">// 2 * SH + { 1 or 0 }
</span><span class="kw">let </span>has_peek = <span class="self">self</span>.peek.is_some() <span class="kw">as </span>usize;
<span class="kw">let </span>sh = <span class="self">self</span>.iter.size_hint();
size_hint::add_scalar(size_hint::add(sh, sh), has_peek)
}
<span class="kw">fn </span>fold&lt;B, F&gt;(<span class="kw-2">mut </span><span class="self">self</span>, init: B, <span class="kw-2">mut </span>f: F) -&gt; B <span class="kw">where
</span><span class="self">Self</span>: Sized, F: FnMut(B, <span class="self">Self</span>::Item) -&gt; B,
{
<span class="kw">let </span><span class="kw-2">mut </span>accum = init;
<span class="kw">if let </span><span class="prelude-val">Some</span>(x) = <span class="self">self</span>.peek.take() {
accum = f(accum, x);
}
<span class="kw">let </span>element = <span class="kw-2">&amp;mut </span><span class="self">self</span>.element;
<span class="self">self</span>.iter.fold(accum,
|accum, x| {
<span class="kw">let </span>accum = f(accum, element.generate());
f(accum, x)
})
}
}
<span class="kw">impl</span>&lt;I, ElemF&gt; FusedIterator <span class="kw">for </span>IntersperseWith&lt;I, ElemF&gt;
<span class="kw">where </span>I: Iterator,
ElemF: IntersperseElement&lt;I::Item&gt;
{}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="itertools" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>