<!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="A collection of modules that provide APIs that are useful across many regex engines."><title>regex_automata::util - 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-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)"data-channel="1.76.0"data-search-js="search-2b6ce74ff89ae146.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><scriptdefersrc="../sidebar-items.js"></script><scriptdefersrc="../../static.files/main-305769736d49e732.js"></script><noscript><linkrel="stylesheet"href="../../static.files/noscript-feafe1bb7466e4bd.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">☰</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 util</a></h2><divclass="sidebar-elems"><section><ulclass="block"><li><ahref="#modules">Modules</a></li></ul></section><h2><ahref="../index.html">In crate regex_automata</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><aclass="mod"href="#">util</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/util/mod.rs.html#1-57">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>A collection of modules that provide APIs that are useful across many regex
engines.</p>
<p>While one should explore the sub-modules directly to get a sense of what’s
there, here are some highlights that tie the sub-modules to higher level
use cases:</p>
<ul>
<li><code>alphabet</code> contains APIs that are useful if you’re doing low level things
with the DFAs in this crate. For example, implementing determinization or
walking its state graph directly.</li>
<li><code>captures</code> contains APIs for dealing with capture group matches and their
mapping to “slots” used inside an NFA graph. This is also where you can find
iterators over capture group names.</li>
<li><code>escape</code> contains types for pretty-printing raw byte slices as strings.</li>
<li><code>iter</code> contains API helpers for writing regex iterators.</li>
<li><code>lazy</code> contains a no-std and no-alloc variant of <code>lazy_static!</code> and
<code>once_cell</code>.</li>
<li><code>look</code> contains APIs for matching and configuring look-around assertions.</li>
<li><code>pool</code> provides a way to reuse mutable memory allocated in a thread safe
manner.</li>
<li><code>prefilter</code> provides APIs for building prefilters and using them in searches.</li>
<li><code>primitives</code> are what you might use if you’re doing lower level work on
automata, such as walking an NFA state graph.</li>
<li><code>syntax</code> provides some higher level convenience functions for interacting
with the <code>regex-syntax</code> crate.</li>
<li><code>wire</code> is useful if you’re working with DFA serialization.</li>
</ul>
</div></details><h2id="modules"class="section-header"><ahref="#modules">Modules</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="mod"href="alphabet/index.html"title="mod regex_automata::util::alphabet">alphabet</a></div><divclass="desc docblock-short">This module provides APIs for dealing with the alphabets of finite state
machines.</div></li><li><divclass="item-name"><aclass="mod"href="captures/index.html"title="mod regex_automata::util::captures">captures</a></div><divclass="desc docblock-short">Provides types for dealing with capturing groups.</div></li><li><divclass="item-name"><aclass="mod"href="escape/index.html"title="mod regex_automata::util::escape">escape</a></div><divclass="desc docblock-short">Provides convenience routines for escaping raw bytes.</div></li><li><divclass="item-name"><aclass="mod"href="interpolate/index.html"title="mod regex_automata::util::interpolate">interpolate</a></div><divclass="desc docblock-short">Provides routines for interpolating capture group references.</div></li><li><divclass="item-name"><aclass="mod"href="iter/index.html"title="mod regex_automata::util::iter">iter</a></div><divclass="desc docblock-short">Generic helpers for iteration of matches from a regex engine in a haystack.</div></li><li><divclass="item-name"><aclass="mod"href="lazy/index.html"title="mod regex_automata::util::lazy">lazy</a></div><divclass="desc docblock-short">A lazily initialized value for safe sharing between threads.</div></li><li><divclass="item-name"><aclass="mod"href="look/index.html"title="mod regex_automata::util::look">look</a></div><divclass="desc docblock-short">Types and routines for working with look-around assertions.</div></li><li><divclass="item-name"><aclass="mod"href="pool/index.html"title="mod regex_automata::util::pool">pool</a></div><divclass="desc docblock-short">A thread safe memory pool.</div></li><li><divclass="item-name"><aclass="mod"href="prefilter/index.html"title="mod regex_automata::util::prefilter">prefilter</a></div><divclass="desc docblock-short">Defines a prefilter for accelerating regex searches.</div></li><li><divclass="item-name"><aclass="mod"href="primitives/index.html"title="mod regex_automata::util::primitives">primitives</a></div><divclass="desc docblock-short">Lower level primitive types that are useful in a variety of circumstances.</div></li><li><divclass="item-name"><aclass="mod"href="start/index.html"title="mod regex_automata::util::start">start</a></div><divclass="desc docblock-short">Provides helpers for dealing with start state configurations in DFAs.</div></li><li><divclass="item-name"><aclass="mod"href="syntax/index.html"title="mod regex_automata::util::syntax">syntax</a></div><divclass="desc docblock-short">Utilities for dealing with the syntax of a regular expression.</div></li><li><divclass="item-name"><aclass="mod"href="wire/index.html"title="mod regex_automata::util::wire">wire</a></div><divclass="desc docblock-short">Types and routines that support the wire format of finite automata.</div></li></ul></section></div></main></body></html>
