<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="#">meta</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/meta/mod.rs.html#1-62">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>Provides a regex matcher that composes several other regex matchers
automatically.</p>
<p>This module is home to a meta <ahref="struct.Regex.html"title="struct regex_automata::meta::Regex"><code>Regex</code></a>, which provides a convenient high
level API for executing regular expressions in linear time.</p>
<h2id="comparison-with-the-regex-crate"><aclass="doc-anchor"href="#comparison-with-the-regex-crate">§</a>Comparison with the <code>regex</code> crate</h2>
will handle the replacement string interpolation for you.</li>
<li>A meta <code>Regex</code> supports the <ahref="../struct.Input.html"title="struct regex_automata::Input"><code>Input</code></a> abstraction, which
provides a way to configure a search in more ways than is supported by the
<code>regex</code> crate. For example, <ahref="../struct.Input.html#method.anchored"title="method regex_automata::Input::anchored"><code>Input::anchored</code></a> can
be used to run an anchored search, regardless of whether the pattern is itself
anchored with a <code>^</code>.</li>
<li>A meta <code>Regex</code> supports multi-pattern searching everywhere.
Indeed, every <ahref="../struct.Match.html"title="struct regex_automata::Match"><code>Match</code></a> returned by the search APIs
include a <ahref="../struct.PatternID.html"title="struct regex_automata::PatternID"><code>PatternID</code></a> indicating which pattern
matched. In the single pattern case, all matches correspond to
<ahref="../struct.PatternID.html#associatedconstant.ZERO"title="associated constant regex_automata::PatternID::ZERO"><code>PatternID::ZERO</code></a>. In contrast, the <code>regex</code> crate
has distinct <code>Regex</code> and a <code>RegexSet</code> APIs. The former only supports a single
pattern, while the latter supports multiple patterns but cannot report the
offsets of a match.</li>
<li>A meta <code>Regex</code> provides the explicit capability of bypassing its internal
memory pool for automatically acquiring mutable scratch space required by its
internal regex engines. Namely, a <ahref="struct.Cache.html"title="struct regex_automata::meta::Cache"><code>Cache</code></a> can be explicitly provided to lower
level routines such as <ahref="struct.Regex.html#method.search_with"title="method regex_automata::meta::Regex::search_with"><code>Regex::search_with</code></a>.</li>
</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.BuildError.html"title="struct regex_automata::meta::BuildError">BuildError</a></div><divclass="desc docblock-short">An error that occurs when construction of a <code>Regex</code> fails.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Builder.html"title="struct regex_automata::meta::Builder">Builder</a></div><divclass="desc docblock-short">A builder for configuring and constructing a <code>Regex</code>.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Cache.html"title="struct regex_automata::meta::Cache">Cache</a></div><divclass="desc docblock-short">Represents mutable scratch space used by regex engines during a search.</div></li><li><divclass="item-name"><aclass="struct"href="struct.CapturesMatches.html"title="struct regex_automata::meta::CapturesMatches">CapturesMatches</a></div><divclass="desc docblock-short">An iterator over all non-overlapping leftmost matches with their capturing
groups.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Config.html"title="struct regex_automata::meta::Config">Config</a></div><divclass="desc docblock-short">An object describing the configuration of a <code>Regex</code>.</div></li><li><divclass="item-name"><aclass="struct"href="struct.FindMatches.html"title="struct regex_automata::meta::FindMatches">FindMatches</a></div><divclass="desc docblock-short">An iterator over all non-overlapping matches.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Regex.html"title="struct regex_automata::meta::Regex">Regex</a></div><divclass="desc docblock-short">A regex matcher that works by composing several other regex matchers
automatically.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Split.html"title="struct regex_automata::meta::Split">Split</a></div><divclass="desc docblock-short">Yields all substrings delimited by a regular expression match.</div></li><li><divclass="item-name"><aclass="struct"href="struct.SplitN.html"title="struct regex_automata::meta::SplitN">SplitN</a></div><divclass="desc docblock-short">Yields at most <code>N</code> spans delimited by a regular expression match.</div></li></ul></section></div></main></body></html>
