<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `Hir` struct in crate `regex_syntax`."><metaname="keywords"content="rust, rustlang, rust-lang, Hir"><title>regex_syntax::hir::Hir - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptsrc="../../storage.js"></script><noscript><linkrel="stylesheet"href="../../noscript.css"></noscript><linkrel="shortcut icon"href="../../favicon.ico"><styletype="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../../regex_syntax/index.html'><divclass='logo-container'><imgsrc='../../rust-logo.png'alt='logo'></div></a><pclass='location'>Struct Hir</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.alternation">alternation</a><ahref="#method.anchor">anchor</a><ahref="#method.any">any</a><ahref="#method.class">class</a><ahref="#method.concat">concat</a><ahref="#method.dot">dot</a><ahref="#method.empty">empty</a><ahref="#method.group">group</a><ahref="#method.into_kind">into_kind</a><ahref="#method.is_all_assertions">is_all_assertions</a><ahref="#method.is_alternation_literal">is_alternation_literal</a><ahref="#method.is_always_utf8">is_always_utf8</a><ahref="#method.is_anchored_end">is_anchored_end</a><ahref="#method.is_anchored_start">is_anchored_start</a><ahref="#method.is_any_anchored_end">is_any_anchored_end</a><ahref="#method.is_any_anchored_start">is_any_anchored_start</a><ahref="#method.is_line_anchored_end">is_line_anchored_end</a><ahref="#method.is_line_anchored_start">is_line_anchored_start</a><ahref="#method.is_literal">is_literal</a><ahref="#method.is_match_empty">is_match_empty</a><ahref="#method.kind">kind</a><ahref="#method.literal">literal</a><ahref="#method.repetition">repetition</a><ahref="#method.word_boundary">word_boundary</a></div><aclass="sidebar-title"href="#implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Clone">Clone</a><ahref="#impl-Debug">Debug</a><ahref="#impl-Display">Display</a><ahref="#impl-Drop">Drop</a><ahref="#impl-Eq">Eq</a><ahref="#impl-PartialEq%3CHir%3E">PartialEq<Hir></a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-ToOwned">ToOwned</a><ahref="#impl-ToString">ToString</a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><pclass='location'><ahref='../index.html'>regex_syntax</a>::<wbr><ahref='index.html'>hir</a></p><script>window.sidebarCurrent={name:'Hir',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-c
<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><h2id='methods'class='small-section-header'>Methods<ahref='#methods'class='anchor'></a></h2><h3id='impl'class='impl'><codeclass='in-band'>impl <aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><ahref='#impl'class='anchor'></a><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#193-667'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.kind'class="method"><codeid='kind.v'>pub fn <ahref='#method.kind'class='fnname'>kind</a>(&self) ->&<aclass="enum"href="../../regex_syntax/hir/enum.HirKind.html"title="enum regex_syntax::hir::HirKind">HirKind</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#195-197'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns a reference to the underlying HIR kind.</p>
</div><h4id='method.into_kind'class="method"><codeid='into_kind.v'>pub fn <ahref='#method.into_kind'class='fnname'>into_kind</a>(self) -><aclass="enum"href="../../regex_syntax/hir/enum.HirKind.html"title="enum regex_syntax::hir::HirKind">HirKind</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#201-204'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Consumes ownership of this HIR expression and returns its underlying
<code>HirKind</code>.</p>
</div><h4id='method.empty'class="method"><codeid='empty.v'>pub fn <ahref='#method.empty'class='fnname'>empty</a>() -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#209-223'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns an empty HIR expression.</p>
<p>An empty HIR expression always matches, including the empty string.</p>
</div><h4id='method.literal'class="method"><codeid='literal.v'>pub fn <ahref='#method.literal'class='fnname'>literal</a>(lit: <aclass="enum"href="../../regex_syntax/hir/enum.Literal.html"title="enum regex_syntax::hir::Literal">Literal</a>) -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#230-248'title='goto source code'>[src]</a></h4><divclass='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><h4id='method.class'class="method"><codeid='class.v'>pub fn <ahref='#method.class'class='fnname'>class</a>(class: <aclass="enum"href="../../regex_syntax/hir/enum.Class.html"title="enum regex_syntax::hir::Class">Class</a>) -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#251-265'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Creates a class HIR expression.</p>
</div><h4id='method.anchor'class="method"><codeid='anchor.v'>pub fn <ahref='#method.anchor'class='fnname'>anchor</a>(anchor: <aclass="enum"href="../../regex_syntax/hir/enum.Anchor.html"title="enum regex_syntax::hir::Anchor">Anchor</a>) -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#268-298'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Creates an anchor assertion HIR expression.</p>
</div><h4id='method.word_boundary'class="method"><codeid='word_boundary.v'>pub fn <ahref='#method.word_boundary'class='fnname'>word_boundary</a>(word_boundary: <aclass="enum"href="../../regex_syntax/hir/enum.WordBoundary.html"title="enum regex_syntax::hir::WordBoundary">WordBoundary</a>) -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#301-321'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Creates a word boundary assertion HIR expression.</p>
</div><h4id='method.repetition'class="method"><codeid='repetition.v'>pub fn <ahref='#method.repetition'class='fnname'>repetition</a>(rep: <aclass="struct"href="../../regex_syntax/hir/struct.Repetition.html"title="struct regex_syntax::hir::Repetition">Repetition</a>) -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#324-348'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Creates a repetition HIR expression.</p>
</div><h4id='method.group'class="method"><codeid='group.v'>pub fn <ahref='#method.group'class='fnname'>group</a>(group: <aclass="struct"href="../../regex_syntax/hir/struct.Group.html"title="struct regex_syntax::hir::Group">Group</a>) -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#351-365'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Creates a group HIR expression.</p>
</div><h4id='method.concat'class="method"><codeid='concat.v'>pub fn <ahref='#method.concat'class='fnname'>concat</a>(exprs: <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a>>) -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#370-458'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the concatenation of the given expressions.</p>
<p>This flattens the concatenation as appropriate.</p>
</div><h4id='method.alternation'class="method"><codeid='alternation.v'>pub fn <ahref='#method.alternation'class='fnname'>alternation</a>(exprs: <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a>>) -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#463-520'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the alternation of the given expressions.</p>
<p>This flattens the alternation as appropriate.</p>
</div><h4id='method.dot'class="method"><codeid='dot.v'>pub fn <ahref='#method.dot'class='fnname'>dot</a>(bytes: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#530-542'title='goto source code'>[src]</a></h4><divclass='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><h4id='method.any'class="method"><codeid='any.v'>pub fn <ahref='#method.any'class='fnname'>any</a>(bytes: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -><aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#552-562'title='goto source code'>[src]</a></h4><divclass='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><h4id='method.is_always_utf8'class="method"><codeid='is_always_utf8.v'>pub fn <ahref='#method.is_always_utf8'class='fnname'>is_always_utf8</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#568-570'title='goto source code'>[src]</a></h4><divclass='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><h4id='method.is_all_assertions'class="method"><codeid='is_all_assertions.v'>pub fn <ahref='#method.is_all_assertions'class='fnname'>is_all_assertions</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#577-579'title='goto source code'>[src]</a></h4><divclass='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><h4id='method.is_anchored_start'class="method"><codeid='is_anchored_start.v'>pub fn <ahref='#method.is_anchored_start'class='fnname'>is_anchored_start</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#584-586'title='goto source code'>[src]</a></h4><divclass='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><h4id='method.is_anchored_end'class="method"><codeid='is_anchored_end.v'>pub fn <ahref='#method.is_anchored_end'class='fnname'>is_anchored_end</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#591-593'title='goto source code'>[src]</a></h4><divclass='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><h4id='method.is_line_anchored_start'class="method"><codeid='is_line_anchored_start.v'>pub fn <ahref='#method.is_line_anchored_start'class='fnname'>is_line_anchored_start</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#604-606'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Return true if and only if this HIR is required to match from the
beginning of text or the beginning of a line. This includes expressions
like <code>^foo</code>, <code>(?m)^foo</code>, <code>^(foo|bar)</code>, <code>^(foo|bar)</code>, <code>(?m)^foo|^bar</code>
but not <code>^foo|bar</code> or <code>(?m)^foo|bar</code>.</p>
<p>Note that if <code>is_anchored_start</code> is <code>true</code>, then
<code>is_line_anchored_start</code> will also be <code>true</code>. The reverse implication
is not true. For example, <code>(?m)^foo</code> is line anchored, but not
<code>is_anchored_start</code>.</p>
</div><h4id='method.is_line_anchored_end'class="method"><codeid='is_line_anchored_end.v'>pub fn <ahref='#method.is_line_anchored_end'class='fnname'>is_line_anchored_end</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#617-619'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Return true if and only if this HIR is required to match at the
end of text or the end of a line. This includes expressions like
<code>(?m)(foo|bar)$</code>, but not <code>foo$|bar</code> or <code>(?m)foo$|bar</code>.</p>
<p>Note that if <code>is_anchored_end</code> is <code>true</code>, then
<code>is_line_anchored_end</code> will also be <code>true</code>. The reverse implication
is not true. For example, <code>(?m)foo$</code> is line anchored, but not
<code>is_anchored_end</code>.</p>
</div><h4id='method.is_any_anchored_start'class="method"><codeid='is_any_anchored_start.v'>pub fn <ahref='#method.is_any_anchored_start'class='fnname'>is_any_anchored_start</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#625-627'title='goto source code'>[src]</a></h4><divclass='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><h4id='method.is_any_anchored_end'class="method"><codeid='is_any_anchored_end.v'>pub fn <ahref='#method.is_any_anchored_end'class='fnname'>is_any_anchored_end</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#633-635'title='goto source code'>[src]</a></h4><divclass='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><h4id='method.is_match_empty'class="method"><codeid='is_match_empty.v'>pub fn <ahref='#method.is_match_empty'class='fnname'>is_match_empty</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#642-644'title='goto source code'>[src]</a></h4><divclass='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><h4id='method.is_literal'class="method"><codeid='is_literal.v'>pub fn <ahref='#method.is_literal'class='fnname'>is_literal</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#652-654'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Return true if and only if this HIR is a simple literal. This is only
true when this HIR expression is either itself a <code>Literal</code> or a
concatenation of only <code>Literal</code>s.</p>
<p>For example, <code>f</code> and <code>foo</code> are literals, but <code>f+</code>, <code>(foo)</code>, <code>foo()</code>
are not (even though that contain sub-expressions that are literals).</p>
</div><h4id='method.is_alternation_literal'class="method"><codeid='is_alternation_literal.v'>pub fn <ahref='#method.is_alternation_literal'class='fnname'>is_alternation_literal</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#664-666'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Return true if and only if this HIR is either a simple literal or an
alternation of simple literals. This is only
true when this HIR expression is either itself a <code>Literal</code> or a
concatenation of only <code>Literal</code>s or an alternation of only <code>Literal</code>s.</p>
<p>For example, <code>f</code>, <code>foo</code>, <code>a|b|c</code>, and <code>foo|bar|baz</code> are alternaiton
literals, but <code>f+</code>, <code>(foo)</code>, <code>foo()</code>
are not (even though that contain sub-expressions that are literals).</p>
</div><h4id='method.clone_from'class="method hidden"><codeid='clone_from.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from'class='fnname'>clone_from</a>(&mut self, source: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><spanclass='since'title='Stable since Rust version 1.0.0'>1.0.0</span><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3id='impl-PartialEq%3CHir%3E'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html"title="trait core::cmp::PartialEq">PartialEq</a><<aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a>> for <aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><ahref='#impl-PartialEq%3CHir%3E'class='anchor'></a><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#150'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.eq'class="method hidden"><codeid='eq.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq'class='fnname'>eq</a>(&self, other: &<aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#150'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <ahref="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div></div><h3id='impl-Drop'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html"title="trait core::ops::drop::Drop">Drop</a> for <aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><ahref='#impl-Drop'class='anchor'></a><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#1364-1404'title='goto source code'>[src]</a></h3><divclass='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><divclass='impl-items'><h4id='method.drop'class="method hidden"><codeid='drop.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop'class='fnname'>drop</a>(&mut self)</code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#1365-1403'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Executes the destructor for this type. <ahref="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
</div></div><h3id='impl-Debug'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> for <aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><ahref='#impl-Debug'class='anchor'></a><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#150'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.fmt'class="method hidden"><codeid='fmt.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt'class='fnname'>fmt</a>(&self, f: &mut <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html"title="struct core::fmt::Formatter">Formatter</a>) -><aclass="type"href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html"title="type core::fmt::Result">Result</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#150'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Formats the value using the given formatter. <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3id='impl-Display'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html"title="trait core::fmt::Display">Display</a> for <aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><ahref='#impl-Display'class='anchor'></a><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#705-710'title='goto source code'>[src]</a></h3><divclass='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
</div><divclass='impl-items'><h4id='method.fmt-1'class="method hidden"><codeid='fmt.v-1'>fn <ahref='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt'class='fnname'>fmt</a>(&self, f: &mut <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html"title="struct core::fmt::Formatter">Formatter</a>) -><aclass="type"href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html"title="type core::fmt::Result">Result</a></code><aclass='srclink'href='../../src/regex_syntax/hir/mod.rs.html#706-709'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Formats the value using the given formatter. <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
</div></div></div><h2id='synthetic-implementations'class='small-section-header'>Auto Trait Implementations<ahref='#synthetic-implementations'class='anchor'></a></h2><divid='synthetic-implementations-list'><h3id='impl-Sync'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><ahref='#impl-Sync'class='anchor'></a></h3><divclass='impl-items'></div><h3id='impl-Send'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><ahref='#impl-Send'class='anchor'></a></h3><divclass='impl-items'></div><h3id='impl-Unpin'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html"title="trait core::marker::Unpin">Unpin</a> for <aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><ahref='#impl-Unpin'class='anchor'></a></h3><divclass='impl-items'></div><h3id='impl-RefUnwindSafe'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html"title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><ahref='#impl-RefUnwindSafe'class='anchor'></a></h3><divclass='impl-items'></div><h3id='impl-UnwindSafe'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html"title="trait std::panic::UnwindSafe">UnwindSafe</a> for <aclass="struct"href="../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a></code><ahref='#impl-UnwindSafe'class='anchor'></a></h3><divclass='impl-items'></div></div><h2id='blanket-implementations'class='small-section-header'>Blanket Implementations<ahref='#blanket-implementations'class='anchor'></a></h2><divid='blanket-implementations-list'><h3id='impl-Into%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></code><ahref='#impl-Into%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#543-548'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.into'class="method hidden"><codeid='into.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into'class='fnname'>into</a>(self) -> U</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#545-547'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-ToString'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html"title="trait alloc::string::ToString">ToString</a> for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html"title="trait core::fmt::Display">Display</a> + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-ToString'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2134-2144'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.to_string'class="method hidden"><codeid='to_string.v'>default fn <ahref='https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html#tymethod.to_string'class='fnname'>to_string</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2136-2143'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Converts the given value to a <code>String</code>. <ahref="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></p>
</div></div><h3id='impl-ToOwned'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>, </span></code><ahref='#impl-ToOwned'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Owned'class="type"><codeid='Owned.t'>type <ahref='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned'class="type">Owned</a> = T</code></h4><divclass='docblock'><p>The resulting type after obtaining ownership.</p>
</div><h4id='method.to_owned'class="method hidden"><codeid='to_owned.v'>fn <ahref='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned'class='fnname'>to_owned</a>(&self) -> T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div><h4id='method.clone_into'class="method hidden"><codeid='clone_into.v'>fn <ahref='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into'class='fnname'>clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91'title='goto source code'>[src]</a></h4><divclass='stability hidden'><divclass='stab unstable'><details><summary><spanclass='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
</details></div></div><divclass='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></div><h3id='impl-TryFrom%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></code><ahref='#impl-TryFrom%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#571-577'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error'class="type"><codeid='Error.t'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error'class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_from'class="method hidden"><codeid='try_from.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from'class='fnname'>try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#574-576'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryInto%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><ahref='#impl-TryInto%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#559-566'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error-1'class="type"><codeid='Error.t-1'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error'class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_into'class="method hidden"><codeid='try_into.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into'class='fnname'>try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#563-565'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-BorrowMut%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-BorrowMut%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow_mut'class="method hidden"><codeid='borrow_mut.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut'class='fnname'>borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3id='impl-Borrow%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Borrow%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow'class="method hidden"><codeid='borrow.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow'class='fnname'>borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3id='impl-Any'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> for T <spanclass="where fmt-newline">where<br> T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Any'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.type_id'class="method hidden"><codeid='type_id.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id'class='fnname'>type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="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><divclass="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><scriptsrc="../../aliases.js"></script><scriptsrc="../../main.js"></script><scriptdefersrc="../../search-index.js"></script></body></html>
