mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-20 10:10:42 +00:00
241 lines
11 KiB
HTML
241 lines
11 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 `map` mod in crate `fst`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, map">
|
||
|
||
<title>fst::map - 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="../../main.css" id="themeStyle">
|
||
<script src="../../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</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>
|
||
|
||
<p class='location'>Module map</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: 'map', 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">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>fst</a>::<wbr><a class="mod" href=''>map</a></span><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#354-356' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>Map 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.BTreeMap.html"><code>std::collections::BTreeMap</code></a>.</p>
|
||
<h1 id="overview-of-types" class="section-header"><a href="#overview-of-types">Overview of types</a></h1>
|
||
<p><code>Map</code> is a read only interface to pre-constructed sets. <code>MapBuilder</code> is
|
||
used to create new sets. (Once a set is created, it can never be modified.)
|
||
<code>Stream</code>, <code>Keys</code> and <code>Values</code> are streams that originated from a map.
|
||
<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 with the
|
||
option of specifying a merge strategy for a map's values. 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='struct fst::map::Difference'>Difference</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A stream of set difference over multiple map streams in lexicographic
|
||
order.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.IndexedValue.html"
|
||
title='struct fst::map::IndexedValue'>IndexedValue</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A value indexed by a stream.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Intersection.html"
|
||
title='struct fst::map::Intersection'>Intersection</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A stream of set intersection over multiple map streams in lexicographic
|
||
order.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Keys.html"
|
||
title='struct fst::map::Keys'>Keys</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A lexicographically ordered stream of keys from a map.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Map.html"
|
||
title='struct fst::map::Map'>Map</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Map is a lexicographically ordered map from byte strings to integers.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.MapBuilder.html"
|
||
title='struct fst::map::MapBuilder'>MapBuilder</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A builder for creating a map.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.OpBuilder.html"
|
||
title='struct fst::map::OpBuilder'>OpBuilder</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A builder for collecting map streams on which to perform set operations
|
||
on the keys of maps.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Stream.html"
|
||
title='struct fst::map::Stream'>Stream</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A lexicographically ordered stream of key-value pairs from a map.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.StreamBuilder.html"
|
||
title='struct fst::map::StreamBuilder'>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='struct fst::map::SymmetricDifference'>SymmetricDifference</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A stream of set symmetric difference over multiple map streams in
|
||
lexicographic order.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Union.html"
|
||
title='struct fst::map::Union'>Union</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A stream of set union over multiple map streams in lexicographic order.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Values.html"
|
||
title='struct fst::map::Values'>Values</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A stream of values from a map, lexicographically ordered by each value's
|
||
corresponding key.</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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../";
|
||
window.currentCrate = "fst";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |