219 lines
21 KiB
HTML
219 lines
21 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="API documentation for the Rust `RegexBuilder` struct in crate `regex`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, RegexBuilder">
|
|||
|
|
|
|||
|
|
<title>regex::RegexBuilder - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../normalize.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../rustdoc.css"
|
|||
|
|
id="mainThemeStyle">
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc struct">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct RegexBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.build">build</a><a href="#method.case_insensitive">case_insensitive</a><a href="#method.multi_line">multi_line</a><a href="#method.dot_matches_new_line">dot_matches_new_line</a><a href="#method.swap_greed">swap_greed</a><a href="#method.ignore_whitespace">ignore_whitespace</a><a href="#method.unicode">unicode</a><a href="#method.octal">octal</a><a href="#method.size_limit">size_limit</a><a href="#method.dfa_size_limit">dfa_size_limit</a><a href="#method.nest_limit">nest_limit</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>regex</a></p><script>window.sidebarCurrent = {name: 'RegexBuilder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../theme.js"></script>
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>regex</a>::<wbr><a class="struct" href=''>RegexBuilder</a></span><span class='out-of-band'><span id='render-detail'>
|
|||
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|||
|
|
[<span class='inner'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../src/regex/re_builder.rs.html#60' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct RegexBuilder(_);</pre></div><div class='docblock'><p>A configurable builder for a regular expression.</p>
|
|||
|
|
<p>A builder can be used to configure how the regex is built, for example, by
|
|||
|
|
setting the default flags (which can be overridden in the expression
|
|||
|
|
itself) or setting various limits.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#62-220' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(pattern: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#67-71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new regular expression builder with the given pattern.</p>
|
|||
|
|
<p>If the pattern is invalid, then an error will be returned when
|
|||
|
|
<code>build</code> is called.</p>
|
|||
|
|
</div><h4 id='method.build' class="method"><span id='build.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build' class='fnname'>build</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../regex/struct.Regex.html" title="struct regex::Regex">Regex</a>, <a class="enum" href="../regex/enum.Error.html" title="enum regex::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#78-83' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Consume the builder and compile the regular expression.</p>
|
|||
|
|
<p>Note that calling <code>as_str</code> on the resulting <code>Regex</code> will produce the
|
|||
|
|
pattern given to <code>new</code> verbatim. Notably, it will not incorporate any
|
|||
|
|
of the flags set on this builder.</p>
|
|||
|
|
</div><h4 id='method.case_insensitive' class="method"><span id='case_insensitive.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.case_insensitive' class='fnname'>case_insensitive</a>(&mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#89-92' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the value for the case insensitive (<code>i</code>) flag.</p>
|
|||
|
|
<p>When enabled, letters in the pattern will match both upper case and
|
|||
|
|
lower case variants.</p>
|
|||
|
|
</div><h4 id='method.multi_line' class="method"><span id='multi_line.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.multi_line' class='fnname'>multi_line</a>(&mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#100-103' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the value for the multi-line matching (<code>m</code>) flag.</p>
|
|||
|
|
<p>When enabled, <code>^</code> matches the beginning of lines and <code>$</code> matches the
|
|||
|
|
end of lines.</p>
|
|||
|
|
<p>By default, they match beginning/end of the input.</p>
|
|||
|
|
</div><h4 id='method.dot_matches_new_line' class="method"><span id='dot_matches_new_line.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.dot_matches_new_line' class='fnname'>dot_matches_new_line</a>(&mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#112-115' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the value for the any character (<code>s</code>) flag, where in <code>.</code> matches
|
|||
|
|
anything when <code>s</code> is set and matches anything except for new line when
|
|||
|
|
it is not set (the default).</p>
|
|||
|
|
<p>N.B. "matches anything" means "any byte" for <code>regex::bytes::Regex</code>
|
|||
|
|
expressions and means "any Unicode scalar value" for <code>regex::Regex</code>
|
|||
|
|
expressions.</p>
|
|||
|
|
</div><h4 id='method.swap_greed' class="method"><span id='swap_greed.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.swap_greed' class='fnname'>swap_greed</a>(&mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#123-126' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the value for the greedy swap (<code>U</code>) flag.</p>
|
|||
|
|
<p>When enabled, a pattern like <code>a*</code> is lazy (tries to find shortest
|
|||
|
|
match) and <code>a*?</code> is greedy (tries to find longest match).</p>
|
|||
|
|
<p>By default, <code>a*</code> is greedy and <code>a*?</code> is lazy.</p>
|
|||
|
|
</div><h4 id='method.ignore_whitespace' class="method"><span id='ignore_whitespace.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.ignore_whitespace' class='fnname'>ignore_whitespace</a>(&mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#133-136' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the value for the ignore whitespace (<code>x</code>) flag.</p>
|
|||
|
|
<p>When enabled, whitespace such as new lines and spaces will be ignored
|
|||
|
|
between expressions of the pattern, and <code>#</code> can be used to start a
|
|||
|
|
comment until the next new line.</p>
|
|||
|
|
</div><h4 id='method.unicode' class="method"><span id='unicode.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.unicode' class='fnname'>unicode</a>(&mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#142-145' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the value for the Unicode (<code>u</code>) flag.</p>
|
|||
|
|
<p>Enabled by default. When disabled, character classes such as <code>\w</code> only
|
|||
|
|
match ASCII word characters instead of all Unicode word characters.</p>
|
|||
|
|
</div><h4 id='method.octal' class="method"><span id='octal.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.octal' class='fnname'>octal</a>(&mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#162-165' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Whether to support octal syntax or not.</p>
|
|||
|
|
<p>Octal syntax is a little-known way of uttering Unicode codepoints in
|
|||
|
|
a regular expression. For example, <code>a</code>, <code>\x61</code>, <code>\u0061</code> and
|
|||
|
|
<code>\141</code> are all equivalent regular expressions, where the last example
|
|||
|
|
shows octal syntax.</p>
|
|||
|
|
<p>While supporting octal syntax isn't in and of itself a problem, it does
|
|||
|
|
make good error messages harder. That is, in PCRE based regex engines,
|
|||
|
|
syntax like <code>\0</code> invokes a backreference, which is explicitly
|
|||
|
|
unsupported in Rust's regex engine. However, many users expect it to
|
|||
|
|
be supported. Therefore, when octal support is disabled, the error
|
|||
|
|
message will explicitly mention that backreferences aren't supported.</p>
|
|||
|
|
<p>Octal syntax is disabled by default.</p>
|
|||
|
|
</div><h4 id='method.size_limit' class="method"><span id='size_limit.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.size_limit' class='fnname'>size_limit</a>(&mut self, limit: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> &mut <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#172-175' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the approximate size limit of the compiled regular expression.</p>
|
|||
|
|
<p>This roughly corresponds to the number of bytes occupied by a single
|
|||
|
|
compiled program. If the program exceeds this number, then a
|
|||
|
|
compilation error is returned.</p>
|
|||
|
|
</div><h4 id='method.dfa_size_limit' class="method"><span id='dfa_size_limit.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.dfa_size_limit' class='fnname'>dfa_size_limit</a>(&mut self, limit: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> &mut <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#186-189' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the approximate size of the cache used by the DFA.</p>
|
|||
|
|
<p>This roughly corresponds to the number of bytes that the DFA will
|
|||
|
|
use while searching.</p>
|
|||
|
|
<p>Note that this is a <em>per thread</em> limit. There is no way to set a global
|
|||
|
|
limit. In particular, if a regex is used from multiple threads
|
|||
|
|
simultaneously, then each thread may use up to the number of bytes
|
|||
|
|
specified here.</p>
|
|||
|
|
</div><h4 id='method.nest_limit' class="method"><span id='nest_limit.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.nest_limit' class='fnname'>nest_limit</a>(&mut self, limit: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> &mut <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_builder.rs.html#216-219' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the nesting limit for this parser.</p>
|
|||
|
|
<p>The nesting limit controls how deep the abstract syntax tree is allowed
|
|||
|
|
to be. If the AST exceeds the given limit (e.g., with too many nested
|
|||
|
|
groups), then an error is returned by the parser.</p>
|
|||
|
|
<p>The purpose of this limit is to act as a heuristic to prevent stack
|
|||
|
|
overflow for consumers that do structural induction on an <code>Ast</code> using
|
|||
|
|
explicit recursion. While this crate never does this (instead using
|
|||
|
|
constant stack space and moving the call stack to the heap), other
|
|||
|
|
crates may.</p>
|
|||
|
|
<p>This limit is not checked until the entire Ast is parsed. Therefore,
|
|||
|
|
if callers want to put a limit on the amount of heap space used, then
|
|||
|
|
they should impose a limit on the length, in bytes, of the concrete
|
|||
|
|
pattern string. In particular, this is viable since this parser
|
|||
|
|
implementation will limit itself to heap space proportional to the
|
|||
|
|
lenth of the pattern string.</p>
|
|||
|
|
<p>Note that a nest limit of <code>0</code> will return a nest limit error for most
|
|||
|
|
patterns but not all. For example, a nest limit of <code>0</code> permits <code>a</code> but
|
|||
|
|
not <code>ab</code>, since <code>ab</code> requires a concatenation, which results in a nest
|
|||
|
|
depth of <code>1</code>. In general, a nest limit is not something that manifests
|
|||
|
|
in an obvious way in the concrete syntax, therefore, it should not be
|
|||
|
|
used in a granular way.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='implementations-list'>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='synthetic-implementations' class='small-section-header'>
|
|||
|
|
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='synthetic-implementations-list'>
|
|||
|
|
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../regex/struct.RegexBuilder.html" title="struct regex::RegexBuilder">RegexBuilder</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "regex";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|