mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-27 05:30:45 +00:00
28 lines
7.4 KiB
HTML
28 lines
7.4 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 `set` mod in crate `fst`."><meta name="keywords" content="rust, rustlang, rust-lang, set"><title>fst::set - 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 mod"><!--[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'>Module set</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'><a href='../index.html'>fst</a></p><script>window.sidebarCurrent = {name: 'set', ty: 'mod', 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/lib.rs.html#377-379' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>fst</a>::<wbr><a class="mod" href=''>set</a></span></h1><div class='docblock'><p>Set operations implemented by finite state transducers.</p>
|
||
<p>This API provided by this sub-module is close in spirit to the API
|
||
provided by
|
||
<a href="http://doc.rust-lang.org/stable/std/collections/struct.BTreeSet.html"><code>std::collections::BTreeSet</code></a>.
|
||
The principle difference, as with everything else in this crate, is that
|
||
operations are performed on streams of byte strings instead of generic
|
||
iterators. Another difference is that most of the set operations (union,
|
||
intersection, difference and symmetric difference) work on multiple sets at
|
||
the same time, instead of two.</p>
|
||
<h1 id="overview-of-types" class="section-header"><a href="#overview-of-types">Overview of types</a></h1>
|
||
<p><code>Set</code> is a read only interface to pre-constructed sets. <code>SetBuilder</code> is
|
||
used to create new sets. (Once a set is created, it can never be modified.)
|
||
<code>Stream</code> is a stream of values that originated from a set (analogous to an
|
||
iterator). <code>StreamBuilder</code> builds range queries. <code>OpBuilder</code> collects a set
|
||
of streams and executes set operations like <code>union</code> or <code>intersection</code> on
|
||
them. The rest of the types are streams for set operations.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Difference.html" title='fst::set::Difference struct'>Difference</a></td><td class='docblock-short'><p>A stream of set difference over multiple streams in lexicographic order.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Intersection.html" title='fst::set::Intersection struct'>Intersection</a></td><td class='docblock-short'><p>A stream of set intersection over multiple streams in lexicographic order.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.OpBuilder.html" title='fst::set::OpBuilder struct'>OpBuilder</a></td><td class='docblock-short'><p>A builder for collecting set streams on which to perform set operations.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Set.html" title='fst::set::Set struct'>Set</a></td><td class='docblock-short'><p>Set is a lexicographically ordered set of byte strings.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SetBuilder.html" title='fst::set::SetBuilder struct'>SetBuilder</a></td><td class='docblock-short'><p>A builder for creating a set.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Stream.html" title='fst::set::Stream struct'>Stream</a></td><td class='docblock-short'><p>A lexicographically ordered stream of keys from a set.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.StreamBuilder.html" title='fst::set::StreamBuilder struct'>StreamBuilder</a></td><td class='docblock-short'><p>A builder for constructing range queries on streams.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SymmetricDifference.html" title='fst::set::SymmetricDifference struct'>SymmetricDifference</a></td><td class='docblock-short'><p>A stream of set symmetric difference over multiple streams in lexicographic
|
||
order.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Union.html" title='fst::set::Union struct'>Union</a></td><td class='docblock-short'><p>A stream of set union over multiple streams in lexicographic order.</p>
|
||
</td></tr></table></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> |