<!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 `Literals` struct in crate `regex_syntax`."><metaname="keywords"content="rust, rustlang, rust-lang, Literals"><title>regex_syntax::hir::literal::Literals - 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 Literals</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.add">add</a><ahref="#method.add_byte_class">add_byte_class</a><ahref="#method.add_char_class">add_char_class</a><ahref="#method.all_complete">all_complete</a><ahref="#method.any_complete">any_complete</a><ahref="#method.clear">clear</a><ahref="#method.contains_empty">contains_empty</a><ahref="#method.cross_add">cross_add</a><ahref="#method.cross_product">cross_product</a><ahref="#method.cut">cut</a><ahref="#method.empty">empty</a><ahref="#method.is_empty">is_empty</a><ahref="#method.limit_class">limit_class</a><ahref="#method.limit_size">limit_size</a><ahref="#method.literals">literals</a><ahref="#method.longest_common_prefix">longest_common_prefix</a><ahref="#method.longest_common_suffix">longest_common_suffix</a><ahref="#method.min_len">min_len</a><ahref="#method.prefixes">prefixes</a><ahref="#method.reverse">reverse</a><ahref="#method.set_limit_class">set_limit_class</a><ahref="#method.set_limit_size">set_limit_size</a><ahref="#method.suffixes">suffixes</a><ahref="#method.to_empty">to_empty</a><ahref="#method.trim_suffix">trim_suffix</a><ahref="#method.unambiguous_prefixes">unambiguous_prefixes</a><ahref="#method.unambiguous_suffixes">unambiguous_suffixes</a><ahref="#method.union">union</a><ahref="#method.union_prefixes">union_prefixes</a><ahref="#method.union_suffixes">union_suffixes</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-Eq">Eq</a><ahref="#impl-PartialEq%3CLiterals%3E">PartialEq<Literals></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-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>::<wbr><ahref='index.html'>literal</a></p><script>window.sidebarCurrent={name:'Literals',
<p>Every member of the set is a <code>Literal</code>, which is represented by a
<code>Vec<u8></code>. (Notably, it may contain invalid UTF-8.) Every member is
said to be either <em>complete</em> or <em>cut</em>. A complete literal means that
it extends until the beginning (or end) of the regular expression. In
some circumstances, this can be used to indicate a match in the regular
expression.</p>
<p>A key aspect of literal extraction is knowing when to stop. It is not
feasible to blindly extract all literals from a regular expression, even if
there are finitely many. For example, the regular expression <code>[0-9]{10}</code>
has <code>10^10</code> distinct literals. For this reason, literal extraction is
bounded to some low number by default using heuristics, but the limits can
be tweaked.</p>
<p><strong>WARNING</strong>: Literal extraction uses stack space proportional to the size
of the <code>Hir</code> expression. At some point, this drawback will be eliminated.
To protect yourself, set a reasonable
<ahref="../../struct.ParserBuilder.html#method.nest_limit"><code>nest_limit</code> on your <code>Parser</code></a>.
This is done for you by default.</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/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><ahref='#impl'class='anchor'></a><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#51-582'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.empty'class="method"><codeid='empty.v'>pub fn <ahref='#method.empty'class='fnname'>empty</a>() -><aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#53-55'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns a new empty set of literals using default limits.</p>
</div><h4id='method.prefixes'class="method"><codeid='prefixes.v'>pub fn <ahref='#method.prefixes'class='fnname'>prefixes</a>(expr: &<aclass="struct"href="../../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a>) -><aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#58-62'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns a set of literal prefixes extracted from the given <code>Hir</code>.</p>
</div><h4id='method.suffixes'class="method"><codeid='suffixes.v'>pub fn <ahref='#method.suffixes'class='fnname'>suffixes</a>(expr: &<aclass="struct"href="../../../regex_syntax/hir/struct.Hir.html"title="struct regex_syntax::hir::Hir">Hir</a>) -><aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#65-69'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns a set of literal suffixes extracted from the given <code>Hir</code>.</p>
</div><h4id='method.limit_size'class="method"><codeid='limit_size.v'>pub fn <ahref='#method.limit_size'class='fnname'>limit_size</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#72-74'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Get the approximate size limit (in bytes) of this set.</p>
</div><h4id='method.set_limit_size'class="method"><codeid='set_limit_size.v'>pub fn <ahref='#method.set_limit_size'class='fnname'>set_limit_size</a>(&mut self, size: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) ->&mut <aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#83-86'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Set the approximate size limit (in bytes) of this set.</p>
<p>If extracting a literal would put the set over this limit, then
extraction stops.</p>
<p>The new limits will only apply to additions to this set. Existing
members remain unchanged, even if the set exceeds the new limit.</p>
</div><h4id='method.limit_class'class="method"><codeid='limit_class.v'>pub fn <ahref='#method.limit_class'class='fnname'>limit_class</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#89-91'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Get the character class size limit for this set.</p>
</div><h4id='method.set_limit_class'class="method"><codeid='set_limit_class.v'>pub fn <ahref='#method.set_limit_class'class='fnname'>set_limit_class</a>(&mut self, size: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) ->&mut <aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#103-106'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Limits the size of character(or byte) classes considered.</p>
<p>A value of <code>0</code> prevents all character classes from being considered.</p>
<p>This limit also applies to case insensitive literals, since each
character in the case insensitive literal is converted to a class, and
then case folded.</p>
<p>The new limits will only apply to additions to this set. Existing
members remain unchanged, even if the set exceeds the new limit.</p>
</div><h4id='method.literals'class="method"><codeid='literals.v'>pub fn <ahref='#method.literals'class='fnname'>literals</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literal.html"title="struct regex_syntax::hir::literal::Literal">Literal</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#109-111'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the set of literals as a slice. Its order is unspecified.</p>
</div><h4id='method.min_len'class="method"><codeid='min_len.v'>pub fn <ahref='#method.min_len'class='fnname'>min_len</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#116-126'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the length of the smallest literal.</p>
<p>Returns None is there are no literals in the set.</p>
</div><h4id='method.all_complete'class="method"><codeid='all_complete.v'>pub fn <ahref='#method.all_complete'class='fnname'>all_complete</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/literal/mod.rs.html#129-131'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns true if all members in this set are complete.</p>
</div><h4id='method.any_complete'class="method"><codeid='any_complete.v'>pub fn <ahref='#method.any_complete'class='fnname'>any_complete</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/literal/mod.rs.html#134-136'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns true if any member in this set is complete.</p>
</div><h4id='method.contains_empty'class="method"><codeid='contains_empty.v'>pub fn <ahref='#method.contains_empty'class='fnname'>contains_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/literal/mod.rs.html#139-141'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns true if this set contains an empty literal.</p>
</div><h4id='method.is_empty'class="method"><codeid='is_empty.v'>pub fn <ahref='#method.is_empty'class='fnname'>is_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/literal/mod.rs.html#144-146'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns true if this set is empty or if all of its members is empty.</p>
</div><h4id='method.to_empty'class="method"><codeid='to_empty.v'>pub fn <ahref='#method.to_empty'class='fnname'>to_empty</a>(&self) -><aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#149-153'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns a new empty set of literals using this set's limits.</p>
</div><h4id='method.longest_common_prefix'class="method"><codeid='longest_common_prefix.v'>pub fn <ahref='#method.longest_common_prefix'class='fnname'>longest_common_prefix</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#156-169'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the longest common prefix of all members in this set.</p>
</div><h4id='method.longest_common_suffix'class="method"><codeid='longest_common_suffix.v'>pub fn <ahref='#method.longest_common_suffix'class='fnname'>longest_common_suffix</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#172-189'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the longest common suffix of all members in this set.</p>
</div><h4id='method.trim_suffix'class="method"><codeid='trim_suffix.v'>pub fn <ahref='#method.trim_suffix'class='fnname'>trim_suffix</a>(&self, num_bytes: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a>></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#199-213'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns a new set of literals with the given number of bytes trimmed
from the suffix of each literal.</p>
<p>If any literal would be cut out completely by trimming, then None is
returned.</p>
<p>Any duplicates that are created as a result of this transformation are
removed.</p>
</div><h4id='method.unambiguous_prefixes'class="method"><codeid='unambiguous_prefixes.v'>pub fn <ahref='#method.unambiguous_prefixes'class='fnname'>unambiguous_prefixes</a>(&self) -><aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#224-280'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns a new set of prefixes of this set of literals that are
guaranteed to be unambiguous.</p>
<p>Any substring match with a member of the set is returned is guaranteed
to never overlap with a substring match of another member of the set
at the same starting position.</p>
<p>Given any two members of the returned set, neither is a substring of
the other.</p>
</div><h4id='method.unambiguous_suffixes'class="method"><codeid='unambiguous_suffixes.v'>pub fn <ahref='#method.unambiguous_suffixes'class='fnname'>unambiguous_suffixes</a>(&self) -><aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#291-298'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns a new set of suffixes of this set of literals that are
guaranteed to be unambiguous.</p>
<p>Any substring match with a member of the set is returned is guaranteed
to never overlap with a substring match of another member of the set
at the same ending position.</p>
<p>Given any two members of the returned set, neither is a substring of
the other.</p>
</div><h4id='method.union_prefixes'class="method"><codeid='union_prefixes.v'>pub fn <ahref='#method.union_prefixes'class='fnname'>union_prefixes</a>(&mut self, expr: &<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/literal/mod.rs.html#309-313'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Unions the prefixes from the given expression to this set.</p>
<p>If prefixes could not be added (for example, this set would exceed its
size limits or the set of prefixes from <code>expr</code> includes the empty
string), then false is returned.</p>
<p>Note that prefix literals extracted from <code>expr</code> are said to be complete
if and only if the literal extends from the beginning of <code>expr</code> to the
end of <code>expr</code>.</p>
</div><h4id='method.union_suffixes'class="method"><codeid='union_suffixes.v'>pub fn <ahref='#method.union_suffixes'class='fnname'>union_suffixes</a>(&mut self, expr: &<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/literal/mod.rs.html#324-329'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Unions the suffixes from the given expression to this set.</p>
<p>If suffixes could not be added (for example, this set would exceed its
size limits or the set of suffixes from <code>expr</code> includes the empty
string), then false is returned.</p>
<p>Note that prefix literals extracted from <code>expr</code> are said to be complete
if and only if the literal extends from the end of <code>expr</code> to the
beginning of <code>expr</code>.</p>
</div><h4id='method.union'class="method"><codeid='union.v'>pub fn <ahref='#method.union'class='fnname'>union</a>(&mut self, lits: <aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#336-346'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Unions this set with another set.</p>
<p>If the union would cause the set to exceed its limits, then the union
is skipped and it returns false. Otherwise, if the union succeeds, it
returns true.</p>
</div><h4id='method.cross_product'class="method"><codeid='cross_product.v'>pub fn <ahref='#method.cross_product'class='fnname'>cross_product</a>(&mut self, lits: &<aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#355-394'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Extends this set with another set.</p>
<p>The set of literals is extended via a cross product.</p>
<p>If a cross product would cause this set to exceed its limits, then the
cross product is skipped and it returns false. Otherwise, if the cross
product succeeds, it returns true.</p>
</div><h4id='method.cross_add'class="method"><codeid='cross_add.v'>pub fn <ahref='#method.cross_add'class='fnname'>cross_add</a>(&mut self, bytes: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#404-436'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Extends each literal in this set with the bytes given.</p>
<p>If the set is empty, then the given literal is added to the set.</p>
<p>If adding any number of bytes to all members of this set causes a limit
to be exceeded, then no bytes are added and false is returned. If a
prefix of <code>bytes</code> can be fit into this set, then it is used and all
resulting literals are cut.</p>
</div><h4id='method.add'class="method"><codeid='add.v'>pub fn <ahref='#method.add'class='fnname'>add</a>(&mut self, lit: <aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literal.html"title="struct regex_syntax::hir::literal::Literal">Literal</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#442-448'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Adds the given literal to this set.</p>
<p>Returns false if adding this literal would cause the class to be too
big.</p>
</div><h4id='method.add_char_class'class="method"><codeid='add_char_class.v'>pub fn <ahref='#method.add_char_class'class='fnname'>add_char_class</a>(&mut self, cls: &<aclass="struct"href="../../../regex_syntax/hir/struct.ClassUnicode.html"title="struct regex_syntax::hir::ClassUnicode">ClassUnicode</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#453-455'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Extends each literal in this set with the character class given.</p>
<p>Returns false if the character class was too big to add.</p>
</div><h4id='method.add_byte_class'class="method"><codeid='add_byte_class.v'>pub fn <ahref='#method.add_byte_class'class='fnname'>add_byte_class</a>(&mut self, cls: &<aclass="struct"href="../../../regex_syntax/hir/struct.ClassBytes.html"title="struct regex_syntax::hir::ClassBytes">ClassBytes</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#498-516'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Extends each literal in this set with the byte class given.</p>
<p>Returns false if the byte class was too big to add.</p>
</div><h4id='method.cut'class="method"><codeid='cut.v'>pub fn <ahref='#method.cut'class='fnname'>cut</a>(&mut self)</code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#520-524'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Cuts every member of this set. When a member is cut, it can never
be extended.</p>
</div><h4id='method.reverse'class="method"><codeid='reverse.v'>pub fn <ahref='#method.reverse'class='fnname'>reverse</a>(&mut self)</code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#527-531'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Reverses all members in place.</p>
</div><h4id='method.clear'class="method"><codeid='clear.v'>pub fn <ahref='#method.clear'class='fnname'>clear</a>(&mut self)</code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#534-536'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Clears this set of all members.</p>
</div></div><h2id='implementations'class='small-section-header'>Trait Implementations<ahref='#implementations'class='anchor'></a></h2><divid='implementations-list'><h3id='impl-Eq'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html"title="trait core::cmp::Eq">Eq</a> for <aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><ahref='#impl-Eq'class='anchor'></a><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#34'title='goto source code'>[src]</a></h3><divclass='impl-items'></div><h3id='impl-Clone'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> for <aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><ahref='#impl-Clone'class='anchor'></a><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#34'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.clone'class="method hidden"><codeid='clone.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone'class='fnname'>clone</a>(&self) -><aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#34'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Returns a copy of the value. <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></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%3CLiterals%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/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a>> for <aclass="struct"href="../../../regex_syntax/hir/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><ahref='#impl-PartialEq%3CLiterals%3E'class='anchor'></a><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#34'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/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#34'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-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/literal/struct.Literals.html"title="struct regex_syntax::hir::literal::Literals">Literals</a></code><ahref='#impl-Debug'class='anchor'></a><aclass='srclink'href='../../../src/regex_syntax/hir/literal/mod.rs.html#840-848'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/literal/mod.rs.html#841-847'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-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>
