<!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 `Regex` struct in crate `regex`."><metaname="keywords"content="rust, rustlang, rust-lang, Regex"><title>regex::bytes::Regex - 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/index.html'><divclass='logo-container'><imgsrc='../../rust-logo.png'alt='logo'></div></a><pclass='location'>Struct Regex</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.as_str">as_str</a><ahref="#method.capture_locations">capture_locations</a><ahref="#method.capture_names">capture_names</a><ahref="#method.captures">captures</a><ahref="#method.captures_iter">captures_iter</a><ahref="#method.captures_len">captures_len</a><ahref="#method.captures_read">captures_read</a><ahref="#method.captures_read_at">captures_read_at</a><ahref="#method.find">find</a><ahref="#method.find_at">find_at</a><ahref="#method.find_iter">find_iter</a><ahref="#method.is_match">is_match</a><ahref="#method.is_match_at">is_match_at</a><ahref="#method.new">new</a><ahref="#method.replace">replace</a><ahref="#method.replace_all">replace_all</a><ahref="#method.replacen">replacen</a><ahref="#method.shortest_match">shortest_match</a><ahref="#method.shortest_match_at">shortest_match_at</a><ahref="#method.split">split</a><ahref="#method.splitn">splitn</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-FromStr">FromStr</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</a>::<wbr><ahref='index.html'>bytes</a></p><script>window.sidebarCurrent={name:'Regex',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-choices"></div></div><scriptsrc="../../theme.js"></script><navclass="sub"><formclass="search-form js-only"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"autocomplete="off"spellcheck="fa
<p>It can be used to search, split or replace text. All searching is done with
an implicit <code>.*?</code> at the beginning and end of an expression. To force an
expression to match the whole string (or a prefix or a suffix), you must
use an anchor like <code>^</code> or <code>$</code> (or <code>\A</code> and <code>\z</code>).</p>
<p>Like the <code>Regex</code> type in the parent module, matches with this regex return
byte offsets into the search text. <strong>Unlike</strong> the parent <code>Regex</code> type,
these byte offsets may not correspond to UTF-8 sequence boundaries since
the regexes in this module can match arbitrary bytes.</p>
</div><divclass='impl-items'><h4id='method.new'class="method"><codeid='new.v'>pub fn <ahref='#method.new'class='fnname'>new</a>(re: &<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="../../regex/bytes/struct.Regex.html"title="struct regex::bytes::Regex">Regex</a>, <aclass="enum"href="../../regex/enum.Error.html"title="enum regex::Error">Error</a>></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#105-107'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Compiles a regular expression. Once compiled, it can be used repeatedly
to search, split or replace text in a string.</p>
<p>If an invalid expression is given, then an error is returned.</p>
</div><h4id='method.is_match'class="method"><codeid='is_match.v'>pub fn <ahref='#method.is_match'class='fnname'>is_match</a>(&self, text: <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/re_bytes.rs.html#127-129'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns true if and only if the regex matches the string given.</p>
<p>It is recommended to use this method if all you need to do is test
a match, since the underlying matching engine may be able to do less
<spanclass="kw">let</span><spanclass="ident">text</span><spanclass="op">=</span><spanclass="string">b"I categorically deny having triskaidekaphobia."</span>;
</div><h4id='method.find'class="method"><codeid='find.v'>pub fn <ahref='#method.find'class='fnname'>find</a><'t>(&self, text: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="../../regex/bytes/struct.Match.html"title="struct regex::bytes::Match">Match</a><'t>></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#151-153'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the start and end byte range of the leftmost-first match in
<code>text</code>. If no match exists, then <code>None</code> is returned.</p>
<p>Note that this should only be used if you want to discover the position
of the match. Testing the existence of a match is faster if you use
<spanclass="kw">let</span><spanclass="ident">text</span><spanclass="op">=</span><spanclass="string">b"I categorically deny having triskaidekaphobia."</span>;
</div><h4id='method.find_iter'class="method"><divclass="important-traits"><divclass='tooltip'>ⓘ<spanclass='tooltiptext'>Important traits for <aclass="struct"href="../../regex/bytes/struct.Matches.html"title="struct regex::bytes::Matches">Matches</a><'r, 't></span></div><divclass="content hidden"><h3class="important">Important traits for <aclass="struct"href="../../regex/bytes/struct.Matches.html"title="struct regex::bytes::Matches">Matches</a><'r, 't></h3><codeclass="content"><spanclass="where fmt-newline">impl<'r, 't><aclass="trait"href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <aclass="struct"href="../../regex/bytes/struct.Matches.html"title="struct regex::bytes::Matches">Matches</a><'r, 't></span><spanclass="where fmt-newline"> type <ahref='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item'class="type">Item</a> = <aclass="struct"href="../../regex/bytes/struct.Match.html"title="struct regex::bytes::Match">Match</a><'t>;</span></code></div></div><codeid='find_iter.v'>pub fn <ahref='#method.find_iter'class='fnname'>find_iter</a><'r, 't>(&'r self, text: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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="struct"href="../../regex/bytes/struct.Matches.html"title="struct regex::bytes::Matches">Matches</a><'r, 't></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#173-175'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns an iterator for each successive non-overlapping match in
<code>text</code>, returning the start and end byte indices with respect to
<spanclass="kw">let</span><spanclass="ident">text</span><spanclass="op">=</span><spanclass="string">b"Retroactively relinquishing remunerations is reprehensible."</span>;
</div><h4id='method.captures'class="method"><codeid='captures.v'>pub fn <ahref='#method.captures'class='fnname'>captures</a><'t>(&self, text: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="../../regex/bytes/struct.Captures.html"title="struct regex::bytes::Captures">Captures</a><'t>></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#240-247'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the capture groups corresponding to the leftmost-first
match in <code>text</code>. Capture group <code>0</code> always corresponds to the entire
match. If no match is found, then <code>None</code> is returned.</p>
<p>You should only use <code>captures</code> if you need access to the location of
capturing group matches. Otherwise, <code>find</code> is faster for discovering
<spanclass="comment">// Movie: The Wizard of Oz, Released: 1939</span>
<spanclass="comment">// Movie: M, Released: 1931</span></pre></div>
</div><h4id='method.split'class="method"><divclass="important-traits"><divclass='tooltip'>ⓘ<spanclass='tooltiptext'>Important traits for <aclass="struct"href="../../regex/bytes/struct.Split.html"title="struct regex::bytes::Split">Split</a><'r, 't></span></div><divclass="content hidden"><h3class="important">Important traits for <aclass="struct"href="../../regex/bytes/struct.Split.html"title="struct regex::bytes::Split">Split</a><'r, 't></h3><codeclass="content"><spanclass="where fmt-newline">impl<'r, 't><aclass="trait"href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <aclass="struct"href="../../regex/bytes/struct.Split.html"title="struct regex::bytes::Split">Split</a><'r, 't></span><spanclass="where fmt-newline"> type <ahref='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item'class="type">Item</a> = <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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>;</span></code></div></div><codeid='split.v'>pub fn <ahref='#method.split'class='fnname'>split</a><'r, 't>(&'r self, text: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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="struct"href="../../regex/bytes/struct.Split.html"title="struct regex::bytes::Split">Split</a><'r, 't></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#302-304'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns an iterator of substrings of <code>text</code> delimited by a match of the
regular expression. Namely, each element of the iterator corresponds to
text that <em>isn't</em> matched by the regular expression.</p>
<p>This method will <em>not</em> copy the text given.</p>
<spanclass="kw">let</span><spanclass="ident">fields</span>: <spanclass="ident">Vec</span><spanclass="op"><</span><spanclass="kw-2">&</span>[<spanclass="ident">u8</span>]<spanclass="op">></span><spanclass="op">=</span><spanclass="ident">re</span>.<spanclass="ident">splitn</span>(<spanclass="string">b"Hey! How are you?"</span>, <spanclass="number">3</span>).<spanclass="ident">collect</span>();
</div><h4id='method.replace'class="method"><codeid='replace.v'>pub fn <ahref='#method.replace'class='fnname'>replace</a><'t, R: <aclass="trait"href="../../regex/bytes/trait.Replacer.html"title="trait regex::bytes::Replacer">Replacer</a>>(&self, text: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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>, rep: R) -><aclass="enum"href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html"title="enum alloc::borrow::Cow">Cow</a><'t, <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/re_bytes.rs.html#442-448'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Replaces the leftmost-first match with the replacement provided. The
replacement can be a regular byte string (where <code>$N</code> and <code>$name</code> are
expanded to match capture groups) or a function that takes the matches'
<code>Captures</code> and returns the replaced byte string.</p>
<p>If no match is found, then a copy of the byte string is returned
</div><h4id='method.replace_all'class="method"><codeid='replace_all.v'>pub fn <ahref='#method.replace_all'class='fnname'>replace_all</a><'t, R: <aclass="trait"href="../../regex/bytes/trait.Replacer.html"title="trait regex::bytes::Replacer">Replacer</a>>(<br> &self, <br> text: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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>, <br> rep: R<br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html"title="enum alloc::borrow::Cow">Cow</a><'t, <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/re_bytes.rs.html#456-462'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Replaces all non-overlapping matches in <code>text</code> with the replacement
provided. This is the same as calling <code>replacen</code> with <code>limit</code> set to
<code>0</code>.</p>
<p>See the documentation for <code>replace</code> for details on how to access
capturing group matches in the replacement text.</p>
</div><h4id='method.replacen'class="method"><codeid='replacen.v'>pub fn <ahref='#method.replacen'class='fnname'>replacen</a><'t, R: <aclass="trait"href="../../regex/bytes/trait.Replacer.html"title="trait regex::bytes::Replacer">Replacer</a>>(<br> &self, <br> text: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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>, <br> limit: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> rep: R<br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html"title="enum alloc::borrow::Cow">Cow</a><'t, <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/re_bytes.rs.html#470-515'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Replaces at most <code>limit</code> non-overlapping matches in <code>text</code> with the
replacement provided. If <code>limit</code> is 0, then all non-overlapping matches
are replaced.</p>
<p>See the documentation for <code>replace</code> for details on how to access
capturing group matches in the replacement text.</p>
</div></div><h3id='impl-1'class='impl'><codeclass='in-band'>impl <aclass="struct"href="../../regex/bytes/struct.Regex.html"title="struct regex::bytes::Regex">Regex</a></code><ahref='#impl-1'class='anchor'></a><aclass='srclink'href='../../src/regex/re_bytes.rs.html#519-636'title='goto source code'>[src]</a></h3><divclass='docblock'><p>Advanced or "lower level" search methods.</p>
</div><divclass='impl-items'><h4id='method.shortest_match'class="method"><codeid='shortest_match.v'>pub fn <ahref='#method.shortest_match'class='fnname'>shortest_match</a>(&self, text: <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="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/re_bytes.rs.html#541-543'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the end location of a match in the text given.</p>
<p>This method may have the same performance characteristics as
<code>is_match</code>, except it provides an end location for a match. In
particular, the location returned <em>may be shorter</em> than the proper end
</div><h4id='method.shortest_match_at'class="method"><codeid='shortest_match_at.v'>pub fn <ahref='#method.shortest_match_at'class='fnname'>shortest_match_at</a>(&self, text: <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>, start: <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="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#551-557'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the same as shortest_match, but starts the search at the given
offset.</p>
<p>The significance of the starting point is that it takes the surrounding
context into consideration. For example, the <code>\A</code> anchor can only
match when <code>start == 0</code>.</p>
</div><h4id='method.is_match_at'class="method"><codeid='is_match_at.v'>pub fn <ahref='#method.is_match_at'class='fnname'>is_match_at</a>(&self, text: <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>, start: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#565-567'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the same as is_match, but starts the search at the given
offset.</p>
<p>The significance of the starting point is that it takes the surrounding
context into consideration. For example, the <code>\A</code> anchor can only
match when <code>start == 0</code>.</p>
</div><h4id='method.find_at'class="method"><codeid='find_at.v'>pub fn <ahref='#method.find_at'class='fnname'>find_at</a><'t>(&self, text: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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>, start: <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/bytes/struct.Match.html"title="struct regex::bytes::Match">Match</a><'t>></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#575-584'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the same as find, but starts the search at the given
offset.</p>
<p>The significance of the starting point is that it takes the surrounding
context into consideration. For example, the <code>\A</code> anchor can only
match when <code>start == 0</code>.</p>
</div><h4id='method.captures_read'class="method"><codeid='captures_read.v'>pub fn <ahref='#method.captures_read'class='fnname'>captures_read</a><'t>(<br> &self, <br> locs: &mut <aclass="struct"href="../../regex/bytes/struct.CaptureLocations.html"title="struct regex::bytes::CaptureLocations">CaptureLocations</a>, <br> text: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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><br>) -><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/bytes/struct.Match.html"title="struct regex::bytes::Match">Match</a><'t>></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#596-602'title='goto source code'>[src]</a></h4><divclass='docblock'><p>This is like <code>captures</code>, but uses
<ahref="struct.Captures.html"><code>Captures</code></a> in order to amortize allocations.</p>
<p>To create a <code>CaptureLocations</code> value, use the
<code>Regex::capture_locations</code> method.</p>
<p>This returns the overall match if this was successful, which is always
equivalence to the <code>0</code>th capture group.</p>
</div><h4id='method.captures_read_at'class="method"><codeid='captures_read_at.v'>pub fn <ahref='#method.captures_read_at'class='fnname'>captures_read_at</a><'t>(<br> &self, <br> locs: &mut <aclass="struct"href="../../regex/bytes/struct.CaptureLocations.html"title="struct regex::bytes::CaptureLocations">CaptureLocations</a>, <br> text: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'t [</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>, <br> start: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -><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/bytes/struct.Match.html"title="struct regex::bytes::Match">Match</a><'t>></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#610-620'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the same as <code>captures_read</code>, but starts the search at the given
offset and populates the capture locations given.</p>
<p>The significance of the starting point is that it takes the surrounding
context into consideration. For example, the <code>\A</code> anchor can only
</div><divclass='impl-items'><h4id='method.as_str'class="method"><codeid='as_str.v'>pub fn <ahref='#method.as_str'class='fnname'>as_str</a>(&self) ->&<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#641-643'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the original string of this regex.</p>
</div><h4id='method.capture_names'class="method"><divclass="important-traits"><divclass='tooltip'>ⓘ<spanclass='tooltiptext'>Important traits for <aclass="struct"href="../../regex/bytes/struct.CaptureNames.html"title="struct regex::bytes::CaptureNames">CaptureNames</a><'r></span></div><divclass="content hidden"><h3class="important">Important traits for <aclass="struct"href="../../regex/bytes/struct.CaptureNames.html"title="struct regex::bytes::CaptureNames">CaptureNames</a><'r></h3><codeclass="content"><spanclass="where fmt-newline">impl<'r><aclass="trait"href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <aclass="struct"href="../../regex/bytes/struct.CaptureNames.html"title="struct regex::bytes::CaptureNames">CaptureNames</a><'r></span><spanclass="where fmt-newline"> type <ahref='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item'class="type">Item</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&'r <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>;</span></code></div></div><codeid='capture_names.v'>pub fn <ahref='#method.capture_names'class='fnname'>capture_names</a>(&self) -><aclass="struct"href="../../regex/bytes/struct.CaptureNames.html"title="struct regex::bytes::CaptureNames">CaptureNames</a></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#646-648'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns an iterator over the capture names.</p>
</div><h4id='method.captures_len'class="method"><codeid='captures_len.v'>pub fn <ahref='#method.captures_len'class='fnname'>captures_len</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#651-653'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the number of captures.</p>
</div><h4id='method.capture_locations'class="method"><codeid='capture_locations.v'>pub fn <ahref='#method.capture_locations'class='fnname'>capture_locations</a>(&self) -><aclass="struct"href="../../regex/bytes/struct.CaptureLocations.html"title="struct regex::bytes::CaptureLocations">CaptureLocations</a></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#657-659'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns an empty set of capture locations that can be reused in
multiple calls to <code>captures_read</code> or <code>captures_read_at</code>.</p>
</div></div><h2id='implementations'class='small-section-header'>Trait Implementations<ahref='#implementations'class='anchor'></a></h2><divid='implementations-list'><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/bytes/struct.Regex.html"title="struct regex::bytes::Regex">Regex</a></code><ahref='#impl-Clone'class='anchor'></a><aclass='srclink'href='../../src/regex/re_bytes.rs.html#63'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/bytes/struct.Regex.html"title="struct regex::bytes::Regex">Regex</a></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#63'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-FromStr'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html"title="trait core::str::FromStr">FromStr</a> for <aclass="struct"href="../../regex/bytes/struct.Regex.html"title="struct regex::bytes::Regex">Regex</a></code><ahref='#impl-FromStr'class='anchor'></a><aclass='srclink'href='../../src/regex/re_bytes.rs.html#90-97'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Err'class="type"><codeid='Err.t'>type <ahref='https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#associatedtype.Err'class="type">Err</a> = <aclass="enum"href="../../regex/enum.Error.html"title="enum regex::Error">Error</a></code></h4><divclass='docblock'><p>The associated error which can be returned from parsing.</p>
</div><h4id='method.from_str'class="method"><codeid='from_str.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#tymethod.from_str'class='fnname'>from_str</a>(s: &<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="../../regex/bytes/struct.Regex.html"title="struct regex::bytes::Regex">Regex</a>, <aclass="enum"href="../../regex/enum.Error.html"title="enum regex::Error">Error</a>></code><aclass='srclink'href='../../src/regex/re_bytes.rs.html#94-96'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Attempts to parse a string into a regular expression</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";</script><scriptsrc="../../aliases.js"></script><scriptsrc="../../main.js"></script><scriptdefersrc="../../search-index.js"></script></body></html>
