blob: 4bb12d15034507419de972b8e0c2ad4dbb154968 [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.8.2/src/diff.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>diff.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>
</pre><pre class="rust"><code><span class="doccomment">//! &quot;Diff&quot;ing iterators for caching elements to sequential collections without requiring the new
//! elements&#39; iterator to be `Clone`.
//!
//! - [**Diff**](./enum.Diff.html) (produced by the [**diff_with**](./fn.diff_with.html) function)
//! describes the difference between two non-`Clone` iterators `I` and `J` after breaking ASAP from
//! a lock-step comparison.
</span><span class="kw">use </span>free::put_back;
<span class="kw">use </span>structs::PutBack;
<span class="doccomment">/// A type returned by the [`diff_with`](./fn.diff_with.html) function.
///
/// `Diff` represents the way in which the elements yielded by the iterator `I` differ to some
/// iterator `J`.
</span><span class="kw">pub enum </span>Diff&lt;I, J&gt;
<span class="kw">where </span>I: Iterator,
J: Iterator
{
<span class="doccomment">/// The index of the first non-matching element along with both iterator&#39;s remaining elements
/// starting with the first mis-match.
</span>FirstMismatch(usize, PutBack&lt;I&gt;, PutBack&lt;J&gt;),
<span class="doccomment">/// The total number of elements that were in `J` along with the remaining elements of `I`.
</span>Shorter(usize, PutBack&lt;I&gt;),
<span class="doccomment">/// The total number of elements that were in `I` along with the remaining elements of `J`.
</span>Longer(usize, PutBack&lt;J&gt;),
}
<span class="doccomment">/// Compares every element yielded by both `i` and `j` with the given function in lock-step and
/// returns a `Diff` which describes how `j` differs from `i`.
///
/// If the number of elements yielded by `j` is less than the number of elements yielded by `i`,
/// the number of `j` elements yielded will be returned along with `i`&#39;s remaining elements as
/// `Diff::Shorter`.
///
/// If the two elements of a step differ, the index of those elements along with the remaining
/// elements of both `i` and `j` are returned as `Diff::FirstMismatch`.
///
/// If `i` becomes exhausted before `j` becomes exhausted, the number of elements in `i` along with
/// the remaining `j` elements will be returned as `Diff::Longer`.
</span><span class="kw">pub fn </span>diff_with&lt;I, J, F&gt;(i: I, j: J, is_equal: F)
-&gt; <span class="prelude-ty">Option</span>&lt;Diff&lt;I::IntoIter, J::IntoIter&gt;&gt;
<span class="kw">where </span>I: IntoIterator,
J: IntoIterator,
F: Fn(<span class="kw-2">&amp;</span>I::Item, <span class="kw-2">&amp;</span>J::Item) -&gt; bool
{
<span class="kw">let </span><span class="kw-2">mut </span>i = i.into_iter();
<span class="kw">let </span><span class="kw-2">mut </span>j = j.into_iter();
<span class="kw">let </span><span class="kw-2">mut </span>idx = <span class="number">0</span>;
<span class="kw">while let </span><span class="prelude-val">Some</span>(i_elem) = i.next() {
<span class="kw">match </span>j.next() {
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">Some</span>(Diff::Shorter(idx, put_back(i).with_value(i_elem))),
<span class="prelude-val">Some</span>(j_elem) =&gt; <span class="kw">if </span>!is_equal(<span class="kw-2">&amp;</span>i_elem, <span class="kw-2">&amp;</span>j_elem) {
<span class="kw">let </span>remaining_i = put_back(i).with_value(i_elem);
<span class="kw">let </span>remaining_j = put_back(j).with_value(j_elem);
<span class="kw">return </span><span class="prelude-val">Some</span>(Diff::FirstMismatch(idx, remaining_i, remaining_j));
},
}
idx += <span class="number">1</span>;
}
j.next().map(|j_elem| Diff::Longer(idx, put_back(j).with_value(j_elem)))
}
</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>