| <!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 `ErrorKind` enum in crate `regex_syntax`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, ErrorKind"> |
| |
| <title>regex_syntax::ErrorKind - Rust</title> |
| |
| <link rel="stylesheet" type="text/css" href="../normalize.css"> |
| <link rel="stylesheet" type="text/css" href="../rustdoc.css"> |
| <link rel="stylesheet" type="text/css" href="../main.css"> |
| |
| |
| |
| |
| </head> |
| <body class="rustdoc enum"> |
| <!--[if lte IE 8]> |
| <div class="warning"> |
| This old browser is unsupported and will most likely display funky |
| things. |
| </div> |
| <![endif]--> |
| |
| |
| |
| <nav class="sidebar"> |
| |
| <p class='location'>Enum ErrorKind</p><div class="block items"><ul><li><a href="#variants">Variants</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>regex_syntax</a></p><script>window.sidebarCurrent = {name: 'ErrorKind', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script> |
| </nav> |
| |
| <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'>Enum <a href='index.html'>regex_syntax</a>::<wbr><a class="enum" href=''>ErrorKind</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/lib.rs.html#1311-1411' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust enum'>pub enum ErrorKind { |
| DoubleFlagNegation, |
| DuplicateCaptureName(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>), |
| EmptyAlternate, |
| EmptyCaptureName, |
| EmptyFlagNegation, |
| EmptyGroup, |
| InvalidBase10(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>), |
| InvalidBase16(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>), |
| InvalidCaptureName(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>), |
| InvalidClassRange { |
| start: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>, |
| end: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>, |
| }, |
| InvalidClassEscape(<a class="enum" href="../regex_syntax/enum.Expr.html" title="enum regex_syntax::Expr">Expr</a>), |
| InvalidRepeatRange { |
| min: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, |
| max: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, |
| }, |
| InvalidScalarValue(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>), |
| MissingBase10, |
| RepeaterExpectsExpr, |
| RepeaterUnexpectedExpr(<a class="enum" href="../regex_syntax/enum.Expr.html" title="enum regex_syntax::Expr">Expr</a>), |
| UnclosedCaptureName(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>), |
| UnclosedHex, |
| UnclosedParen, |
| UnclosedRepeat, |
| UnclosedUnicodeName, |
| UnexpectedClassEof, |
| UnexpectedEscapeEof, |
| UnexpectedFlagEof, |
| UnexpectedTwoDigitHexEof, |
| UnopenedParen, |
| UnrecognizedEscape(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>), |
| UnrecognizedFlag(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>), |
| UnrecognizedUnicodeClass(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>), |
| StackExhausted, |
| FlagNotAllowed(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>), |
| UnicodeNotAllowed, |
| InvalidUtf8, |
| EmptyClass, |
| // some variants omitted |
| }</pre><div class='docblock'><p>The specific type of parse error that can occur.</p> |
| </div><h2 id='variants' class='variants'>Variants</h2> |
| <span id='variant.DoubleFlagNegation' class='variant'><span id='DoubleFlagNegation.v' class='invisible'><code>DoubleFlagNegation</code></span></span><div class='docblock'><p>A negation symbol is used twice in flag settings. |
| e.g., <code>(?-i-s)</code>.</p> |
| </div><span id='variant.DuplicateCaptureName' class='variant'><span id='DuplicateCaptureName.v' class='invisible'><code>DuplicateCaptureName(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>The same capture name was used more than once. |
| e.g., <code>(?P<a>.)(?P<a>.)</code>.</p> |
| </div><span id='variant.EmptyAlternate' class='variant'><span id='EmptyAlternate.v' class='invisible'><code>EmptyAlternate</code></span></span><div class='docblock'><p>An alternate is empty. e.g., <code>(|a)</code>.</p> |
| </div><span id='variant.EmptyCaptureName' class='variant'><span id='EmptyCaptureName.v' class='invisible'><code>EmptyCaptureName</code></span></span><div class='docblock'><p>A capture group name is empty. e.g., <code>(?P<>a)</code>.</p> |
| </div><span id='variant.EmptyFlagNegation' class='variant'><span id='EmptyFlagNegation.v' class='invisible'><code>EmptyFlagNegation</code></span></span><div class='docblock'><p>A negation symbol was not proceded by any flags. e.g., <code>(?i-)</code>.</p> |
| </div><span id='variant.EmptyGroup' class='variant'><span id='EmptyGroup.v' class='invisible'><code>EmptyGroup</code></span></span><div class='docblock'><p>A group is empty. e.g., <code>()</code>.</p> |
| </div><span id='variant.InvalidBase10' class='variant'><span id='InvalidBase10.v' class='invisible'><code>InvalidBase10(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>An invalid number was used in a counted repetition. e.g., <code>a{b}</code>.</p> |
| </div><span id='variant.InvalidBase16' class='variant'><span id='InvalidBase16.v' class='invisible'><code>InvalidBase16(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>An invalid hexadecimal number was used in an escape sequence. |
| e.g., <code>\xAG</code>.</p> |
| </div><span id='variant.InvalidCaptureName' class='variant'><span id='InvalidCaptureName.v' class='invisible'><code>InvalidCaptureName(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>An invalid capture name was used. e.g., <code>(?P<0a>b)</code>.</p> |
| </div><span id='variant.InvalidClassRange' class='variant'><span id='InvalidClassRange.v' class='invisible'><code>InvalidClassRange</code></span></span><div class='docblock'><p>An invalid class range was givien. Specifically, when the start of the |
| range is greater than the end. e.g., <code>[z-a]</code>.</p> |
| </div><span class='docblock autohide sub-variant' id='variant.InvalidClassRange.fields'><h3 class='fields'>Fields of <code>InvalidClassRange</code></h3> |
| |
| <table><tr><td id='variant.InvalidClassRange.field.start'><span id='InvalidClassRange.v.start.v' class='invisible'><code>start: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a></code></span></td><td><div class='docblock'><p>The first character specified in the range.</p> |
| </div></td></tr><tr><td id='variant.InvalidClassRange.field.end'><span id='InvalidClassRange.v.end.v' class='invisible'><code>end: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a></code></span></td><td><div class='docblock'><p>The second character specified in the range.</p> |
| </div></td></tr></table></span><span id='variant.InvalidClassEscape' class='variant'><span id='InvalidClassEscape.v' class='invisible'><code>InvalidClassEscape(<a class="enum" href="../regex_syntax/enum.Expr.html" title="enum regex_syntax::Expr">Expr</a>)</code></span></span><div class='docblock'><p>An escape sequence was used in a character class where it is not |
| allowed. e.g., <code>[a-\pN]</code> or <code>[\A]</code>.</p> |
| </div><span id='variant.InvalidRepeatRange' class='variant'><span id='InvalidRepeatRange.v' class='invisible'><code>InvalidRepeatRange</code></span></span><div class='docblock'><p>An invalid counted repetition min/max was given. e.g., <code>a{2,1}</code>.</p> |
| </div><span class='docblock autohide sub-variant' id='variant.InvalidRepeatRange.fields'><h3 class='fields'>Fields of <code>InvalidRepeatRange</code></h3> |
| |
| <table><tr><td id='variant.InvalidRepeatRange.field.min'><span id='InvalidRepeatRange.v.min.v' class='invisible'><code>min: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><div class='docblock'><p>The first number specified in the repetition.</p> |
| </div></td></tr><tr><td id='variant.InvalidRepeatRange.field.max'><span id='InvalidRepeatRange.v.max.v' class='invisible'><code>max: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><div class='docblock'><p>The second number specified in the repetition.</p> |
| </div></td></tr></table></span><span id='variant.InvalidScalarValue' class='variant'><span id='InvalidScalarValue.v' class='invisible'><code>InvalidScalarValue(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code></span></span><div class='docblock'><p>An invalid Unicode scalar value was used in a long hexadecimal |
| sequence. e.g., <code>\x{D800}</code>.</p> |
| </div><span id='variant.MissingBase10' class='variant'><span id='MissingBase10.v' class='invisible'><code>MissingBase10</code></span></span><div class='docblock'><p>An empty counted repetition operator. e.g., <code>a{}</code>.</p> |
| </div><span id='variant.RepeaterExpectsExpr' class='variant'><span id='RepeaterExpectsExpr.v' class='invisible'><code>RepeaterExpectsExpr</code></span></span><div class='docblock'><p>A repetition operator was not applied to an expression. e.g., <code>*</code>.</p> |
| </div><span id='variant.RepeaterUnexpectedExpr' class='variant'><span id='RepeaterUnexpectedExpr.v' class='invisible'><code>RepeaterUnexpectedExpr(<a class="enum" href="../regex_syntax/enum.Expr.html" title="enum regex_syntax::Expr">Expr</a>)</code></span></span><div class='docblock'><p>A repetition operator was applied to an expression that cannot be |
| repeated. e.g., <code>a+*</code> or <code>a|*</code>.</p> |
| </div><span id='variant.UnclosedCaptureName' class='variant'><span id='UnclosedCaptureName.v' class='invisible'><code>UnclosedCaptureName(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>A capture group name that is never closed. e.g., <code>(?P<a</code>.</p> |
| </div><span id='variant.UnclosedHex' class='variant'><span id='UnclosedHex.v' class='invisible'><code>UnclosedHex</code></span></span><div class='docblock'><p>An unclosed hexadecimal literal. e.g., <code>\x{a</code>.</p> |
| </div><span id='variant.UnclosedParen' class='variant'><span id='UnclosedParen.v' class='invisible'><code>UnclosedParen</code></span></span><div class='docblock'><p>An unclosed parenthesis. e.g., <code>(a</code>.</p> |
| </div><span id='variant.UnclosedRepeat' class='variant'><span id='UnclosedRepeat.v' class='invisible'><code>UnclosedRepeat</code></span></span><div class='docblock'><p>An unclosed counted repetition operator. e.g., <code>a{2</code>.</p> |
| </div><span id='variant.UnclosedUnicodeName' class='variant'><span id='UnclosedUnicodeName.v' class='invisible'><code>UnclosedUnicodeName</code></span></span><div class='docblock'><p>An unclosed named Unicode class. e.g., <code>\p{Yi</code>.</p> |
| </div><span id='variant.UnexpectedClassEof' class='variant'><span id='UnexpectedClassEof.v' class='invisible'><code>UnexpectedClassEof</code></span></span><div class='docblock'><p>Saw end of regex before class was closed. e.g., <code>[a</code>.</p> |
| </div><span id='variant.UnexpectedEscapeEof' class='variant'><span id='UnexpectedEscapeEof.v' class='invisible'><code>UnexpectedEscapeEof</code></span></span><div class='docblock'><p>Saw end of regex before escape sequence was closed. e.g., <code>\</code>.</p> |
| </div><span id='variant.UnexpectedFlagEof' class='variant'><span id='UnexpectedFlagEof.v' class='invisible'><code>UnexpectedFlagEof</code></span></span><div class='docblock'><p>Saw end of regex before flags were closed. e.g., <code>(?i</code>.</p> |
| </div><span id='variant.UnexpectedTwoDigitHexEof' class='variant'><span id='UnexpectedTwoDigitHexEof.v' class='invisible'><code>UnexpectedTwoDigitHexEof</code></span></span><div class='docblock'><p>Saw end of regex before two hexadecimal digits were seen. e.g., <code>\xA</code>.</p> |
| </div><span id='variant.UnopenedParen' class='variant'><span id='UnopenedParen.v' class='invisible'><code>UnopenedParen</code></span></span><div class='docblock'><p>Unopened parenthesis. e.g., <code>)</code>.</p> |
| </div><span id='variant.UnrecognizedEscape' class='variant'><span id='UnrecognizedEscape.v' class='invisible'><code>UnrecognizedEscape(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>)</code></span></span><div class='docblock'><p>Unrecognized escape sequence. e.g., <code>\q</code>.</p> |
| </div><span id='variant.UnrecognizedFlag' class='variant'><span id='UnrecognizedFlag.v' class='invisible'><code>UnrecognizedFlag(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>)</code></span></span><div class='docblock'><p>Unrecognized flag. e.g., <code>(?a)</code>.</p> |
| </div><span id='variant.UnrecognizedUnicodeClass' class='variant'><span id='UnrecognizedUnicodeClass.v' class='invisible'><code>UnrecognizedUnicodeClass(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>Unrecognized named Unicode class. e.g., <code>\p{Foo}</code>.</p> |
| </div><span id='variant.StackExhausted' class='variant'><span id='StackExhausted.v' class='invisible'><code>StackExhausted</code></span></span><div class='docblock'><p>Indicates that the regex uses too much nesting.</p> |
| |
| <p>(N.B. This error exists because traversing the Expr is recursive and |
| an explicit heap allocated stack is not (yet?) used. Regardless, some |
| sort of limit must be applied to avoid unbounded memory growth.</p> |
| </div><span id='variant.FlagNotAllowed' class='variant'><span id='FlagNotAllowed.v' class='invisible'><code>FlagNotAllowed(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>)</code></span></span><div class='docblock'><p>A disallowed flag was found (e.g., <code>u</code>).</p> |
| </div><span id='variant.UnicodeNotAllowed' class='variant'><span id='UnicodeNotAllowed.v' class='invisible'><code>UnicodeNotAllowed</code></span></span><div class='docblock'><p>A Unicode class was used when the Unicode (<code>u</code>) flag was disabled.</p> |
| </div><span id='variant.InvalidUtf8' class='variant'><span id='InvalidUtf8.v' class='invisible'><code>InvalidUtf8</code></span></span><div class='docblock'><p>InvalidUtf8 indicates that the expression may match non-UTF-8 bytes. |
| This never returned if the parser is permitted to allow expressions |
| that match arbitrary bytes.</p> |
| </div><span id='variant.EmptyClass' class='variant'><span id='EmptyClass.v' class='invisible'><code>EmptyClass</code></span></span><div class='docblock'><p>A character class was constructed such that it is empty. |
| e.g., <code>[^\d\D]</code>.</p> |
| </div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><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="enum" href="../regex_syntax/enum.ErrorKind.html" title="enum regex_syntax::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/lib.rs.html#1310' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="enum" href="../regex_syntax/enum.ErrorKind.html" title="enum regex_syntax::ErrorKind">ErrorKind</a></code></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'><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: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></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 class='impl'><span class='in-band'><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="enum" href="../regex_syntax/enum.ErrorKind.html" title="enum regex_syntax::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/lib.rs.html#1310' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><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></h4> |
| <div class='docblock'><p>Formats the value using the given formatter.</p> |
| </div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../regex_syntax/enum.ErrorKind.html" title="enum regex_syntax::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/lib.rs.html#1310' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, __arg_0: &<a class="enum" href="../regex_syntax/enum.ErrorKind.html" title="enum regex_syntax::ErrorKind">ErrorKind</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4> |
| <div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p> |
| </div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, __arg_0: &<a class="enum" href="../regex_syntax/enum.ErrorKind.html" title="enum regex_syntax::ErrorKind">ErrorKind</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4> |
| <div class='docblock'><p>This method tests for <code>!=</code>.</p> |
| </div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../regex_syntax/enum.ErrorKind.html" title="enum regex_syntax::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex_syntax/lib.rs.html#1490-1581' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &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></h4> |
| <div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p> |
| </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>?</dt> |
| <dd>Show this help dialog</dd> |
| <dt>S</dt> |
| <dd>Focus the search field</dd> |
| <dt>⇤</dt> |
| <dd>Move up in search results</dd> |
| <dt>⇥</dt> |
| <dd>Move down in search results</dd> |
| <dt>⏎</dt> |
| <dd>Go to active search result</dd> |
| <dt>+</dt> |
| <dd>Collapse/expand 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> |