blob: 28abe0ece6279b76f906baca2ba72b8f0d9bcb3c [file] [log] [blame]
<!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="Automaton implementations for finite state transducers."><meta name="keywords" content="rust, rustlang, rust-lang, automaton"><title>tantivy_fst::automaton - 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">&#9776;</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 automaton</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</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="#">automaton</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/lib.rs.html#32">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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></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.AlwaysMatch.html" title="tantivy_fst::automaton::AlwaysMatch struct">AlwaysMatch</a></div><div class="item-right docblock-short">An automaton that always matches.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Complement.html" title="tantivy_fst::automaton::Complement struct">Complement</a></div><div class="item-right docblock-short">An automaton that matches exactly when the automaton it wraps does not.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ComplementState.html" title="tantivy_fst::automaton::ComplementState struct">ComplementState</a></div><div class="item-right docblock-short">The <code>Automaton</code> state for <code>Complement&lt;A&gt;</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Intersection.html" title="tantivy_fst::automaton::Intersection struct">Intersection</a></div><div class="item-right docblock-short">An automaton that matches when both of its component automata match.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntersectionState.html" title="tantivy_fst::automaton::IntersectionState struct">IntersectionState</a></div><div class="item-right docblock-short">The <code>Automaton</code> state for <code>Intersection&lt;A, B&gt;</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StartsWith.html" title="tantivy_fst::automaton::StartsWith struct">StartsWith</a></div><div class="item-right docblock-short">An automaton that matches a string that begins with something that the
wrapped automaton matches.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StartsWithState.html" title="tantivy_fst::automaton::StartsWithState struct">StartsWithState</a></div><div class="item-right docblock-short">The <code>Automaton</code> state for <code>StartsWith&lt;A&gt;</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Subsequence.html" title="tantivy_fst::automaton::Subsequence struct">Subsequence</a></div><div class="item-right docblock-short">An automaton that matches if the input contains a specific subsequence.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Union.html" title="tantivy_fst::automaton::Union struct">Union</a></div><div class="item-right docblock-short">An automaton that matches when one of its component automata match.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnionState.html" title="tantivy_fst::automaton::UnionState struct">UnionState</a></div><div class="item-right docblock-short">The <code>Automaton</code> state for <code>Union&lt;A, B&gt;</code>.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Automaton.html" title="tantivy_fst::automaton::Automaton trait">Automaton</a></div><div class="item-right docblock-short">Automaton describes types that behave as a finite automaton.</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>