| <!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="Operations on raw finite state transducers."><meta name="keywords" content="rust, rustlang, rust-lang, raw"><title>tantivy_fst::raw - 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="../../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 mod"><!--[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">☰</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="#">Module raw</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#types">Type Definitions</a></li></ul></section></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">Module <a href="../index.html">tantivy_fst</a>::<wbr><a class="mod" href="#">raw</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/raw/mod.rs.html#1-1324">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Operations on raw finite state transducers.</p> |
| <p>This sub-module exposes the guts of a finite state transducer. Many parts of |
| it, such as construction and traversal, are mirrored in the <code>set</code> and <code>map</code> |
| sub-modules. Other parts of it, such as direct access to nodes and transitions |
| in the transducer, do not have any analog.</p> |
| <h2 id="overview-of-types"><a href="#overview-of-types">Overview of types</a></h2> |
| <p><code>Fst</code> is a read only interface to pre-constructed finite state transducers. |
| <code>Node</code> is a read only interface to a single node in a transducer. <code>Builder</code> is |
| used to create new finite state transducers. (Once a transducer is created, it |
| can never be modified.) <code>Stream</code> is a stream of all inputs and outputs in a |
| transducer. <code>StreamBuilder</code> builds range queries. <code>OpBuilder</code> collects streams |
| and executes set operations like <code>union</code> or <code>intersection</code> on them with the |
| option of specifying a merge strategy for output values.</p> |
| <p>Most of the rest of the types are streams from set operations.</p> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Builder.html" title="tantivy_fst::raw::Builder struct">Builder</a></div><div class="item-right docblock-short">A builder for creating a finite state transducer.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Chain.html" title="tantivy_fst::raw::Chain struct">Chain</a></div><div class="item-right docblock-short">A stream of chaining multiple fst streams in added order.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Difference.html" title="tantivy_fst::raw::Difference struct">Difference</a></div><div class="item-right docblock-short">A stream of set difference over multiple fst streams in lexicographic |
| order.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Fst.html" title="tantivy_fst::raw::Fst struct">Fst</a></div><div class="item-right docblock-short">An acyclic deterministic finite state transducer.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IndexedValue.html" title="tantivy_fst::raw::IndexedValue struct">IndexedValue</a></div><div class="item-right docblock-short">A value indexed by a stream.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Intersection.html" title="tantivy_fst::raw::Intersection struct">Intersection</a></div><div class="item-right docblock-short">A stream of set intersection over multiple fst streams in lexicographic |
| order.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Node.html" title="tantivy_fst::raw::Node struct">Node</a></div><div class="item-right docblock-short">Node represents a single state in a finite state transducer.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OpBuilder.html" title="tantivy_fst::raw::OpBuilder struct">OpBuilder</a></div><div class="item-right docblock-short">A builder for collecting fst streams on which to perform set operations |
| on the keys of fsts.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Output.html" title="tantivy_fst::raw::Output struct">Output</a></div><div class="item-right docblock-short">An output is a value that is associated with a key in a finite state |
| transducer.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Stream.html" title="tantivy_fst::raw::Stream struct">Stream</a></div><div class="item-right docblock-short">Stream of <code>key, value</code> not exposing the state of the automaton.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StreamBuilder.html" title="tantivy_fst::raw::StreamBuilder struct">StreamBuilder</a></div><div class="item-right docblock-short">A builder for constructing range queries on streams.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StreamWithState.html" title="tantivy_fst::raw::StreamWithState struct">StreamWithState</a></div><div class="item-right docblock-short">A lexicographically ordered stream from an fst |
| of key-value pairs along with the state of the automaton.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StreamWithStateBuilder.html" title="tantivy_fst::raw::StreamWithStateBuilder struct">StreamWithStateBuilder</a></div><div class="item-right docblock-short">A builder for constructing range queries of streams |
| that returns results along with automaton states.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SymmetricDifference.html" title="tantivy_fst::raw::SymmetricDifference struct">SymmetricDifference</a></div><div class="item-right docblock-short">A stream of set symmetric difference over multiple fst streams in |
| lexicographic order.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Transition.html" title="tantivy_fst::raw::Transition struct">Transition</a></div><div class="item-right docblock-short">A transition from one note to another.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Transitions.html" title="tantivy_fst::raw::Transitions struct">Transitions</a></div><div class="item-right docblock-short">An iterator over all transitions in a node.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Union.html" title="tantivy_fst::raw::Union struct">Union</a></div><div class="item-right docblock-short">A stream of set union over multiple fst streams in lexicographic order.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Error.html" title="tantivy_fst::raw::Error enum">Error</a></div><div class="item-right docblock-short">An error that occurred while using a finite state transducer.</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.VERSION.html" title="tantivy_fst::raw::VERSION constant">VERSION</a></div><div class="item-right docblock-short">The API version of this crate.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.CompiledAddr.html" title="tantivy_fst::raw::CompiledAddr type">CompiledAddr</a></div><div class="item-right docblock-short">CompiledAddr is the type used to address nodes in a finite state |
| transducer.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.FstType.html" title="tantivy_fst::raw::FstType type">FstType</a></div><div class="item-right docblock-short">FstType is a convention used to indicate the type of the underlying |
| transducer.</div></div></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> |
