<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="An NFA backed Pike VM for executing regex searches with capturing groups."><title>regex_automata::nfa::thompson::pikevm - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../../../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="rustdoc-vars"data-root-path="../../../../"data-static-root-path="../../../../static.files/"data-current-crate="regex_automata"data-themes=""data-resource-suffix=""data-rustdoc-version="1.77.0 (aedd173a2 2024-03-17)"data-channel="1.77.0"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../../../../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="../sidebar-items.js"></script><scriptdefersrc="../../../../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../../../../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../../../../regex_automata/index.html">regex_automata</a><spanclass="version">0.4.6</span></h2></div><h2class="location"><ahref="#">Module pikevm</a></h2><divclass="sidebar-elems"><section><ulclass="block"><li><ahref="#structs">Structs</a></li></ul></section><h2><ahref="../index.html">In regex_automata::nfa::thompson</a></h2></div></nav><divclass="sidebar-resizer"></div>
<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><ahref="../index.html">thompson</a>::<wbr><aclass="mod"href="#">pikevm</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/pikevm.rs.html#1-2359">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>An NFA backed Pike VM for executing regex searches with capturing groups.</p>
<p>This module provides a <ahref="struct.PikeVM.html"title="struct regex_automata::nfa::thompson::pikevm::PikeVM"><code>PikeVM</code></a> that works by simulating an NFA and
resolving all spans of capturing groups that participate in a match.</p>
</div></details><h2id="structs"class="section-header">Structs<ahref="#structs"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.Builder.html"title="struct regex_automata::nfa::thompson::pikevm::Builder">Builder</a></div><divclass="desc docblock-short">A builder for a <code>PikeVM</code>.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Cache.html"title="struct regex_automata::nfa::thompson::pikevm::Cache">Cache</a></div><divclass="desc docblock-short">A cache represents mutable state that a <ahref="struct.PikeVM.html"title="struct regex_automata::nfa::thompson::pikevm::PikeVM"><code>PikeVM</code></a> requires during a
search.</div></li><li><divclass="item-name"><aclass="struct"href="struct.CapturesMatches.html"title="struct regex_automata::nfa::thompson::pikevm::CapturesMatches">CapturesMatches</a></div><divclass="desc docblock-short">An iterator over all non-overlapping leftmost matches, with their capturing
groups, for a particular search.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Config.html"title="struct regex_automata::nfa::thompson::pikevm::Config">Config</a></div><divclass="desc docblock-short">The configuration used for building a <ahref="struct.PikeVM.html"title="struct regex_automata::nfa::thompson::pikevm::PikeVM"><code>PikeVM</code></a>.</div></li><li><divclass="item-name"><aclass="struct"href="struct.FindMatches.html"title="struct regex_automata::nfa::thompson::pikevm::FindMatches">FindMatches</a></div><divclass="desc docblock-short">An iterator over all non-overlapping matches for a particular search.</div></li><li><divclass="item-name"><aclass="struct"href="struct.PikeVM.html"title="struct regex_automata::nfa::thompson::pikevm::PikeVM">PikeVM</a></div><divclass="desc docblock-short">A virtual machine for executing regex searches with capturing groups.</div></li></ul></section></div></main></body></html>
