mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-21 10:40:41 +00:00
113 lines
35 KiB
HTML
113 lines
35 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 `Hir` struct in crate `regex_syntax`."><meta name="keywords" content="rust, rustlang, rust-lang, Hir"><title>regex_syntax::hir::Hir - 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 Hir</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.kind">kind</a><a href="#method.into_kind">into_kind</a><a href="#method.empty">empty</a><a href="#method.literal">literal</a><a href="#method.class">class</a><a href="#method.anchor">anchor</a><a href="#method.word_boundary">word_boundary</a><a href="#method.repetition">repetition</a><a href="#method.group">group</a><a href="#method.concat">concat</a><a href="#method.alternation">alternation</a><a href="#method.dot">dot</a><a href="#method.any">any</a><a href="#method.is_always_utf8">is_always_utf8</a><a href="#method.is_all_assertions">is_all_assertions</a><a href="#method.is_anchored_start">is_anchored_start</a><a href="#method.is_anchored_end">is_anchored_end</a><a href="#method.is_any_anchored_start">is_any_anchored_start</a><a href="#method.is_any_anchored_end">is_any_anchored_end</a><a href="#method.is_match_empty">is_match_empty</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><a href="#impl-Display">Display</a><a href="#impl-Drop">Drop</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: 'Hir', 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"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></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 href='index.html'>hir</a>::<wbr><a class="struct" href=''>Hir</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#161-166' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Hir { /* fields omitted */ }</pre></div><div class='docblock'><p>A high-level intermediate representation (HIR) for a regular expression.</p>
|
||
<p>The HIR of a regular expression represents an intermediate step between its
|
||
abstract syntax (a structured description of the concrete syntax) and
|
||
compiled byte codes. The purpose of HIR is to make regular expressions
|
||
easier to analyze. In particular, the AST is much more complex than the
|
||
HIR. For example, while an AST supports arbitrarily nested character
|
||
classes, the HIR will flatten all nested classes into a single set. The HIR
|
||
will also "compile away" every flag present in the concrete syntax. For
|
||
example, users of HIR expressions never need to worry about case folding;
|
||
it is handled automatically by the translator (e.g., by translating <code>(?i)A</code>
|
||
to <code>[aA]</code>).</p>
|
||
<p>If the HIR was produced by a translator that disallows invalid UTF-8, then
|
||
the HIR is guaranteed to match UTF-8 exclusively.</p>
|
||
<p>This type defines its own destructor that uses constant stack space and
|
||
heap space proportional to the size of the HIR.</p>
|
||
<p>The specific type of an HIR expression can be accessed via its <code>kind</code>
|
||
or <code>into_kind</code> methods. This extra level of indirection exists for two
|
||
reasons:</p>
|
||
<ol>
|
||
<li>Construction of an HIR expression <em>must</em> use the constructor methods
|
||
on this <code>Hir</code> type instead of building the <code>HirKind</code> values directly.
|
||
This permits construction to enforce invariants like "concatenations
|
||
always consist of two or more sub-expressions."</li>
|
||
<li>Every HIR expression contains attributes that are defined inductively,
|
||
and can be computed cheaply during the construction process. For
|
||
example, one such attribute is whether the expression must match at the
|
||
beginning of the text.</li>
|
||
</ol>
|
||
<p>Also, an <code>Hir</code>'s <code>fmt::Display</code> implementation prints an HIR as a regular
|
||
expression pattern string, and uses constant stack space and heap space
|
||
proportional to the size of the <code>Hir</code>.</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/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#203-578' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.kind' class="method"><span id='kind.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.kind' class='fnname'>kind</a>(&self) -> &<a class="enum" href="../../regex_syntax/hir/enum.HirKind.html" title="enum regex_syntax::hir::HirKind">HirKind</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#205-207' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the underlying HIR kind.</p>
|
||
</div><h4 id='method.into_kind' class="method"><span id='into_kind.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.into_kind' class='fnname'>into_kind</a>(self) -> <a class="enum" href="../../regex_syntax/hir/enum.HirKind.html" title="enum regex_syntax::hir::HirKind">HirKind</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#211-214' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Consumes ownership of this HIR expression and returns its underlying
|
||
<code>HirKind</code>.</p>
|
||
</div><h4 id='method.empty' class="method"><span id='empty.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.empty' class='fnname'>empty</a>() -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#219-232' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns an empty HIR expression.</p>
|
||
<p>An empty HIR expression always matches, including the empty string.</p>
|
||
</div><h4 id='method.literal' class="method"><span id='literal.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.literal' class='fnname'>literal</a>(lit: <a class="enum" href="../../regex_syntax/hir/enum.Literal.html" title="enum regex_syntax::hir::Literal">Literal</a>) -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#239-256' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a literal HIR expression.</p>
|
||
<p>If the given literal has a <code>Byte</code> variant with an ASCII byte, then this
|
||
method panics. This enforces the invariant that <code>Byte</code> variants are
|
||
only used to express matching of invalid UTF-8.</p>
|
||
</div><h4 id='method.class' class="method"><span id='class.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.class' class='fnname'>class</a>(class: <a class="enum" href="../../regex_syntax/hir/enum.Class.html" title="enum regex_syntax::hir::Class">Class</a>) -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#259-272' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a class HIR expression.</p>
|
||
</div><h4 id='method.anchor' class="method"><span id='anchor.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.anchor' class='fnname'>anchor</a>(anchor: <a class="enum" href="../../regex_syntax/hir/enum.Anchor.html" title="enum regex_syntax::hir::Anchor">Anchor</a>) -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#275-296' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an anchor assertion HIR expression.</p>
|
||
</div><h4 id='method.word_boundary' class="method"><span id='word_boundary.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.word_boundary' class='fnname'>word_boundary</a>(word_boundary: <a class="enum" href="../../regex_syntax/hir/enum.WordBoundary.html" title="enum regex_syntax::hir::WordBoundary">WordBoundary</a>) -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#299-318' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a word boundary assertion HIR expression.</p>
|
||
</div><h4 id='method.repetition' class="method"><span id='repetition.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.repetition' class='fnname'>repetition</a>(rep: <a class="struct" href="../../regex_syntax/hir/struct.Repetition.html" title="struct regex_syntax::hir::Repetition">Repetition</a>) -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#321-340' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a repetition HIR expression.</p>
|
||
</div><h4 id='method.group' class="method"><span id='group.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.group' class='fnname'>group</a>(group: <a class="struct" href="../../regex_syntax/hir/struct.Group.html" title="struct regex_syntax::hir::Group">Group</a>) -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#343-356' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a group HIR expression.</p>
|
||
</div><h4 id='method.concat' class="method"><span id='concat.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.concat' class='fnname'>concat</a>(exprs: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a>>) -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#361-427' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the concatenation of the given expressions.</p>
|
||
<p>This flattens the concatenation as appropriate.</p>
|
||
</div><h4 id='method.alternation' class="method"><span id='alternation.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.alternation' class='fnname'>alternation</a>(exprs: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a>>) -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#432-479' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the alternation of the given expressions.</p>
|
||
<p>This flattens the alternation as appropriate.</p>
|
||
</div><h4 id='method.dot' class="method"><span id='dot.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.dot' class='fnname'>dot</a>(bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#489-501' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Build an HIR expression for <code>.</code>.</p>
|
||
<p>A <code>.</code> expression matches any character except for <code>\n</code>. To build an
|
||
expression that matches any character, including <code>\n</code>, use the <code>any</code>
|
||
method.</p>
|
||
<p>If <code>bytes</code> is <code>true</code>, then this assumes characters are limited to a
|
||
single byte.</p>
|
||
</div><h4 id='method.any' class="method"><span id='any.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.any' class='fnname'>any</a>(bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#511-521' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Build an HIR expression for <code>(?s).</code>.</p>
|
||
<p>A <code>(?s).</code> expression matches any character, including <code>\n</code>. To build an
|
||
expression that matches any character except for <code>\n</code>, then use the
|
||
<code>dot</code> method.</p>
|
||
<p>If <code>bytes</code> is <code>true</code>, then this assumes characters are limited to a
|
||
single byte.</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#527-529' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return true if and only if this HIR will always match valid UTF-8.</p>
|
||
<p>When this returns false, then it is possible for this HIR expression
|
||
to match invalid UTF-8.</p>
|
||
</div><h4 id='method.is_all_assertions' class="method"><span id='is_all_assertions.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_all_assertions' class='fnname'>is_all_assertions</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#536-538' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns true if and only if this entire HIR expression is made up of
|
||
zero-width assertions.</p>
|
||
<p>This includes expressions like <code>^$\b\A\z</code> and even <code>((\b)+())*^</code>, but
|
||
not <code>^a</code>.</p>
|
||
</div><h4 id='method.is_anchored_start' class="method"><span id='is_anchored_start.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_anchored_start' class='fnname'>is_anchored_start</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#543-545' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return true if and only if this HIR is required to match from the
|
||
beginning of text. This includes expressions like <code>^foo</code>, <code>^(foo|bar)</code>,
|
||
<code>^foo|^bar</code> but not <code>^foo|bar</code>.</p>
|
||
</div><h4 id='method.is_anchored_end' class="method"><span id='is_anchored_end.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_anchored_end' class='fnname'>is_anchored_end</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#550-552' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return true if and only if this HIR is required to match at the end
|
||
of text. This includes expressions like <code>foo$</code>, <code>(foo|bar)$</code>,
|
||
<code>foo$|bar$</code> but not <code>foo$|bar</code>.</p>
|
||
</div><h4 id='method.is_any_anchored_start' class="method"><span id='is_any_anchored_start.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_any_anchored_start' class='fnname'>is_any_anchored_start</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#558-560' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return true if and only if this HIR contains any sub-expression that
|
||
is required to match at the beginning of text. Specifically, this
|
||
returns true if the <code>^</code> symbol (when multiline mode is disabled) or the
|
||
<code>\A</code> escape appear anywhere in the regex.</p>
|
||
</div><h4 id='method.is_any_anchored_end' class="method"><span id='is_any_anchored_end.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_any_anchored_end' class='fnname'>is_any_anchored_end</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#566-568' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return true if and only if this HIR contains any sub-expression that is
|
||
required to match at the end of text. Specifically, this returns true
|
||
if the <code>$</code> symbol (when multiline mode is disabled) or the <code>\z</code> escape
|
||
appear anywhere in the regex.</p>
|
||
</div><h4 id='method.is_match_empty' class="method"><span id='is_match_empty.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_match_empty' class='fnname'>is_match_empty</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#575-577' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return true if and only if the empty string is part of the language
|
||
matched by this regular expression.</p>
|
||
<p>This includes <code>a*</code>, <code>a?b*</code>, <code>a{0}</code>, <code>()</code>, <code>()+</code>, <code>^$</code>, <code>a|b?</code>, <code>\B</code>,
|
||
but not <code>a</code>, <code>a+</code> or <code>\b</code>.</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/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#160' 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/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#160' 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#130-132' 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/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#160' 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, 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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#160' 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="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#160' 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="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#160' 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, other: &<a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#160' 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, other: &<a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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#160' 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><h3 id='impl-Display' 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.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a></code><a href='#impl-Display' 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#616-621' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='docblock'><p>Print a display representation of this Hir.</p>
|
||
<p>The result of this is a valid regular expression pattern string.</p>
|
||
<p>This implementation uses constant stack space and heap space proportional
|
||
to the size of the <code>Hir</code>.</p>
|
||
</div><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><table class='table-display'><tbody><tr><td><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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#617-620' 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.Display.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-Drop' 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/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a></code><a href='#impl-Drop' 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#1250-1290' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='docblock'><p>A custom <code>Drop</code> impl is used for <code>HirKind</code> such that it uses constant stack
|
||
space but heap space proportional to the depth of the total <code>Hir</code>.</p>
|
||
</div><div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</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#1251-1289' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">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/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "regex_syntax";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |