blob: eb97e55e22c7e5c1e49fe28a00b4ba12b8615657 [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="A builder for collecting map streams on which to perform set operations on the keys of maps."><meta name="keywords" content="rust, rustlang, rust-lang, OpBuilder"><title>OpBuilder in tantivy_fst::map - Rust</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="sidebar-items.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 struct"><!--[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">&#9776;</button><a class="sidebar-logo" href="../../tantivy_fst/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tantivy_fst/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">OpBuilder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.add">add</a></li><li><a href="#method.chain">chain</a></li><li><a href="#method.difference">difference</a></li><li><a href="#method.intersection">intersection</a></li><li><a href="#method.new">new</a></li><li><a href="#method.push">push</a></li><li><a href="#method.symmetric_difference">symmetric_difference</a></li><li><a href="#method.union">union</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Extend%3CI%3E-for-OpBuilder%3C%27f%3E">Extend&lt;I&gt;</a></li><li><a href="#impl-FromIterator%3CI%3E-for-OpBuilder%3C%27f%3E">FromIterator&lt;I&gt;</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-OpBuilder%3C%27m%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-OpBuilder%3C%27m%3E">!Send</a></li><li><a href="#impl-Sync-for-OpBuilder%3C%27m%3E">!Sync</a></li><li><a href="#impl-Unpin-for-OpBuilder%3C%27m%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-OpBuilder%3C%27m%3E">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-OpBuilder%3C%27m%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-OpBuilder%3C%27m%3E">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-OpBuilder%3C%27m%3E">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-OpBuilder%3C%27m%3E">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-OpBuilder%3C%27m%3E">Into&lt;U&gt;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-OpBuilder%3C%27m%3E">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-OpBuilder%3C%27m%3E">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In tantivy_fst::map</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Struct <a href="../index.html">tantivy_fst</a>::<wbr><a href="index.html">map</a>::<wbr><a class="struct" href="#">OpBuilder</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tantivy_fst/map.rs.html#736">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct OpBuilder&lt;'m&gt;(_);</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A builder for collecting map streams on which to perform set operations
on the keys of maps.</p>
<p>Set operations include intersection, union, difference and symmetric
difference. The result of each set operation is itself a stream that emits
pairs of keys and a sequence of each occurrence of that key in the
participating streams. This information allows one to perform set
operations on maps and customize how conflicting output values are handled.</p>
<p>All set operations work efficiently on an arbitrary number of
streams with memory proportional to the number of streams.</p>
<p>The algorithmic complexity of all set operations is <code>O(n1 + n2 + n3 + ...)</code>
where <code>n1, n2, n3, ...</code> correspond to the number of elements in each
stream.</p>
<p>The <code>'m</code> lifetime parameter refers to the lifetime of the underlying set.</p>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-OpBuilder%3C%27m%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#738-986">source</a><a href="#impl-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;'m&gt; <a class="struct" href="struct.OpBuilder.html" title="struct tantivy_fst::map::OpBuilder">OpBuilder</a>&lt;'m&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#741-743">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -&gt; Self</h4></section></summary><div class="docblock"><p>Create a new set operation builder.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.add" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#752-759">source</a><h4 class="code-header">pub fn <a href="#method.add" class="fnname">add</a>&lt;I, S&gt;(self, streamable: I) -&gt; Self<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: for&lt;'a&gt; <a class="trait" href="../trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a, Into = S, Item = (&amp;'a [u8], u64)&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;S: 'm + for&lt;'a&gt; <a class="trait" href="../trait.Streamer.html" title="trait tantivy_fst::Streamer">Streamer</a>&lt;'a, Item = (&amp;'a [u8], u64)&gt;,</span></h4></section></summary><div class="docblock"><p>Add a stream to this set operation.</p>
<p>This is useful for a chaining style pattern, e.g.,
<code>builder.add(stream1).add(stream2).union()</code>.</p>
<p>The stream must emit a lexicographically ordered sequence of key-value
pairs.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.push" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#765-771">source</a><h4 class="code-header">pub fn <a href="#method.push" class="fnname">push</a>&lt;I, S&gt;(&amp;mut self, streamable: I)<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: for&lt;'a&gt; <a class="trait" href="../trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a, Into = S, Item = (&amp;'a [u8], u64)&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;S: 'm + for&lt;'a&gt; <a class="trait" href="../trait.Streamer.html" title="trait tantivy_fst::Streamer">Streamer</a>&lt;'a, Item = (&amp;'a [u8], u64)&gt;,</span></h4></section></summary><div class="docblock"><p>Add a stream to this set operation.</p>
<p>The stream must emit a lexicographically ordered sequence of key-value
pairs.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.union" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#814-816">source</a><h4 class="code-header">pub fn <a href="#method.union" class="fnname">union</a>(self) -&gt; <a class="struct" href="struct.Union.html" title="struct tantivy_fst::map::Union">Union</a>&lt;'m&gt;</h4></section></summary><div class="docblock"><p>Performs a union operation on all streams that have been added.</p>
<p>Note that this returns a stream of <code>(&amp;[u8], &amp;[IndexedValue])</code>. The
first element of the tuple is the byte string key. The second element
of the tuple is a list of all occurrences of that key in participating
streams. The <code>IndexedValue</code> contains an index and the value associated
with that key in that stream. The index uniquely identifies each
stream, which is an integer that is auto-incremented when a stream
is added to this operation (starting at <code>0</code>).</p>
<h5 id="example"><a href="#example">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tantivy_fst::{IntoStreamer, Streamer, Map};
<span class="kw">use </span>tantivy_fst::map::IndexedValue;
<span class="kw">let </span>map1 = Map::from_iter(<span class="macro">vec!</span>[
(<span class="string">&quot;a&quot;</span>, <span class="number">1</span>), (<span class="string">&quot;b&quot;</span>, <span class="number">2</span>), (<span class="string">&quot;c&quot;</span>, <span class="number">3</span>),
]).unwrap();
<span class="kw">let </span>map2 = Map::from_iter(<span class="macro">vec!</span>[
(<span class="string">&quot;a&quot;</span>, <span class="number">11</span>), (<span class="string">&quot;y&quot;</span>, <span class="number">12</span>), (<span class="string">&quot;z&quot;</span>, <span class="number">13</span>),
]).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>union = map1.op().add(<span class="kw-2">&amp;</span>map2).union();
<span class="kw">let </span><span class="kw-2">mut </span>kvs = <span class="macro">vec!</span>[];
<span class="kw">while let </span><span class="prelude-val">Some</span>((k, vs)) = union.next() {
kvs.push((k.to_vec(), vs.to_vec()));
}
<span class="macro">assert_eq!</span>(kvs, <span class="macro">vec!</span>[
(<span class="string">b&quot;a&quot;</span>.to_vec(), <span class="macro">vec!</span>[
IndexedValue { index: <span class="number">0</span>, value: <span class="number">1 </span>},
IndexedValue { index: <span class="number">1</span>, value: <span class="number">11 </span>},
]),
(<span class="string">b&quot;b&quot;</span>.to_vec(), <span class="macro">vec!</span>[IndexedValue { index: <span class="number">0</span>, value: <span class="number">2 </span>}]),
(<span class="string">b&quot;c&quot;</span>.to_vec(), <span class="macro">vec!</span>[IndexedValue { index: <span class="number">0</span>, value: <span class="number">3 </span>}]),
(<span class="string">b&quot;y&quot;</span>.to_vec(), <span class="macro">vec!</span>[IndexedValue { index: <span class="number">1</span>, value: <span class="number">12 </span>}]),
(<span class="string">b&quot;z&quot;</span>.to_vec(), <span class="macro">vec!</span>[IndexedValue { index: <span class="number">1</span>, value: <span class="number">13 </span>}]),
]);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.chain" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#854-856">source</a><h4 class="code-header">pub fn <a href="#method.chain" class="fnname">chain</a>(self) -&gt; <a class="struct" href="struct.Chain.html" title="struct tantivy_fst::map::Chain">Chain</a>&lt;'m&gt;</h4></section></summary><div class="docblock"><p>Chains all streams that have been added in the order they have been added.</p>
<p>Note that this returns a stream of <code>(&amp;[u8], &amp;[Output])</code>. The
first element of the tuple is the byte string key. The second element
of the tuple is the value associated with that key in the underlying
streams. This is useful when the streams area already sorted and not
overlapping.</p>
<h5 id="example-1"><a href="#example-1">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tantivy_fst::{IntoStreamer, Streamer, Map};
<span class="kw">use </span>tantivy_fst::raw::Output;
<span class="kw">use </span>tantivy_fst::map::IndexedValue;
<span class="kw">let </span>map1 = Map::from_iter(<span class="macro">vec!</span>[
(<span class="string">&quot;a&quot;</span>, <span class="number">1</span>), (<span class="string">&quot;b&quot;</span>, <span class="number">2</span>),
]).unwrap();
<span class="kw">let </span>map2 = Map::from_iter(<span class="macro">vec!</span>[
(<span class="string">&quot;a&quot;</span>, <span class="number">11</span>), (<span class="string">&quot;y&quot;</span>, <span class="number">12</span>),
]).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>chain = map1.op().add(<span class="kw-2">&amp;</span>map2).chain();
<span class="kw">let </span><span class="kw-2">mut </span>kvs = <span class="macro">vec!</span>[];
<span class="kw">while let </span><span class="prelude-val">Some</span>((k, v)) = chain.next() {
kvs.push((k.to_vec(), v));
}
<span class="macro">assert_eq!</span>(kvs, <span class="macro">vec!</span>[
(<span class="string">b&quot;a&quot;</span>.to_vec(), Output::new(<span class="number">1</span>)),
(<span class="string">b&quot;b&quot;</span>.to_vec(), Output::new(<span class="number">2</span>)),
(<span class="string">b&quot;a&quot;</span>.to_vec(), Output::new(<span class="number">11</span>)),
(<span class="string">b&quot;y&quot;</span>.to_vec(), Output::new(<span class="number">12</span>)),
]);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.intersection" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#894-896">source</a><h4 class="code-header">pub fn <a href="#method.intersection" class="fnname">intersection</a>(self) -&gt; <a class="struct" href="struct.Intersection.html" title="struct tantivy_fst::map::Intersection">Intersection</a>&lt;'m&gt;</h4></section></summary><div class="docblock"><p>Performs an intersection operation on all streams that have been added.</p>
<p>Note that this returns a stream of <code>(&amp;[u8], &amp;[IndexedValue])</code>. The
first element of the tuple is the byte string key. The second element
of the tuple is a list of all occurrences of that key in participating
streams. The <code>IndexedValue</code> contains an index and the value associated
with that key in that stream. The index uniquely identifies each
stream, which is an integer that is auto-incremented when a stream
is added to this operation (starting at <code>0</code>).</p>
<h5 id="example-2"><a href="#example-2">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tantivy_fst::{IntoStreamer, Streamer, Map};
<span class="kw">use </span>tantivy_fst::map::IndexedValue;
<span class="kw">let </span>map1 = Map::from_iter(<span class="macro">vec!</span>[
(<span class="string">&quot;a&quot;</span>, <span class="number">1</span>), (<span class="string">&quot;b&quot;</span>, <span class="number">2</span>), (<span class="string">&quot;c&quot;</span>, <span class="number">3</span>),
]).unwrap();
<span class="kw">let </span>map2 = Map::from_iter(<span class="macro">vec!</span>[
(<span class="string">&quot;a&quot;</span>, <span class="number">11</span>), (<span class="string">&quot;y&quot;</span>, <span class="number">12</span>), (<span class="string">&quot;z&quot;</span>, <span class="number">13</span>),
]).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>intersection = map1.op().add(<span class="kw-2">&amp;</span>map2).intersection();
<span class="kw">let </span><span class="kw-2">mut </span>kvs = <span class="macro">vec!</span>[];
<span class="kw">while let </span><span class="prelude-val">Some</span>((k, vs)) = intersection.next() {
kvs.push((k.to_vec(), vs.to_vec()));
}
<span class="macro">assert_eq!</span>(kvs, <span class="macro">vec!</span>[
(<span class="string">b&quot;a&quot;</span>.to_vec(), <span class="macro">vec!</span>[
IndexedValue { index: <span class="number">0</span>, value: <span class="number">1 </span>},
IndexedValue { index: <span class="number">1</span>, value: <span class="number">11 </span>},
]),
]);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.difference" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#935-937">source</a><h4 class="code-header">pub fn <a href="#method.difference" class="fnname">difference</a>(self) -&gt; <a class="struct" href="struct.Difference.html" title="struct tantivy_fst::map::Difference">Difference</a>&lt;'m&gt;</h4></section></summary><div class="docblock"><p>Performs a difference operation with respect to the first stream added.
That is, this returns a stream of all elements in the first stream
that don’t exist in any other stream that has been added.</p>
<p>Note that this returns a stream of <code>(&amp;[u8], &amp;[IndexedValue])</code>. The
first element of the tuple is the byte string key. The second element
of the tuple is a list of all occurrences of that key in participating
streams. The <code>IndexedValue</code> contains an index and the value associated
with that key in that stream. The index uniquely identifies each
stream, which is an integer that is auto-incremented when a stream
is added to this operation (starting at <code>0</code>).</p>
<h5 id="example-3"><a href="#example-3">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tantivy_fst::{Streamer, Map};
<span class="kw">use </span>tantivy_fst::map::IndexedValue;
<span class="kw">let </span>map1 = Map::from_iter(<span class="macro">vec!</span>[
(<span class="string">&quot;a&quot;</span>, <span class="number">1</span>), (<span class="string">&quot;b&quot;</span>, <span class="number">2</span>), (<span class="string">&quot;c&quot;</span>, <span class="number">3</span>),
]).unwrap();
<span class="kw">let </span>map2 = Map::from_iter(<span class="macro">vec!</span>[
(<span class="string">&quot;a&quot;</span>, <span class="number">11</span>), (<span class="string">&quot;y&quot;</span>, <span class="number">12</span>), (<span class="string">&quot;z&quot;</span>, <span class="number">13</span>),
]).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>difference = map1.op().add(<span class="kw-2">&amp;</span>map2).difference();
<span class="kw">let </span><span class="kw-2">mut </span>kvs = <span class="macro">vec!</span>[];
<span class="kw">while let </span><span class="prelude-val">Some</span>((k, vs)) = difference.next() {
kvs.push((k.to_vec(), vs.to_vec()));
}
<span class="macro">assert_eq!</span>(kvs, <span class="macro">vec!</span>[
(<span class="string">b&quot;b&quot;</span>.to_vec(), <span class="macro">vec!</span>[IndexedValue { index: <span class="number">0</span>, value: <span class="number">2 </span>}]),
(<span class="string">b&quot;c&quot;</span>.to_vec(), <span class="macro">vec!</span>[IndexedValue { index: <span class="number">0</span>, value: <span class="number">3 </span>}]),
]);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.symmetric_difference" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#983-985">source</a><h4 class="code-header">pub fn <a href="#method.symmetric_difference" class="fnname">symmetric_difference</a>(self) -&gt; <a class="struct" href="struct.SymmetricDifference.html" title="struct tantivy_fst::map::SymmetricDifference">SymmetricDifference</a>&lt;'m&gt;</h4></section></summary><div class="docblock"><p>Performs a symmetric difference operation on all of the streams that
have been added.</p>
<p>When there are only two streams, then the keys returned correspond to
keys that are in either stream but <em>not</em> in both streams.</p>
<p>More generally, for any number of streams, keys that occur in an odd
number of streams are returned.</p>
<p>Note that this returns a stream of <code>(&amp;[u8], &amp;[IndexedValue])</code>. The
first element of the tuple is the byte string key. The second element
of the tuple is a list of all occurrences of that key in participating
streams. The <code>IndexedValue</code> contains an index and the value associated
with that key in that stream. The index uniquely identifies each
stream, which is an integer that is auto-incremented when a stream
is added to this operation (starting at <code>0</code>).</p>
<h5 id="example-4"><a href="#example-4">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tantivy_fst::{IntoStreamer, Streamer, Map};
<span class="kw">use </span>tantivy_fst::map::IndexedValue;
<span class="kw">let </span>map1 = Map::from_iter(<span class="macro">vec!</span>[
(<span class="string">&quot;a&quot;</span>, <span class="number">1</span>), (<span class="string">&quot;b&quot;</span>, <span class="number">2</span>), (<span class="string">&quot;c&quot;</span>, <span class="number">3</span>),
]).unwrap();
<span class="kw">let </span>map2 = Map::from_iter(<span class="macro">vec!</span>[
(<span class="string">&quot;a&quot;</span>, <span class="number">11</span>), (<span class="string">&quot;y&quot;</span>, <span class="number">12</span>), (<span class="string">&quot;z&quot;</span>, <span class="number">13</span>),
]).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>sym_difference = map1.op().add(<span class="kw-2">&amp;</span>map2).symmetric_difference();
<span class="kw">let </span><span class="kw-2">mut </span>kvs = <span class="macro">vec!</span>[];
<span class="kw">while let </span><span class="prelude-val">Some</span>((k, vs)) = sym_difference.next() {
kvs.push((k.to_vec(), vs.to_vec()));
}
<span class="macro">assert_eq!</span>(kvs, <span class="macro">vec!</span>[
(<span class="string">b&quot;b&quot;</span>.to_vec(), <span class="macro">vec!</span>[IndexedValue { index: <span class="number">0</span>, value: <span class="number">2 </span>}]),
(<span class="string">b&quot;c&quot;</span>.to_vec(), <span class="macro">vec!</span>[IndexedValue { index: <span class="number">0</span>, value: <span class="number">3 </span>}]),
(<span class="string">b&quot;y&quot;</span>.to_vec(), <span class="macro">vec!</span>[IndexedValue { index: <span class="number">1</span>, value: <span class="number">12 </span>}]),
(<span class="string">b&quot;z&quot;</span>.to_vec(), <span class="macro">vec!</span>[IndexedValue { index: <span class="number">1</span>, value: <span class="number">13 </span>}]),
]);</code></pre></div>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Extend%3CI%3E-for-OpBuilder%3C%27f%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#988-1001">source</a><a href="#impl-Extend%3CI%3E-for-OpBuilder%3C%27f%3E" class="anchor"></a><h3 class="code-header">impl&lt;'f, I, S&gt; Extend&lt;I&gt; for <a class="struct" href="struct.OpBuilder.html" title="struct tantivy_fst::map::OpBuilder">OpBuilder</a>&lt;'f&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: for&lt;'a&gt; <a class="trait" href="../trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a, Into = S, Item = (&amp;'a [u8], u64)&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;S: 'f + for&lt;'a&gt; <a class="trait" href="../trait.Streamer.html" title="trait tantivy_fst::Streamer">Streamer</a>&lt;'a, Item = (&amp;'a [u8], u64)&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.extend" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#993-1000">source</a><a href="#method.extend" class="anchor"></a><h4 class="code-header">fn <a class="fnname">extend</a>&lt;T&gt;(&amp;mut self, it: T)<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: IntoIterator&lt;Item = I&gt;,</span></h4></section></summary><div class='docblock'>Extends a collection with the contents of an iterator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.extend_one" class="method trait-impl has-srclink"><a href="#method.extend_one" class="anchor"></a><h4 class="code-header">fn <a class="fnname">extend_one</a>(&amp;mut self, item: A)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>extend_one</code>)</span></div></span><div class='docblock'>Extends a collection with exactly one element.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.extend_reserve" class="method trait-impl has-srclink"><a href="#method.extend_reserve" class="anchor"></a><h4 class="code-header">fn <a class="fnname">extend_reserve</a>(&amp;mut self, additional: usize)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>extend_one</code>)</span></div></span><div class='docblock'>Reserves capacity in a collection for the given number of additional elements. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-FromIterator%3CI%3E-for-OpBuilder%3C%27f%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#1003-1016">source</a><a href="#impl-FromIterator%3CI%3E-for-OpBuilder%3C%27f%3E" class="anchor"></a><h3 class="code-header">impl&lt;'f, I, S&gt; FromIterator&lt;I&gt; for <a class="struct" href="struct.OpBuilder.html" title="struct tantivy_fst::map::OpBuilder">OpBuilder</a>&lt;'f&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: for&lt;'a&gt; <a class="trait" href="../trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a, Into = S, Item = (&amp;'a [u8], u64)&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;S: 'f + for&lt;'a&gt; <a class="trait" href="../trait.Streamer.html" title="trait tantivy_fst::Streamer">Streamer</a>&lt;'a, Item = (&amp;'a [u8], u64)&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_iter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#1008-1015">source</a><a href="#method.from_iter" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from_iter</a>&lt;T&gt;(it: T) -&gt; Self<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: IntoIterator&lt;Item = I&gt;,</span></h4></section></summary><div class='docblock'>Creates a value from an iterator. <a>Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;'m&gt; !RefUnwindSafe for <a class="struct" href="struct.OpBuilder.html" title="struct tantivy_fst::map::OpBuilder">OpBuilder</a>&lt;'m&gt;</h3></section><section id="impl-Send-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-Send-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;'m&gt; !Send for <a class="struct" href="struct.OpBuilder.html" title="struct tantivy_fst::map::OpBuilder">OpBuilder</a>&lt;'m&gt;</h3></section><section id="impl-Sync-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-Sync-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;'m&gt; !Sync for <a class="struct" href="struct.OpBuilder.html" title="struct tantivy_fst::map::OpBuilder">OpBuilder</a>&lt;'m&gt;</h3></section><section id="impl-Unpin-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-Unpin-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;'m&gt; Unpin for <a class="struct" href="struct.OpBuilder.html" title="struct tantivy_fst::map::OpBuilder">OpBuilder</a>&lt;'m&gt;</h3></section><section id="impl-UnwindSafe-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;'m&gt; !UnwindSafe for <a class="struct" href="struct.OpBuilder.html" title="struct tantivy_fst::map::OpBuilder">OpBuilder</a>&lt;'m&gt;</h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-Any-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-OpBuilder%3C%27m%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-OpBuilder%3C%27m%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tantivy_fst" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>