<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../../regex_automata/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Module <ahref="../../index.html">regex_automata</a>::<wbr><ahref="../index.html">nfa</a>::<wbr><aclass="mod"href="#">thompson</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../../src/regex_automata/nfa/thompson/mod.rs.html#1-81">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Defines a Thompson NFA and provides the <ahref="pikevm/struct.PikeVM.html"title="struct regex_automata::nfa::thompson::pikevm::PikeVM"><code>PikeVM</code></a> and
<p>A Thompson NFA (non-deterministic finite automaton) is arguably <em>the</em> central
data type in this library. It is the result of what is commonly referred to as
“regex compilation.” That is, turning a regex pattern from its concrete syntax
string into something that can run a search looks roughly like this:</p>
<ul>
<li>A <code>&str</code> is parsed into a <ahref="../../../regex_syntax/ast/enum.Ast.html"title="enum regex_syntax::ast::Ast"><code>regex-syntax::ast::Ast</code></a>.</li>
<li>An <code>Ast</code> is translated into a <ahref="../../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir"><code>regex-syntax::hir::Hir</code></a>.</li>
<li>An <code>Hir</code> is compiled into a <ahref="struct.NFA.html"title="struct regex_automata::nfa::thompson::NFA"><code>NFA</code></a>.</li>
<li>The <code>NFA</code> is then used to build one of a few different regex engines:
<ul>
<li>An <code>NFA</code> is used directly in the <code>PikeVM</code> and <code>BoundedBacktracker</code> engines.</li>
</div></details><h2id="modules"class="section-header">Modules<ahref="#modules"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="mod"href="pikevm/index.html"title="mod regex_automata::nfa::thompson::pikevm">pikevm</a></div><divclass="desc docblock-short">An NFA backed Pike VM for executing regex searches with capturing groups.</div></li></ul><h2id="structs"class="section-header">Structs<ahref="#structs"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.BuildError.html"title="struct regex_automata::nfa::thompson::BuildError">BuildError</a></div><divclass="desc docblock-short">An error that can occurred during the construction of a thompson NFA.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Builder.html"title="struct regex_automata::nfa::thompson::Builder">Builder</a></div><divclass="desc docblock-short">An abstraction for building Thompson NFAs by hand.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Compiler.html"title="struct regex_automata::nfa::thompson::Compiler">Compiler</a></div><divclass="desc docblock-short">A builder for compiling an NFA from a regex’s high-level intermediate
representation (HIR).</div></li><li><divclass="item-name"><aclass="struct"href="struct.Config.html"title="struct regex_automata::nfa::thompson::Config">Config</a></div><divclass="desc docblock-short">The configuration used for a Thompson NFA compiler.</div></li><li><divclass="item-name"><aclass="struct"href="struct.DenseTransitions.html"title="struct regex_automata::nfa::thompson::DenseTransitions">DenseTransitions</a></div><divclass="desc docblock-short">A sequence of transitions used to represent a dense state.</div></li><li><divclass="item-name"><aclass="struct"href="struct.NFA.html"title="struct regex_automata::nfa::thompson::NFA">NFA</a></div><divclass="desc docblock-short">A byte oriented Thompson non-deterministic finite automaton (NFA).</div></li><li><divclass="item-name"><aclass="struct"href="struct.PatternIter.html"title="struct regex_automata::nfa::thompson::PatternIter">PatternIter</a></div><divclass="desc docblock-short">An iterator over all pattern IDs in an NFA.</div></li><li><divclass="item-name"><aclass="struct"href="struct.SparseTransitions.html"title="struct regex_automata::nfa::thompson::SparseTransitions">SparseTransitions</a></div><divclass="desc docblock-short">A sequence of transitions used to represent a sparse state.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Transition.html"title="struct regex_automata::nfa::thompson::Transition">Transition</a></div><divclass="desc docblock-short">A single transition to another state.</div></li></ul><h2id="enums"class="section-header">Enums<ahref="#enums"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.State.html"title="enum regex_automata::nfa::thompson::State">State</a></div><divclass="desc docblock-short">A state in an NFA.</div></li><li><divclass="item-name"><aclass="enum"href="enum.WhichCaptures.html"title="enum regex_automata::nfa::thompson::WhichCaptures">WhichCaptures</a></div><divclass="desc docblock-short">A configuration indicating which kinds of
<ahref="enum.State.html#variant.Capture"title="variant regex_automata::nfa::thompson::State::Capture"><code>State::Capture</code></a> states to include.</div></li></ul></section></div></main></body></html>
