185 lines
No EOL
19 KiB
HTML
185 lines
No EOL
19 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 `Class` enum in crate `regex_syntax`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Class">
|
||
|
||
<title>regex_syntax::hir::Class - 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 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">
|
||
<div class="sidebar-menu">☰</div>
|
||
|
||
<p class='location'>Enum Class</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Unicode">Unicode</a><a href="#variant.Bytes">Bytes</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.case_fold_simple">case_fold_simple</a><a href="#method.negate">negate</a><a href="#method.is_always_utf8">is_always_utf8</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-Eq">Eq</a><a href="#impl-PartialEq">PartialEq</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>::<wbr><a href='index.html'>hir</a></p><script>window.sidebarCurrent = {name: 'Class', ty: 'enum', 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'>Enum <a href='../index.html'>regex_syntax</a>::<wbr><a href='index.html'>hir</a>::<wbr><a class="enum" href=''>Class</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/hir/mod.rs.html#666-672' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum Class {
|
||
Unicode(<a class="struct" href="../../regex_syntax/hir/struct.ClassUnicode.html" title="struct regex_syntax::hir::ClassUnicode">ClassUnicode</a>),
|
||
Bytes(<a class="struct" href="../../regex_syntax/hir/struct.ClassBytes.html" title="struct regex_syntax::hir::ClassBytes">ClassBytes</a>),
|
||
}</pre></div><div class='docblock'><p>The high-level intermediate representation of a character class.</p>
|
||
<p>A character class corresponds to a set of characters. A character is either
|
||
defined by a Unicode scalar value or a byte. Unicode characters are used
|
||
by default, while bytes are used when Unicode mode (via the <code>u</code> flag) is
|
||
disabled.</p>
|
||
<p>A character class, regardless of its character type, is represented by a
|
||
sequence of non-overlapping non-adjacent ranges of characters.</p>
|
||
<p>Note that unlike <a href="enum.Literal.html"><code>Literal</code></a>, a <code>Bytes</code> variant may
|
||
be produced even when it exclusively matches valid UTF-8. This is because
|
||
a <code>Bytes</code> variant represents an intention by the author of the regular
|
||
expression to disable Unicode mode, which in turn impacts the semantics of
|
||
case insensitive matching. For example, <code>(?i)k</code> and <code>(?i-u)k</code> will not
|
||
match the same set of strings.</p>
|
||
</div><h2 id='variants' class='variants small-section-header'>
|
||
Variants<a href='#variants' class='anchor'></a></h2>
|
||
<span id="variant.Unicode" class="variant small-section-header"><a href="#variant.Unicode" class="anchor field"></a><span id='Unicode.v' class='invisible'><code>Unicode(<a class="struct" href="../../regex_syntax/hir/struct.ClassUnicode.html" title="struct regex_syntax::hir::ClassUnicode">ClassUnicode</a>)</code></span></span><div class='docblock'><p>A set of characters represented by Unicode scalar values.</p>
|
||
</div><span id="variant.Bytes" class="variant small-section-header"><a href="#variant.Bytes" class="anchor field"></a><span id='Bytes.v' class='invisible'><code>Bytes(<a class="struct" href="../../regex_syntax/hir/struct.ClassBytes.html" title="struct regex_syntax::hir::ClassBytes">ClassBytes</a>)</code></span></span><div class='docblock'><p>A set of characters represented by arbitrary bytes (one byte per
|
||
character).</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="enum" href="../../regex_syntax/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</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/hir/mod.rs.html#674-716' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.case_fold_simple' class="method"><span id='case_fold_simple.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.case_fold_simple' class='fnname'>case_fold_simple</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#681-686' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Apply Unicode simple case folding to this character class, in place.
|
||
The character class will be expanded to include all simple case folded
|
||
character variants.</p>
|
||
<p>If this is a byte oriented character class, then this will be limited
|
||
to the ASCII ranges <code>A-Z</code> and <code>a-z</code>.</p>
|
||
</div><h4 id='method.negate' class="method"><span id='negate.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.negate' class='fnname'>negate</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#692-697' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Negate this character class in place.</p>
|
||
<p>After completion, this character class will contain precisely the
|
||
characters that weren't previously in the class.</p>
|
||
</div><h4 id='method.is_always_utf8' class="method"><span id='is_always_utf8.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_always_utf8' class='fnname'>is_always_utf8</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#710-715' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns true if and only if this character class will only ever match
|
||
valid UTF-8.</p>
|
||
<p>A character class can match invalid UTF-8 only when the following
|
||
conditions are met:</p>
|
||
<ol>
|
||
<li>The translator was configured to permit generating an expression
|
||
that can match invalid UTF-8. (By default, this is disabled.)</li>
|
||
<li>Unicode mode (via the <code>u</code> flag) was disabled either in the concrete
|
||
syntax or in the parser builder. By default, Unicode mode is
|
||
enabled.</li>
|
||
</ol>
|
||
</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="enum" href="../../regex_syntax/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</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/hir/mod.rs.html#665' 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="enum" href="../../regex_syntax/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#665' 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="enum" href="../../regex_syntax/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</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/hir/mod.rs.html#665' 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/hir/mod.rs.html#665' 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-Eq' 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/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../../regex_syntax/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</a></code><a href='#impl-Eq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#665' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-PartialEq' 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/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../../regex_syntax/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</a></code><a href='#impl-PartialEq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#665' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><table class='table-display'><tbody><tr><td><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/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#665' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><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/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#665' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>!=</code>.</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="enum" href="../../regex_syntax/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</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="enum" href="../../regex_syntax/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</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> |