218 lines
No EOL
25 KiB
HTML
218 lines
No EOL
25 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 `ParserBuilder` struct in crate `regex_syntax`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, ParserBuilder">
|
||
|
||
<title>regex_syntax::ParserBuilder - 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 ParserBuilder</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.nest_limit">nest_limit</a><a href="#method.octal">octal</a><a href="#method.allow_invalid_utf8">allow_invalid_utf8</a><a href="#method.ignore_whitespace">ignore_whitespace</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.unicode">unicode</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</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_syntax</a></p><script>window.sidebarCurrent = {name: 'ParserBuilder', 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_syntax</a>::<wbr><a class="struct" href=''>ParserBuilder</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_syntax/parser.rs.html#15-18' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ParserBuilder { /* fields omitted */ }</pre></div><div class='docblock'><p>A builder for a regular expression parser.</p>
|
||
<p>This builder permits modifying configuration options for the parser.</p>
|
||
<p>This type combines the builder options for both the
|
||
<a href="ast/parse/struct.ParserBuilder.html">AST <code>ParserBuilder</code></a>
|
||
and the
|
||
<a href="hir/translate/struct.TranslatorBuilder.html">HIR <code>TranslatorBuilder</code></a>.</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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</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_syntax/parser.rs.html#20-164' 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>() -> <a class="struct" href="../regex_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#22-24' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new parser builder with a default configuration.</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="struct" href="../regex_syntax/struct.Parser.html" title="struct regex_syntax::Parser">Parser</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#27-32' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Build a parser from this configuration with the given pattern.</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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#59-62' 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><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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#79-82' 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.allow_invalid_utf8' class="method"><span id='allow_invalid_utf8.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.allow_invalid_utf8' class='fnname'>allow_invalid_utf8</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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#95-98' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>When enabled, the parser will permit the construction of a regular
|
||
expression that may match invalid UTF-8.</p>
|
||
<p>When disabled (the default), the parser is guaranteed to produce
|
||
an expression that will only ever match valid UTF-8 (otherwise, the
|
||
parser will return an error).</p>
|
||
<p>Note that currently, even when invalid UTF-8 is banned, the parser
|
||
will permit a negated ASCII word boundary (i.e., <code>(?-u:\B)</code>) even
|
||
though it can actually match at invalid UTF-8 boundaries. This bug
|
||
will be fixed on the next semver release.</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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#108-111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable verbose mode in the regular expression.</p>
|
||
<p>When enabled, verbose mode permits insigificant whitespace in many
|
||
places in the regular expression, as well as comments. Comments are
|
||
started using <code>#</code> and continue until the end of the line.</p>
|
||
<p>By default, this is disabled. It may be selectively enabled in the
|
||
regular expression by using the <code>x</code> flag regardless of this setting.</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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#117-120' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable the case insensitive flag by default.</p>
|
||
<p>By default this is disabled. It may alternatively be selectively
|
||
enabled in the regular expression itself via the <code>i</code> flag.</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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#126-129' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable the multi-line matching flag by default.</p>
|
||
<p>By default this is disabled. It may alternatively be selectively
|
||
enabled in the regular expression itself via the <code>m</code> flag.</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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#135-141' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable the "dot matches any character" flag by default.</p>
|
||
<p>By default this is disabled. It may alternatively be selectively
|
||
enabled in the regular expression itself via the <code>s</code> flag.</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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#147-150' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable the "swap greed" flag by default.</p>
|
||
<p>By default this is disabled. It may alternatively be selectively
|
||
enabled in the regular expression itself via the <code>U</code> flag.</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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#160-163' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable the Unicode flag (<code>u</code>) by default.</p>
|
||
<p>By default this is <strong>enabled</strong>. It may alternatively be selectively
|
||
disabled in the regular expression itself via the <code>u</code> flag.</p>
|
||
<p>Note that unless <code>allow_invalid_utf8</code> is enabled (it's disabled by
|
||
default), a regular expression will fail to parse if Unicode mode is
|
||
disabled and a sub-expression could possibly match invalid UTF-8.</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='implementations-list'>
|
||
<h3 id='impl-Clone' 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/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../regex_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#14' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../regex_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#14' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#117-119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 id='impl-Debug' 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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../regex_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#14' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#14' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-Default' 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/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../regex_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code><a href='#impl-Default' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#14' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../regex_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/parser.rs.html#14' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></div></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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</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_syntax/struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</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_syntax";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |