mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-28 14:10:42 +00:00
87 lines
8.6 KiB
HTML
87 lines
8.6 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 `automaton` mod in crate `fst`."><meta name="keywords" content="rust, rustlang, rust-lang, automaton"><title>fst::automaton - 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></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 automaton</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'><a href='../index.html'>fst</a></p><script>window.sidebarCurrent = {name: 'automaton', 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"><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='in-band'>Module <a href='../index.html'>fst</a>::<wbr><a class="mod" href=''>automaton</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#335-337' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Automaton implementations for finite state transducers.</p>
|
||
<p>This module defines a trait, <code>Automaton</code>, with several implementations
|
||
including, but not limited to, union, intersection and complement.</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.AlwaysMatch.html"
|
||
title='struct fst::automaton::AlwaysMatch'>AlwaysMatch</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An automaton that always matches.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Complement.html"
|
||
title='struct fst::automaton::Complement'>Complement</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An automaton that matches exactly when the automaton it wraps does not.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ComplementState.html"
|
||
title='struct fst::automaton::ComplementState'>ComplementState</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The <code>Automaton</code> state for <code>Complement<A></code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Intersection.html"
|
||
title='struct fst::automaton::Intersection'>Intersection</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An automaton that matches when both of its component automata match.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.IntersectionState.html"
|
||
title='struct fst::automaton::IntersectionState'>IntersectionState</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The <code>Automaton</code> state for <code>Intersection<A, B></code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.StartsWith.html"
|
||
title='struct fst::automaton::StartsWith'>StartsWith</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An automaton that matches a string that begins with something that the
|
||
wrapped automaton matches.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.StartsWithState.html"
|
||
title='struct fst::automaton::StartsWithState'>StartsWithState</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The <code>Automaton</code> state for <code>StartsWith<A></code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Union.html"
|
||
title='struct fst::automaton::Union'>Union</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An automaton that matches when one of its component automata match.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.UnionState.html"
|
||
title='struct fst::automaton::UnionState'>UnionState</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The <code>Automaton</code> state for <code>Union<A, B></code>.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Automaton.html"
|
||
title='trait fst::automaton::Automaton'>Automaton</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Automaton describes types that behave as a finite automaton.</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> |