28 lines
7.0 KiB
HTML
28 lines
7.0 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="A collection of modules that provide APIs that are useful across many regex engines."><title>regex_automata::util - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Module util</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../regex_automata/index.html">regex_<wbr>automata</a><span class="version">0.4.14</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module util</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate regex_<wbr>automata</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">regex_automata</a></div><h1>Module <span>util</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/regex_automata/util/mod.rs.html#1-57">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="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><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="alphabet/index.html" title="mod regex_automata::util::alphabet">alphabet</a></dt><dd>This module provides APIs for dealing with the alphabets of finite state
|
||
machines.</dd><dt><a class="mod" href="captures/index.html" title="mod regex_automata::util::captures">captures</a></dt><dd>Provides types for dealing with capturing groups.</dd><dt><a class="mod" href="escape/index.html" title="mod regex_automata::util::escape">escape</a></dt><dd>Provides convenience routines for escaping raw bytes.</dd><dt><a class="mod" href="interpolate/index.html" title="mod regex_automata::util::interpolate">interpolate</a></dt><dd>Provides routines for interpolating capture group references.</dd><dt><a class="mod" href="iter/index.html" title="mod regex_automata::util::iter">iter</a></dt><dd>Generic helpers for iteration of matches from a regex engine in a haystack.</dd><dt><a class="mod" href="lazy/index.html" title="mod regex_automata::util::lazy">lazy</a></dt><dd>A lazily initialized value for safe sharing between threads.</dd><dt><a class="mod" href="look/index.html" title="mod regex_automata::util::look">look</a></dt><dd>Types and routines for working with look-around assertions.</dd><dt><a class="mod" href="pool/index.html" title="mod regex_automata::util::pool">pool</a></dt><dd>A thread safe memory pool.</dd><dt><a class="mod" href="prefilter/index.html" title="mod regex_automata::util::prefilter">prefilter</a></dt><dd>Defines a prefilter for accelerating regex searches.</dd><dt><a class="mod" href="primitives/index.html" title="mod regex_automata::util::primitives">primitives</a></dt><dd>Lower level primitive types that are useful in a variety of circumstances.</dd><dt><a class="mod" href="start/index.html" title="mod regex_automata::util::start">start</a></dt><dd>Provides helpers for dealing with start state configurations in DFAs.</dd><dt><a class="mod" href="syntax/index.html" title="mod regex_automata::util::syntax">syntax</a></dt><dd>Utilities for dealing with the syntax of a regular expression.</dd><dt><a class="mod" href="wire/index.html" title="mod regex_automata::util::wire">wire</a></dt><dd>Types and routines that support the wire format of finite automata.</dd></dl></section></div></main></body></html> |