edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-23 16:38:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/regex_automata/util/syntax/struct.Config.html

156 lines
50 KiB
HTML
Raw Normal View History

deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
<!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 common set of configuration options that apply to the syntax of a regex."><title>Config in regex_automata::util::syntax - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-e935ef01ae1c1829.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.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../regex_automata/index.html">regex_automata</a><span class="version">0.4.6</span></h2></div><h2 class="location"><a href="#">Config</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.case_insensitive">case_insensitive</a></li><li><a href="#method.crlf">crlf</a></li><li><a href="#method.dot_matches_new_line">dot_matches_new_line</a></li><li><a href="#method.get_case_insensitive">get_case_insensitive</a></li><li><a href="#method.get_crlf">get_crlf</a></li><li><a href="#method.get_dot_matches_new_line">get_dot_matches_new_line</a></li><li><a href="#method.get_ignore_whitespace">get_ignore_whitespace</a></li><li><a href="#method.get_line_terminator">get_line_terminator</a></li><li><a href="#method.get_multi_line">get_multi_line</a></li><li><a href="#method.get_nest_limit">get_nest_limit</a></li><li><a href="#method.get_octal">get_octal</a></li><li><a href="#method.get_swap_greed">get_swap_greed</a></li><li><a href="#method.get_unicode">get_unicode</a></li><li><a href="#method.get_utf8">get_utf8</a></li><li><a href="#method.ignore_whitespace">ignore_whitespace</a></li><li><a href="#method.line_terminator">line_terminator</a></li><li><a href="#method.multi_line">multi_line</a></li><li><a href="#method.nest_limit">nest_limit</a></li><li><a href="#method.new">new</a></li><li><a href="#method.octal">octal</a></li><li><a href="#method.swap_greed">swap_greed</a></li><li><a href="#method.unicode">unicode</a></li><li><a href="#method.utf8">utf8</a></li></ul
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../regex_automata/all.html" title="show sidebar"></a></div><input class="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"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../../index.html">regex_automata</a>::<wbr><a href="../index.html">util</a>::<wbr><a href="index.html">syntax</a>::<wbr><a class="struct" href="#">Config</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/regex_automata/util/syntax.rs.html#145-157">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Config { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A common set of configuration options that apply to the syntax of a regex.</p>
<p>This represents a group of configuration options that specifically apply
to how the concrete syntax of a regular expression is interpreted. In
particular, they are generally forwarded to the
<a href="https://docs.rs/regex-syntax/*/regex_syntax/struct.ParserBuilder.html"><code>ParserBuilder</code></a>
in the
<a href="https://docs.rs/regex-syntax"><code>regex-syntax</code></a>
crate when building a regex from its concrete syntax directly.</p>
<p>These options are defined as a group since they apply to every regex engine
in this crate. Instead of re-defining them on every engine’s builder, they
are instead provided here as one cohesive unit.</p>
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Config" class="impl"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#159-476">source</a><a href="#impl-Config" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#161-176">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Return a new default syntax configuration.</p>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.case_insensitive" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#186-189">source</a><h4 class="code-header">pub fn <a href="#method.case_insensitive" class="fn">case_insensitive</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Enable or disable the case insensitive flag by default.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<p>When Unicode mode is enabled, case insensitivity is Unicode-aware.
Specifically, it will apply the “simple” case folding rules as
specified by Unicode.</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>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.multi_line" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#201-204">source</a><h4 class="code-header">pub fn <a href="#method.multi_line" class="fn">multi_line</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Enable or disable the multi-line matching flag by default.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<p>When this is enabled, the <code>^</code> and <code>$</code> look-around assertions will
match immediately after and immediately before a new line character,
respectively. Note that the <code>\A</code> and <code>\z</code> look-around assertions are
unaffected by this setting and always correspond to matching at the
beginning and end of the input.</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>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.dot_matches_new_line" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#222-225">source</a><h4 class="code-header">pub fn <a href="#method.dot_matches_new_line" class="fn">dot_matches_new_line</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Enable or disable the “dot matches any character” flag by default.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<p>When this is enabled, <code>.</code> will match any character. When it’s disabled,
then <code>.</code> will match any character except for a new line character.</p>
<p>Note that <code>.</code> is impacted by whether the “unicode” setting is enabled
or not. When Unicode is enabled (the default), <code>.</code> will match any UTF-8
encoding of any Unicode scalar value (sans a new line, depending on
whether this “dot matches new line” option is enabled). When Unicode
mode is disabled, <code>.</code> will match any byte instead. Because of this,
when Unicode mode is disabled, <code>.</code> can only be used when the “allow
invalid UTF-8” option is enabled, since <code>.</code> could otherwise match
invalid UTF-8.</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>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.crlf" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#239-242">source</a><h4 class="code-header">pub fn <a href="#method.crlf" class="fn">crlf</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Enable or disable the “CRLF mode” flag by default.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<p>By default this is disabled. It may alternatively be selectively
enabled in the regular expression itself via the <code>R</code> flag.</p>
<p>When CRLF mode is enabled, the following happens:</p>
<ul>
<li>Unless <code>dot_matches_new_line</code> is enabled, <code>.</code> will match any character
except for <code>\r</code> and <code>\n</code>.</li>
<li>When <code>multi_line</code> mode is enabled, <code>^</code> and <code>$</code> will treat <code>\r\n</code>,
<code>\r</code> and <code>\n</code> as line terminators. And in particular, neither will
match between a <code>\r</code> and a <code>\n</code>.</li>
</ul>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.line_terminator" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#264-267">source</a><h4 class="code-header">pub fn <a href="#method.line_terminator" class="fn">line_terminator</a>(self, byte: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.u8.html">u8</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Sets the line terminator for use with <code>(?u-s:.)</code> and <code>(?-us:.)</code>.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<p>Namely, instead of <code>.</code> (by default) matching everything except for <code>\n</code>,
this will cause <code>.</code> to match everything except for the byte given.</p>
<p>If <code>.</code> is used in a context where Unicode mode is enabled and this byte
isn’t ASCII, then an error will be returned. When Unicode mode is
disabled, then any byte is permitted, but will return an error if UTF-8
mode is enabled and it is a non-ASCII byte.</p>
<p>In short, any ASCII value for a line terminator is always okay. But a
non-ASCII byte might result in an error depending on whether Unicode
mode or UTF-8 mode are enabled.</p>
<p>Note that if <code>R</code> mode is enabled then it always takes precedence and
the line terminator will be treated as <code>\r</code> and <code>\n</code> simultaneously.</p>
<p>Note also that this <em>doesn’t</em> impact the look-around assertions
<code>(?m:^)</code> and <code>(?m:$)</code>. That’s usually controlled by additional
configuration in the regex engine itself.</p>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.swap_greed" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#276-279">source</a><h4 class="code-header">pub fn <a href="#method.swap_greed" class="fn">swap_greed</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Enable or disable the “swap greed” flag by default.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<p>When this is enabled, <code>.*</code> (for example) will become ungreedy and <code>.*?</code>
will become greedy.</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>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.ignore_whitespace" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#289-292">source</a><h4 class="code-header">pub fn <a href="#method.ignore_whitespace" class="fn">ignore_whitespace</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Enable verbose mode in the regular expression.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<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>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.unicode" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#308-311">source</a><h4 class="code-header">pub fn <a href="#method.unicode" class="fn">unicode</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Enable or disable the Unicode flag (<code>u</code>) by default.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<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 “allow invalid UTF-8” 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>
<p><strong>WARNING</strong>: Unicode mode can greatly increase the size of the compiled
DFA, which can noticeably impact both memory usage and compilation
time. This is especially noticeable if your regex contains character
classes like <code>\w</code> that are impacted by whether Unicode is enabled or
not. If Unicode is not necessary, you are encouraged to disable it.</p>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.utf8" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#327-330">source</a><h4 class="code-header">pub fn <a href="#method.utf8" class="fn">utf8</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>When disabled, the builder will permit the construction of a regular
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
expression that may match invalid UTF-8.</p>
<p>For example, when <a href="struct.Config.html#method.unicode" title="method regex_automata::util::syntax::Config::unicode"><code>Config::unicode</code></a> is disabled, then
expressions like <code>[^a]</code> may match invalid UTF-8 since they can match
any single byte that is not <code>a</code>. By default, these sub-expressions
are disallowed to avoid returning offsets that split a UTF-8
encoded codepoint. However, in cases where matching at arbitrary
locations is desired, this option can be disabled to permit all such
sub-expressions.</p>
<p>When enabled (the default), the builder is guaranteed to produce a
regex that will only ever match valid UTF-8 (otherwise, the builder
will return an error).</p>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.nest_limit" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#357-360">source</a><h4 class="code-header">pub fn <a href="#method.nest_limit" class="fn">nest_limit</a>(self, limit: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.u32.html">u32</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Set the nesting limit used for the regular expression parser.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<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 when building a finite automaton from a regular expression’s
abstract syntax tree. In particular, construction currently uses
recursion. In the future, the implementation may stop using recursion
and this option will no longer be necessary.</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 the parser will
limit itself to heap space proportional to the length 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 AST item, 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>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.octal" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#377-380">source</a><h4 class="code-header">pub fn <a href="#method.octal" class="fn">octal</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class="docblock"><p>Whether to support octal syntax or not.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<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>\1</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>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_unicode" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#383-385">source</a><h4 class="code-header">pub fn <a href="#method.get_unicode" class="fn">get_unicode</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether “unicode” mode is enabled.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_case_insensitive" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#388-390">source</a><h4 class="code-header">pub fn <a href="#method.get_case_insensitive" class="fn">get_case_insensitive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether “case insensitive” mode is enabled.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_multi_line" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#393-395">source</a><h4 class="code-header">pub fn <a href="#method.get_multi_line" class="fn">get_multi_line</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether “multi line” mode is enabled.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_dot_matches_new_line" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#398-400">source</a><h4 class="code-header">pub fn <a href="#method.get_dot_matches_new_line" class="fn">get_dot_matches_new_line</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether “dot matches new line” mode is enabled.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_crlf" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#403-405">source</a><h4 class="code-header">pub fn <a href="#method.get_crlf" class="fn">get_crlf</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether “CRLF” mode is enabled.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_line_terminator" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#408-410">source</a><h4 class="code-header">pub fn <a href="#method.get_line_terminator" class="fn">get_line_terminator</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.u8.html">u8</a></h4></section></summary><div class="docblock"><p>Returns the line terminator in this syntax configuration.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_swap_greed" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#413-415">source</a><h4 class="code-header">pub fn <a href="#method.get_swap_greed" class="fn">get_swap_greed</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether “swap greed” mode is enabled.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_ignore_whitespace" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#418-420">source</a><h4 class="code-header">pub fn <a href="#method.get_ignore_whitespace" class="fn">get_ignore_whitespace</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether “ignore whitespace” mode is enabled.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_utf8" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#423-425">source</a><h4 class="code-header">pub fn <a href="#method.get_utf8" class="fn">get_utf8</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether UTF-8 mode is enabled.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_nest_limit" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#428-430">source</a><h4 class="code-header">pub fn <a href="#method.get_nest_limit" class="fn">get_nest_limit</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Returns the “nest limit” setting.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_octal" class="method"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#433-435">source</a><h4 class="code-header">pub fn <a href="#method.get_octal" class="fn">get_octal</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether “octal” mode is enabled.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-Config" class="impl"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#144">source</a><a href="#impl-Clone-for-Config" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#144">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.78.0/src/core/clone.rs.html#169">source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&amp;Self</a>)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Config" class="impl"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#144">source</a><a href="#impl-Debug-for-Config" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Config.html" title="struct regex_automata::util::syntax::Config">Config</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#144">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.78.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.78.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.78.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-Config" class="impl"><a class="src rightside" href="../../../src/regex_automata/util/syntax.rs.html#478-482">source</a><a href="#impl-Default-for-Config" class="anchor">§</a><h3 class="code-header">impl <a class="trait
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.78.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.78.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<p>That is, this conversion is whatever the implementation of
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
<code><a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/alloc/borrow.rs.html#83-85">source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&amp;self, target: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&amp;mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
Reference in a new issue Copy permalink