mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-21 02:30:43 +00:00
174 lines
46 KiB
HTML
174 lines
46 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 `OpBuilder` struct in crate `fst`."><meta name="keywords" content="rust, rustlang, rust-lang, OpBuilder"><title>fst::map::OpBuilder - 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="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[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><a href='../../fst/index.html'><img src='../../rust-logo.png' alt='logo' width='100'></a><p class='location'>Struct OpBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.add">add</a><a href="#method.difference">difference</a><a href="#method.intersection">intersection</a><a href="#method.new">new</a><a href="#method.push">push</a><a href="#method.symmetric_difference">symmetric_difference</a><a href="#method.union">union</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Extend%3CI%3E">Extend<I></a><a href="#impl-FromIterator%3CI%3E">FromIterator<I></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow">Borrow</a><a href="#impl-BorrowMut">BorrowMut</a><a href="#impl-From">From</a><a href="#impl-Into">Into</a><a href="#impl-TryFrom">TryFrom</a><a href="#impl-TryInto">TryInto</a></div></div><p class='location'><a href='../index.html'>fst</a>::<wbr><a href='index.html'>map</a></p><script>window.sidebarCurrent = {name: 'OpBuilder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/fst/map.rs.html#745' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>fst</a>::<wbr><a href='index.html'>map</a>::<wbr><a class="struct" href=''>OpBuilder</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct OpBuilder<'m>(_);</pre></div><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><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl<'m> <a class="struct" href="../../fst/map/struct.OpBuilder.html" title="struct fst::map::OpBuilder">OpBuilder</a><'m></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/fst/map.rs.html#747-956' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>() -> Self</code><a class='srclink' href='../../src/fst/map.rs.html#750-752' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a new set operation builder.</p>
|
||
</div><h4 id='method.add' class="method"><code id='add.v'>pub fn <a href='#method.add' class='fnname'>add</a><I, S>(self, streamable: I) -> Self <span class="where fmt-newline">where<br> I: for<'a> <a class="trait" href="../../fst/trait.IntoStreamer.html" title="trait fst::IntoStreamer">IntoStreamer</a><'a, Into = S, Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>,<br> S: 'm + for<'a> <a class="trait" href="../../fst/trait.Streamer.html" title="trait fst::Streamer">Streamer</a><'a, Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>, </span></code><a class='srclink' href='../../src/fst/map.rs.html#761-766' title='goto source code'>[src]</a></h4><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><h4 id='method.push' class="method"><code id='push.v'>pub fn <a href='#method.push' class='fnname'>push</a><I, S>(&mut self, streamable: I) <span class="where fmt-newline">where<br> I: for<'a> <a class="trait" href="../../fst/trait.IntoStreamer.html" title="trait fst::IntoStreamer">IntoStreamer</a><'a, Into = S, Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>,<br> S: 'm + for<'a> <a class="trait" href="../../fst/trait.Streamer.html" title="trait fst::Streamer">Streamer</a><'a, Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>, </span></code><a class='srclink' href='../../src/fst/map.rs.html#772-776' title='goto source code'>[src]</a></h4><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><h4 id='method.union' class="method"><code id='union.v'>pub fn <a href='#method.union' class='fnname'>union</a>(self) -> <a class="struct" href="../../fst/map/struct.Union.html" title="struct fst::map::Union">Union</a><'m></code><a class='srclink' href='../../src/fst/map.rs.html#819-821' title='goto source code'>[src]</a></h4><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>(&[u8], &[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>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">fst</span>::{<span class="ident">IntoStreamer</span>, <span class="ident">Streamer</span>, <span class="ident">Map</span>};
|
||
<span class="kw">use</span> <span class="ident">fst</span>::<span class="ident">map</span>::<span class="ident">IndexedValue</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">map1</span> <span class="op">=</span> <span class="ident">Map</span>::<span class="ident">from_iter</span>(<span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">"a"</span>, <span class="number">1</span>), (<span class="string">"b"</span>, <span class="number">2</span>), (<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">map2</span> <span class="op">=</span> <span class="ident">Map</span>::<span class="ident">from_iter</span>(<span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">"a"</span>, <span class="number">11</span>), (<span class="string">"y"</span>, <span class="number">12</span>), (<span class="string">"z"</span>, <span class="number">13</span>),
|
||
]).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">union</span> <span class="op">=</span> <span class="ident">map1</span>.<span class="ident">op</span>().<span class="ident">add</span>(<span class="kw-2">&</span><span class="ident">map2</span>).<span class="ident">union</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">kvs</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[];
|
||
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>((<span class="ident">k</span>, <span class="ident">vs</span>)) <span class="op">=</span> <span class="ident">union</span>.<span class="ident">next</span>() {
|
||
<span class="ident">kvs</span>.<span class="ident">push</span>((<span class="ident">k</span>.<span class="ident">to_vec</span>(), <span class="ident">vs</span>.<span class="ident">to_vec</span>()));
|
||
}
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">kvs</span>, <span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">b"a"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[
|
||
<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">0</span>, <span class="ident">value</span>: <span class="number">1</span> },
|
||
<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">1</span>, <span class="ident">value</span>: <span class="number">11</span> },
|
||
]),
|
||
(<span class="string">b"b"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">0</span>, <span class="ident">value</span>: <span class="number">2</span> }]),
|
||
(<span class="string">b"c"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">0</span>, <span class="ident">value</span>: <span class="number">3</span> }]),
|
||
(<span class="string">b"y"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">1</span>, <span class="ident">value</span>: <span class="number">12</span> }]),
|
||
(<span class="string">b"z"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">1</span>, <span class="ident">value</span>: <span class="number">13</span> }]),
|
||
]);</pre></div>
|
||
</div><h4 id='method.intersection' class="method"><code id='intersection.v'>pub fn <a href='#method.intersection' class='fnname'>intersection</a>(self) -> <a class="struct" href="../../fst/map/struct.Intersection.html" title="struct fst::map::Intersection">Intersection</a><'m></code><a class='srclink' href='../../src/fst/map.rs.html#860-862' title='goto source code'>[src]</a></h4><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>(&[u8], &[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>
|
||
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">fst</span>::{<span class="ident">IntoStreamer</span>, <span class="ident">Streamer</span>, <span class="ident">Map</span>};
|
||
<span class="kw">use</span> <span class="ident">fst</span>::<span class="ident">map</span>::<span class="ident">IndexedValue</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">map1</span> <span class="op">=</span> <span class="ident">Map</span>::<span class="ident">from_iter</span>(<span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">"a"</span>, <span class="number">1</span>), (<span class="string">"b"</span>, <span class="number">2</span>), (<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">map2</span> <span class="op">=</span> <span class="ident">Map</span>::<span class="ident">from_iter</span>(<span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">"a"</span>, <span class="number">11</span>), (<span class="string">"y"</span>, <span class="number">12</span>), (<span class="string">"z"</span>, <span class="number">13</span>),
|
||
]).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">intersection</span> <span class="op">=</span> <span class="ident">map1</span>.<span class="ident">op</span>().<span class="ident">add</span>(<span class="kw-2">&</span><span class="ident">map2</span>).<span class="ident">intersection</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">kvs</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[];
|
||
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>((<span class="ident">k</span>, <span class="ident">vs</span>)) <span class="op">=</span> <span class="ident">intersection</span>.<span class="ident">next</span>() {
|
||
<span class="ident">kvs</span>.<span class="ident">push</span>((<span class="ident">k</span>.<span class="ident">to_vec</span>(), <span class="ident">vs</span>.<span class="ident">to_vec</span>()));
|
||
}
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">kvs</span>, <span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">b"a"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[
|
||
<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">0</span>, <span class="ident">value</span>: <span class="number">1</span> },
|
||
<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">1</span>, <span class="ident">value</span>: <span class="number">11</span> },
|
||
]),
|
||
]);</pre></div>
|
||
</div><h4 id='method.difference' class="method"><code id='difference.v'>pub fn <a href='#method.difference' class='fnname'>difference</a>(self) -> <a class="struct" href="../../fst/map/struct.Difference.html" title="struct fst::map::Difference">Difference</a><'m></code><a class='srclink' href='../../src/fst/map.rs.html#905-907' title='goto source code'>[src]</a></h4><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>(&[u8], &[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>
|
||
<p>While the interface is the same for all the operations combining multiple
|
||
maps, due to the nature of <code>difference</code> there's exactly one <code>IndexValue</code>
|
||
for each yielded value.</p>
|
||
<h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">fst</span>::{<span class="ident">Streamer</span>, <span class="ident">Map</span>};
|
||
<span class="kw">use</span> <span class="ident">fst</span>::<span class="ident">map</span>::<span class="ident">IndexedValue</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">map1</span> <span class="op">=</span> <span class="ident">Map</span>::<span class="ident">from_iter</span>(<span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">"a"</span>, <span class="number">1</span>), (<span class="string">"b"</span>, <span class="number">2</span>), (<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">map2</span> <span class="op">=</span> <span class="ident">Map</span>::<span class="ident">from_iter</span>(<span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">"a"</span>, <span class="number">11</span>), (<span class="string">"y"</span>, <span class="number">12</span>), (<span class="string">"z"</span>, <span class="number">13</span>),
|
||
]).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">difference</span> <span class="op">=</span> <span class="ident">map1</span>.<span class="ident">op</span>().<span class="ident">add</span>(<span class="kw-2">&</span><span class="ident">map2</span>).<span class="ident">difference</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">kvs</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[];
|
||
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>((<span class="ident">k</span>, <span class="ident">vs</span>)) <span class="op">=</span> <span class="ident">difference</span>.<span class="ident">next</span>() {
|
||
<span class="ident">kvs</span>.<span class="ident">push</span>((<span class="ident">k</span>.<span class="ident">to_vec</span>(), <span class="ident">vs</span>.<span class="ident">to_vec</span>()));
|
||
}
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">kvs</span>, <span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">b"b"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">0</span>, <span class="ident">value</span>: <span class="number">2</span> }]),
|
||
(<span class="string">b"c"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">0</span>, <span class="ident">value</span>: <span class="number">3</span> }]),
|
||
]);</pre></div>
|
||
</div><h4 id='method.symmetric_difference' class="method"><code id='symmetric_difference.v'>pub fn <a href='#method.symmetric_difference' class='fnname'>symmetric_difference</a>(self) -> <a class="struct" href="../../fst/map/struct.SymmetricDifference.html" title="struct fst::map::SymmetricDifference">SymmetricDifference</a><'m></code><a class='srclink' href='../../src/fst/map.rs.html#953-955' title='goto source code'>[src]</a></h4><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>(&[u8], &[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>
|
||
<h1 id="example-3" class="section-header"><a href="#example-3">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">fst</span>::{<span class="ident">IntoStreamer</span>, <span class="ident">Streamer</span>, <span class="ident">Map</span>};
|
||
<span class="kw">use</span> <span class="ident">fst</span>::<span class="ident">map</span>::<span class="ident">IndexedValue</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">map1</span> <span class="op">=</span> <span class="ident">Map</span>::<span class="ident">from_iter</span>(<span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">"a"</span>, <span class="number">1</span>), (<span class="string">"b"</span>, <span class="number">2</span>), (<span class="string">"c"</span>, <span class="number">3</span>),
|
||
]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">map2</span> <span class="op">=</span> <span class="ident">Map</span>::<span class="ident">from_iter</span>(<span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">"a"</span>, <span class="number">11</span>), (<span class="string">"y"</span>, <span class="number">12</span>), (<span class="string">"z"</span>, <span class="number">13</span>),
|
||
]).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sym_difference</span> <span class="op">=</span> <span class="ident">map1</span>.<span class="ident">op</span>().<span class="ident">add</span>(<span class="kw-2">&</span><span class="ident">map2</span>).<span class="ident">symmetric_difference</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">kvs</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[];
|
||
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>((<span class="ident">k</span>, <span class="ident">vs</span>)) <span class="op">=</span> <span class="ident">sym_difference</span>.<span class="ident">next</span>() {
|
||
<span class="ident">kvs</span>.<span class="ident">push</span>((<span class="ident">k</span>.<span class="ident">to_vec</span>(), <span class="ident">vs</span>.<span class="ident">to_vec</span>()));
|
||
}
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">kvs</span>, <span class="macro">vec</span><span class="macro">!</span>[
|
||
(<span class="string">b"b"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">0</span>, <span class="ident">value</span>: <span class="number">2</span> }]),
|
||
(<span class="string">b"c"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">0</span>, <span class="ident">value</span>: <span class="number">3</span> }]),
|
||
(<span class="string">b"y"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">1</span>, <span class="ident">value</span>: <span class="number">12</span> }]),
|
||
(<span class="string">b"z"</span>.<span class="ident">to_vec</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">IndexedValue</span> { <span class="ident">index</span>: <span class="number">1</span>, <span class="ident">value</span>: <span class="number">13</span> }]),
|
||
]);</pre></div>
|
||
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Extend%3CI%3E' class='impl'><code class='in-band'>impl<'f, I, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><I> for <a class="struct" href="../../fst/map/struct.OpBuilder.html" title="struct fst::map::OpBuilder">OpBuilder</a><'f> <span class="where fmt-newline">where<br> I: for<'a> <a class="trait" href="../../fst/trait.IntoStreamer.html" title="trait fst::IntoStreamer">IntoStreamer</a><'a, Into = S, Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>,<br> S: 'f + for<'a> <a class="trait" href="../../fst/trait.Streamer.html" title="trait fst::Streamer">Streamer</a><'a, Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>, </span></code><a href='#impl-Extend%3CI%3E' class='anchor'></a><a class='srclink' href='../../src/fst/map.rs.html#958-966' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.extend' class="method hidden"><code id='extend.v'>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#tymethod.extend' class='fnname'>extend</a><T>(&mut self, it: T) <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = I>, </span></code><a class='srclink' href='../../src/fst/map.rs.html#961-965' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Extends a collection with the contents of an iterator. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#tymethod.extend">Read more</a></p>
|
||
</div></div><h3 id='impl-FromIterator%3CI%3E' class='impl'><code class='in-band'>impl<'f, I, S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html" title="trait core::iter::traits::collect::FromIterator">FromIterator</a><I> for <a class="struct" href="../../fst/map/struct.OpBuilder.html" title="struct fst::map::OpBuilder">OpBuilder</a><'f> <span class="where fmt-newline">where<br> I: for<'a> <a class="trait" href="../../fst/trait.IntoStreamer.html" title="trait fst::IntoStreamer">IntoStreamer</a><'a, Into = S, Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>,<br> S: 'f + for<'a> <a class="trait" href="../../fst/trait.Streamer.html" title="trait fst::Streamer">Streamer</a><'a, Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>, </span></code><a href='#impl-FromIterator%3CI%3E' class='anchor'></a><a class='srclink' href='../../src/fst/map.rs.html#968-976' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_iter' class="method hidden"><code id='from_iter.v'>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html#tymethod.from_iter' class='fnname'>from_iter</a><T>(it: T) -> Self <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = I>, </span></code><a class='srclink' href='../../src/fst/map.rs.html#971-975' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates a value from an iterator. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html#tymethod.from_iter">Read more</a></p>
|
||
</div></div></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'><h3 id='impl-Send' class='impl'><code class='in-band'>impl<'m> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../fst/map/struct.OpBuilder.html" title="struct fst::map::OpBuilder">OpBuilder</a><'m></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<'m> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../fst/map/struct.OpBuilder.html" title="struct fst::map::OpBuilder">OpBuilder</a><'m></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-From' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a> for T</code><a href='#impl-From' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#547' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Into' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#537-542' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#539-541' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-TryFrom' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#565-571' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#568-570' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Borrow' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div><h3 id='impl-BorrowMut' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id='impl-TryInto' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-560' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#557-559' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div></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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "fst";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |