blob: b1de3920d2f9aa33e83f60e83032e64f4485bb71 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/regex-1.8.3/src/re_bytes.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>re_bytes.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../regex/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../regex/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</span>
<span id="601">601</span>
<span id="602">602</span>
<span id="603">603</span>
<span id="604">604</span>
<span id="605">605</span>
<span id="606">606</span>
<span id="607">607</span>
<span id="608">608</span>
<span id="609">609</span>
<span id="610">610</span>
<span id="611">611</span>
<span id="612">612</span>
<span id="613">613</span>
<span id="614">614</span>
<span id="615">615</span>
<span id="616">616</span>
<span id="617">617</span>
<span id="618">618</span>
<span id="619">619</span>
<span id="620">620</span>
<span id="621">621</span>
<span id="622">622</span>
<span id="623">623</span>
<span id="624">624</span>
<span id="625">625</span>
<span id="626">626</span>
<span id="627">627</span>
<span id="628">628</span>
<span id="629">629</span>
<span id="630">630</span>
<span id="631">631</span>
<span id="632">632</span>
<span id="633">633</span>
<span id="634">634</span>
<span id="635">635</span>
<span id="636">636</span>
<span id="637">637</span>
<span id="638">638</span>
<span id="639">639</span>
<span id="640">640</span>
<span id="641">641</span>
<span id="642">642</span>
<span id="643">643</span>
<span id="644">644</span>
<span id="645">645</span>
<span id="646">646</span>
<span id="647">647</span>
<span id="648">648</span>
<span id="649">649</span>
<span id="650">650</span>
<span id="651">651</span>
<span id="652">652</span>
<span id="653">653</span>
<span id="654">654</span>
<span id="655">655</span>
<span id="656">656</span>
<span id="657">657</span>
<span id="658">658</span>
<span id="659">659</span>
<span id="660">660</span>
<span id="661">661</span>
<span id="662">662</span>
<span id="663">663</span>
<span id="664">664</span>
<span id="665">665</span>
<span id="666">666</span>
<span id="667">667</span>
<span id="668">668</span>
<span id="669">669</span>
<span id="670">670</span>
<span id="671">671</span>
<span id="672">672</span>
<span id="673">673</span>
<span id="674">674</span>
<span id="675">675</span>
<span id="676">676</span>
<span id="677">677</span>
<span id="678">678</span>
<span id="679">679</span>
<span id="680">680</span>
<span id="681">681</span>
<span id="682">682</span>
<span id="683">683</span>
<span id="684">684</span>
<span id="685">685</span>
<span id="686">686</span>
<span id="687">687</span>
<span id="688">688</span>
<span id="689">689</span>
<span id="690">690</span>
<span id="691">691</span>
<span id="692">692</span>
<span id="693">693</span>
<span id="694">694</span>
<span id="695">695</span>
<span id="696">696</span>
<span id="697">697</span>
<span id="698">698</span>
<span id="699">699</span>
<span id="700">700</span>
<span id="701">701</span>
<span id="702">702</span>
<span id="703">703</span>
<span id="704">704</span>
<span id="705">705</span>
<span id="706">706</span>
<span id="707">707</span>
<span id="708">708</span>
<span id="709">709</span>
<span id="710">710</span>
<span id="711">711</span>
<span id="712">712</span>
<span id="713">713</span>
<span id="714">714</span>
<span id="715">715</span>
<span id="716">716</span>
<span id="717">717</span>
<span id="718">718</span>
<span id="719">719</span>
<span id="720">720</span>
<span id="721">721</span>
<span id="722">722</span>
<span id="723">723</span>
<span id="724">724</span>
<span id="725">725</span>
<span id="726">726</span>
<span id="727">727</span>
<span id="728">728</span>
<span id="729">729</span>
<span id="730">730</span>
<span id="731">731</span>
<span id="732">732</span>
<span id="733">733</span>
<span id="734">734</span>
<span id="735">735</span>
<span id="736">736</span>
<span id="737">737</span>
<span id="738">738</span>
<span id="739">739</span>
<span id="740">740</span>
<span id="741">741</span>
<span id="742">742</span>
<span id="743">743</span>
<span id="744">744</span>
<span id="745">745</span>
<span id="746">746</span>
<span id="747">747</span>
<span id="748">748</span>
<span id="749">749</span>
<span id="750">750</span>
<span id="751">751</span>
<span id="752">752</span>
<span id="753">753</span>
<span id="754">754</span>
<span id="755">755</span>
<span id="756">756</span>
<span id="757">757</span>
<span id="758">758</span>
<span id="759">759</span>
<span id="760">760</span>
<span id="761">761</span>
<span id="762">762</span>
<span id="763">763</span>
<span id="764">764</span>
<span id="765">765</span>
<span id="766">766</span>
<span id="767">767</span>
<span id="768">768</span>
<span id="769">769</span>
<span id="770">770</span>
<span id="771">771</span>
<span id="772">772</span>
<span id="773">773</span>
<span id="774">774</span>
<span id="775">775</span>
<span id="776">776</span>
<span id="777">777</span>
<span id="778">778</span>
<span id="779">779</span>
<span id="780">780</span>
<span id="781">781</span>
<span id="782">782</span>
<span id="783">783</span>
<span id="784">784</span>
<span id="785">785</span>
<span id="786">786</span>
<span id="787">787</span>
<span id="788">788</span>
<span id="789">789</span>
<span id="790">790</span>
<span id="791">791</span>
<span id="792">792</span>
<span id="793">793</span>
<span id="794">794</span>
<span id="795">795</span>
<span id="796">796</span>
<span id="797">797</span>
<span id="798">798</span>
<span id="799">799</span>
<span id="800">800</span>
<span id="801">801</span>
<span id="802">802</span>
<span id="803">803</span>
<span id="804">804</span>
<span id="805">805</span>
<span id="806">806</span>
<span id="807">807</span>
<span id="808">808</span>
<span id="809">809</span>
<span id="810">810</span>
<span id="811">811</span>
<span id="812">812</span>
<span id="813">813</span>
<span id="814">814</span>
<span id="815">815</span>
<span id="816">816</span>
<span id="817">817</span>
<span id="818">818</span>
<span id="819">819</span>
<span id="820">820</span>
<span id="821">821</span>
<span id="822">822</span>
<span id="823">823</span>
<span id="824">824</span>
<span id="825">825</span>
<span id="826">826</span>
<span id="827">827</span>
<span id="828">828</span>
<span id="829">829</span>
<span id="830">830</span>
<span id="831">831</span>
<span id="832">832</span>
<span id="833">833</span>
<span id="834">834</span>
<span id="835">835</span>
<span id="836">836</span>
<span id="837">837</span>
<span id="838">838</span>
<span id="839">839</span>
<span id="840">840</span>
<span id="841">841</span>
<span id="842">842</span>
<span id="843">843</span>
<span id="844">844</span>
<span id="845">845</span>
<span id="846">846</span>
<span id="847">847</span>
<span id="848">848</span>
<span id="849">849</span>
<span id="850">850</span>
<span id="851">851</span>
<span id="852">852</span>
<span id="853">853</span>
<span id="854">854</span>
<span id="855">855</span>
<span id="856">856</span>
<span id="857">857</span>
<span id="858">858</span>
<span id="859">859</span>
<span id="860">860</span>
<span id="861">861</span>
<span id="862">862</span>
<span id="863">863</span>
<span id="864">864</span>
<span id="865">865</span>
<span id="866">866</span>
<span id="867">867</span>
<span id="868">868</span>
<span id="869">869</span>
<span id="870">870</span>
<span id="871">871</span>
<span id="872">872</span>
<span id="873">873</span>
<span id="874">874</span>
<span id="875">875</span>
<span id="876">876</span>
<span id="877">877</span>
<span id="878">878</span>
<span id="879">879</span>
<span id="880">880</span>
<span id="881">881</span>
<span id="882">882</span>
<span id="883">883</span>
<span id="884">884</span>
<span id="885">885</span>
<span id="886">886</span>
<span id="887">887</span>
<span id="888">888</span>
<span id="889">889</span>
<span id="890">890</span>
<span id="891">891</span>
<span id="892">892</span>
<span id="893">893</span>
<span id="894">894</span>
<span id="895">895</span>
<span id="896">896</span>
<span id="897">897</span>
<span id="898">898</span>
<span id="899">899</span>
<span id="900">900</span>
<span id="901">901</span>
<span id="902">902</span>
<span id="903">903</span>
<span id="904">904</span>
<span id="905">905</span>
<span id="906">906</span>
<span id="907">907</span>
<span id="908">908</span>
<span id="909">909</span>
<span id="910">910</span>
<span id="911">911</span>
<span id="912">912</span>
<span id="913">913</span>
<span id="914">914</span>
<span id="915">915</span>
<span id="916">916</span>
<span id="917">917</span>
<span id="918">918</span>
<span id="919">919</span>
<span id="920">920</span>
<span id="921">921</span>
<span id="922">922</span>
<span id="923">923</span>
<span id="924">924</span>
<span id="925">925</span>
<span id="926">926</span>
<span id="927">927</span>
<span id="928">928</span>
<span id="929">929</span>
<span id="930">930</span>
<span id="931">931</span>
<span id="932">932</span>
<span id="933">933</span>
<span id="934">934</span>
<span id="935">935</span>
<span id="936">936</span>
<span id="937">937</span>
<span id="938">938</span>
<span id="939">939</span>
<span id="940">940</span>
<span id="941">941</span>
<span id="942">942</span>
<span id="943">943</span>
<span id="944">944</span>
<span id="945">945</span>
<span id="946">946</span>
<span id="947">947</span>
<span id="948">948</span>
<span id="949">949</span>
<span id="950">950</span>
<span id="951">951</span>
<span id="952">952</span>
<span id="953">953</span>
<span id="954">954</span>
<span id="955">955</span>
<span id="956">956</span>
<span id="957">957</span>
<span id="958">958</span>
<span id="959">959</span>
<span id="960">960</span>
<span id="961">961</span>
<span id="962">962</span>
<span id="963">963</span>
<span id="964">964</span>
<span id="965">965</span>
<span id="966">966</span>
<span id="967">967</span>
<span id="968">968</span>
<span id="969">969</span>
<span id="970">970</span>
<span id="971">971</span>
<span id="972">972</span>
<span id="973">973</span>
<span id="974">974</span>
<span id="975">975</span>
<span id="976">976</span>
<span id="977">977</span>
<span id="978">978</span>
<span id="979">979</span>
<span id="980">980</span>
<span id="981">981</span>
<span id="982">982</span>
<span id="983">983</span>
<span id="984">984</span>
<span id="985">985</span>
<span id="986">986</span>
<span id="987">987</span>
<span id="988">988</span>
<span id="989">989</span>
<span id="990">990</span>
<span id="991">991</span>
<span id="992">992</span>
<span id="993">993</span>
<span id="994">994</span>
<span id="995">995</span>
<span id="996">996</span>
<span id="997">997</span>
<span id="998">998</span>
<span id="999">999</span>
<span id="1000">1000</span>
<span id="1001">1001</span>
<span id="1002">1002</span>
<span id="1003">1003</span>
<span id="1004">1004</span>
<span id="1005">1005</span>
<span id="1006">1006</span>
<span id="1007">1007</span>
<span id="1008">1008</span>
<span id="1009">1009</span>
<span id="1010">1010</span>
<span id="1011">1011</span>
<span id="1012">1012</span>
<span id="1013">1013</span>
<span id="1014">1014</span>
<span id="1015">1015</span>
<span id="1016">1016</span>
<span id="1017">1017</span>
<span id="1018">1018</span>
<span id="1019">1019</span>
<span id="1020">1020</span>
<span id="1021">1021</span>
<span id="1022">1022</span>
<span id="1023">1023</span>
<span id="1024">1024</span>
<span id="1025">1025</span>
<span id="1026">1026</span>
<span id="1027">1027</span>
<span id="1028">1028</span>
<span id="1029">1029</span>
<span id="1030">1030</span>
<span id="1031">1031</span>
<span id="1032">1032</span>
<span id="1033">1033</span>
<span id="1034">1034</span>
<span id="1035">1035</span>
<span id="1036">1036</span>
<span id="1037">1037</span>
<span id="1038">1038</span>
<span id="1039">1039</span>
<span id="1040">1040</span>
<span id="1041">1041</span>
<span id="1042">1042</span>
<span id="1043">1043</span>
<span id="1044">1044</span>
<span id="1045">1045</span>
<span id="1046">1046</span>
<span id="1047">1047</span>
<span id="1048">1048</span>
<span id="1049">1049</span>
<span id="1050">1050</span>
<span id="1051">1051</span>
<span id="1052">1052</span>
<span id="1053">1053</span>
<span id="1054">1054</span>
<span id="1055">1055</span>
<span id="1056">1056</span>
<span id="1057">1057</span>
<span id="1058">1058</span>
<span id="1059">1059</span>
<span id="1060">1060</span>
<span id="1061">1061</span>
<span id="1062">1062</span>
<span id="1063">1063</span>
<span id="1064">1064</span>
<span id="1065">1065</span>
<span id="1066">1066</span>
<span id="1067">1067</span>
<span id="1068">1068</span>
<span id="1069">1069</span>
<span id="1070">1070</span>
<span id="1071">1071</span>
<span id="1072">1072</span>
<span id="1073">1073</span>
<span id="1074">1074</span>
<span id="1075">1075</span>
<span id="1076">1076</span>
<span id="1077">1077</span>
<span id="1078">1078</span>
<span id="1079">1079</span>
<span id="1080">1080</span>
<span id="1081">1081</span>
<span id="1082">1082</span>
<span id="1083">1083</span>
<span id="1084">1084</span>
<span id="1085">1085</span>
<span id="1086">1086</span>
<span id="1087">1087</span>
<span id="1088">1088</span>
<span id="1089">1089</span>
<span id="1090">1090</span>
<span id="1091">1091</span>
<span id="1092">1092</span>
<span id="1093">1093</span>
<span id="1094">1094</span>
<span id="1095">1095</span>
<span id="1096">1096</span>
<span id="1097">1097</span>
<span id="1098">1098</span>
<span id="1099">1099</span>
<span id="1100">1100</span>
<span id="1101">1101</span>
<span id="1102">1102</span>
<span id="1103">1103</span>
<span id="1104">1104</span>
<span id="1105">1105</span>
<span id="1106">1106</span>
<span id="1107">1107</span>
<span id="1108">1108</span>
<span id="1109">1109</span>
<span id="1110">1110</span>
<span id="1111">1111</span>
<span id="1112">1112</span>
<span id="1113">1113</span>
<span id="1114">1114</span>
<span id="1115">1115</span>
<span id="1116">1116</span>
<span id="1117">1117</span>
<span id="1118">1118</span>
<span id="1119">1119</span>
<span id="1120">1120</span>
<span id="1121">1121</span>
<span id="1122">1122</span>
<span id="1123">1123</span>
<span id="1124">1124</span>
<span id="1125">1125</span>
<span id="1126">1126</span>
<span id="1127">1127</span>
<span id="1128">1128</span>
<span id="1129">1129</span>
<span id="1130">1130</span>
<span id="1131">1131</span>
<span id="1132">1132</span>
<span id="1133">1133</span>
<span id="1134">1134</span>
<span id="1135">1135</span>
<span id="1136">1136</span>
<span id="1137">1137</span>
<span id="1138">1138</span>
<span id="1139">1139</span>
<span id="1140">1140</span>
<span id="1141">1141</span>
<span id="1142">1142</span>
<span id="1143">1143</span>
<span id="1144">1144</span>
<span id="1145">1145</span>
<span id="1146">1146</span>
<span id="1147">1147</span>
<span id="1148">1148</span>
<span id="1149">1149</span>
<span id="1150">1150</span>
<span id="1151">1151</span>
<span id="1152">1152</span>
<span id="1153">1153</span>
<span id="1154">1154</span>
<span id="1155">1155</span>
<span id="1156">1156</span>
<span id="1157">1157</span>
<span id="1158">1158</span>
<span id="1159">1159</span>
<span id="1160">1160</span>
<span id="1161">1161</span>
<span id="1162">1162</span>
<span id="1163">1163</span>
<span id="1164">1164</span>
<span id="1165">1165</span>
<span id="1166">1166</span>
<span id="1167">1167</span>
<span id="1168">1168</span>
<span id="1169">1169</span>
<span id="1170">1170</span>
<span id="1171">1171</span>
<span id="1172">1172</span>
<span id="1173">1173</span>
<span id="1174">1174</span>
<span id="1175">1175</span>
<span id="1176">1176</span>
<span id="1177">1177</span>
<span id="1178">1178</span>
<span id="1179">1179</span>
<span id="1180">1180</span>
<span id="1181">1181</span>
<span id="1182">1182</span>
<span id="1183">1183</span>
<span id="1184">1184</span>
<span id="1185">1185</span>
<span id="1186">1186</span>
<span id="1187">1187</span>
<span id="1188">1188</span>
<span id="1189">1189</span>
<span id="1190">1190</span>
<span id="1191">1191</span>
<span id="1192">1192</span>
<span id="1193">1193</span>
<span id="1194">1194</span>
<span id="1195">1195</span>
<span id="1196">1196</span>
<span id="1197">1197</span>
<span id="1198">1198</span>
<span id="1199">1199</span>
<span id="1200">1200</span>
<span id="1201">1201</span>
<span id="1202">1202</span>
<span id="1203">1203</span>
<span id="1204">1204</span>
<span id="1205">1205</span>
<span id="1206">1206</span>
<span id="1207">1207</span>
<span id="1208">1208</span>
<span id="1209">1209</span>
<span id="1210">1210</span>
<span id="1211">1211</span>
<span id="1212">1212</span>
<span id="1213">1213</span>
<span id="1214">1214</span>
<span id="1215">1215</span>
<span id="1216">1216</span>
<span id="1217">1217</span>
<span id="1218">1218</span>
<span id="1219">1219</span>
<span id="1220">1220</span>
<span id="1221">1221</span>
<span id="1222">1222</span>
<span id="1223">1223</span>
<span id="1224">1224</span>
<span id="1225">1225</span>
<span id="1226">1226</span>
<span id="1227">1227</span>
<span id="1228">1228</span>
<span id="1229">1229</span>
<span id="1230">1230</span>
<span id="1231">1231</span>
<span id="1232">1232</span>
<span id="1233">1233</span>
<span id="1234">1234</span>
<span id="1235">1235</span>
<span id="1236">1236</span>
<span id="1237">1237</span>
<span id="1238">1238</span>
<span id="1239">1239</span>
<span id="1240">1240</span>
<span id="1241">1241</span>
<span id="1242">1242</span>
<span id="1243">1243</span>
<span id="1244">1244</span>
<span id="1245">1245</span>
<span id="1246">1246</span>
<span id="1247">1247</span>
<span id="1248">1248</span>
<span id="1249">1249</span>
<span id="1250">1250</span>
<span id="1251">1251</span>
<span id="1252">1252</span>
<span id="1253">1253</span>
<span id="1254">1254</span>
<span id="1255">1255</span>
<span id="1256">1256</span>
<span id="1257">1257</span>
<span id="1258">1258</span>
<span id="1259">1259</span>
<span id="1260">1260</span>
<span id="1261">1261</span>
<span id="1262">1262</span>
<span id="1263">1263</span>
<span id="1264">1264</span>
<span id="1265">1265</span>
<span id="1266">1266</span>
<span id="1267">1267</span>
<span id="1268">1268</span>
<span id="1269">1269</span>
<span id="1270">1270</span>
<span id="1271">1271</span>
<span id="1272">1272</span>
<span id="1273">1273</span>
<span id="1274">1274</span>
<span id="1275">1275</span>
<span id="1276">1276</span>
<span id="1277">1277</span>
<span id="1278">1278</span>
<span id="1279">1279</span>
<span id="1280">1280</span>
<span id="1281">1281</span>
<span id="1282">1282</span>
<span id="1283">1283</span>
<span id="1284">1284</span>
<span id="1285">1285</span>
<span id="1286">1286</span>
<span id="1287">1287</span>
<span id="1288">1288</span>
<span id="1289">1289</span>
<span id="1290">1290</span>
<span id="1291">1291</span>
<span id="1292">1292</span>
<span id="1293">1293</span>
<span id="1294">1294</span>
<span id="1295">1295</span>
<span id="1296">1296</span>
<span id="1297">1297</span>
<span id="1298">1298</span>
<span id="1299">1299</span>
<span id="1300">1300</span>
<span id="1301">1301</span>
<span id="1302">1302</span>
<span id="1303">1303</span>
<span id="1304">1304</span>
<span id="1305">1305</span>
<span id="1306">1306</span>
<span id="1307">1307</span>
<span id="1308">1308</span>
<span id="1309">1309</span>
<span id="1310">1310</span>
<span id="1311">1311</span>
<span id="1312">1312</span>
<span id="1313">1313</span>
<span id="1314">1314</span>
<span id="1315">1315</span>
<span id="1316">1316</span>
<span id="1317">1317</span>
<span id="1318">1318</span>
<span id="1319">1319</span>
<span id="1320">1320</span>
<span id="1321">1321</span>
<span id="1322">1322</span>
<span id="1323">1323</span>
<span id="1324">1324</span>
<span id="1325">1325</span>
<span id="1326">1326</span>
<span id="1327">1327</span>
<span id="1328">1328</span>
<span id="1329">1329</span>
<span id="1330">1330</span>
<span id="1331">1331</span>
<span id="1332">1332</span>
<span id="1333">1333</span>
<span id="1334">1334</span>
<span id="1335">1335</span>
<span id="1336">1336</span>
<span id="1337">1337</span>
<span id="1338">1338</span>
<span id="1339">1339</span>
<span id="1340">1340</span>
<span id="1341">1341</span>
<span id="1342">1342</span>
<span id="1343">1343</span>
<span id="1344">1344</span>
<span id="1345">1345</span>
<span id="1346">1346</span>
<span id="1347">1347</span>
<span id="1348">1348</span>
<span id="1349">1349</span>
<span id="1350">1350</span>
<span id="1351">1351</span>
<span id="1352">1352</span>
<span id="1353">1353</span>
<span id="1354">1354</span>
<span id="1355">1355</span>
<span id="1356">1356</span>
<span id="1357">1357</span>
<span id="1358">1358</span>
<span id="1359">1359</span>
<span id="1360">1360</span>
<span id="1361">1361</span>
<span id="1362">1362</span>
<span id="1363">1363</span>
<span id="1364">1364</span>
<span id="1365">1365</span>
<span id="1366">1366</span>
<span id="1367">1367</span>
<span id="1368">1368</span>
<span id="1369">1369</span>
<span id="1370">1370</span>
<span id="1371">1371</span>
<span id="1372">1372</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::borrow::Cow;
<span class="kw">use </span>std::collections::HashMap;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::iter::FusedIterator;
<span class="kw">use </span>std::ops::{Index, Range};
<span class="kw">use </span>std::str::FromStr;
<span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span><span class="kw">crate</span>::find_byte::find_byte;
<span class="kw">use </span><span class="kw">crate</span>::error::Error;
<span class="kw">use </span><span class="kw">crate</span>::exec::{Exec, ExecNoSync};
<span class="kw">use </span><span class="kw">crate</span>::expand::expand_bytes;
<span class="kw">use </span><span class="kw">crate</span>::re_builder::bytes::RegexBuilder;
<span class="kw">use </span><span class="kw">crate</span>::re_trait::{<span class="self">self</span>, RegularExpression, SubCapturesPosIter};
<span class="doccomment">/// Match represents a single match of a regex in a haystack.
///
/// The lifetime parameter `&#39;t` refers to the lifetime of the matched text.
</span><span class="attribute">#[derive(Copy, Clone, Eq, PartialEq)]
</span><span class="kw">pub struct </span>Match&lt;<span class="lifetime">&#39;t</span>&gt; {
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
start: usize,
end: usize,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;t</span>&gt; Match&lt;<span class="lifetime">&#39;t</span>&gt; {
<span class="doccomment">/// Returns the starting byte offset of the match in the haystack.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>start(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.start
}
<span class="doccomment">/// Returns the ending byte offset of the match in the haystack.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>end(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.end
}
<span class="doccomment">/// Returns true if and only if this match has a length of zero.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.start == <span class="self">self</span>.end
}
<span class="doccomment">/// Returns the length, in bytes, of this match.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.end - <span class="self">self</span>.start
}
<span class="doccomment">/// Returns the range over the starting and ending byte offsets of the
/// match in the haystack.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>range(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Range&lt;usize&gt; {
<span class="self">self</span>.start..<span class="self">self</span>.end
}
<span class="doccomment">/// Returns the matched text.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>as_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8] {
<span class="kw-2">&amp;</span><span class="self">self</span>.text[<span class="self">self</span>.range()]
}
<span class="doccomment">/// Creates a new match from the given haystack and byte offsets.
</span><span class="attribute">#[inline]
</span><span class="kw">fn </span>new(haystack: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8], start: usize, end: usize) -&gt; Match&lt;<span class="lifetime">&#39;t</span>&gt; {
Match { text: haystack, start, end }
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;t</span>&gt; std::fmt::Debug <span class="kw">for </span>Match&lt;<span class="lifetime">&#39;t</span>&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>std::fmt::Formatter) -&gt; std::fmt::Result {
<span class="kw">let </span><span class="kw-2">mut </span>fmt = f.debug_struct(<span class="string">&quot;Match&quot;</span>);
fmt.field(<span class="string">&quot;start&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.start).field(<span class="string">&quot;end&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.end);
<span class="kw">if let </span><span class="prelude-val">Ok</span>(s) = std::str::from_utf8(<span class="self">self</span>.as_bytes()) {
fmt.field(<span class="string">&quot;bytes&quot;</span>, <span class="kw-2">&amp;</span>s);
} <span class="kw">else </span>{
<span class="comment">// FIXME: It would be nice if this could be printed as a string
// with invalid UTF-8 replaced with hex escapes. A alloc would
// probably okay if that makes it easier, but regex-automata does
// (at time of writing) have internal routines that do this. So
// maybe we should expose them.
</span>fmt.field(<span class="string">&quot;bytes&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.as_bytes());
}
fmt.finish()
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;t</span>&gt; From&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt; <span class="kw">for </span>Range&lt;usize&gt; {
<span class="kw">fn </span>from(m: Match&lt;<span class="lifetime">&#39;t</span>&gt;) -&gt; Range&lt;usize&gt; {
m.range()
}
}
<span class="doccomment">/// A compiled regular expression for matching arbitrary bytes.
///
/// It can be used to search, split or replace text. All searching is done with
/// an implicit `.*?` 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 `^` or `$` (or `\A` and `\z`).
///
/// Like the `Regex` type in the parent module, matches with this regex return
/// byte offsets into the search text. **Unlike** the parent `Regex` type,
/// these byte offsets may not correspond to UTF-8 sequence boundaries since
/// the regexes in this module can match arbitrary bytes.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>Regex(Exec);
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Regex {
<span class="doccomment">/// Shows the original regular expression.
</span><span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
<span class="macro">write!</span>(f, <span class="string">&quot;{}&quot;</span>, <span class="self">self</span>.as_str())
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Regex {
<span class="doccomment">/// Shows the original regular expression.
</span><span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
fmt::Display::fmt(<span class="self">self</span>, f)
}
}
<span class="doccomment">/// A constructor for Regex from an Exec.
///
/// This is hidden because Exec isn&#39;t actually part of the public API.
</span><span class="attribute">#[doc(hidden)]
</span><span class="kw">impl </span>From&lt;Exec&gt; <span class="kw">for </span>Regex {
<span class="kw">fn </span>from(exec: Exec) -&gt; Regex {
Regex(exec)
}
}
<span class="kw">impl </span>FromStr <span class="kw">for </span>Regex {
<span class="kw">type </span><span class="prelude-val">Err </span>= Error;
<span class="doccomment">/// Attempts to parse a string into a regular expression
</span><span class="kw">fn </span>from_str(s: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;Regex, Error&gt; {
Regex::new(s)
}
}
<span class="doccomment">/// Core regular expression methods.
</span><span class="kw">impl </span>Regex {
<span class="doccomment">/// Compiles a regular expression. Once compiled, it can be used repeatedly
/// to search, split or replace text in a string.
///
/// If an invalid expression is given, then an error is returned.
</span><span class="kw">pub fn </span>new(re: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;Regex, Error&gt; {
RegexBuilder::new(re).build()
}
<span class="doccomment">/// Returns true if and only if there is a match for the regex in the
/// string given.
///
/// 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
/// work.
///
/// # Example
///
/// Test if some text contains at least one word with exactly 13 ASCII word
/// bytes:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let text = b&quot;I categorically deny having triskaidekaphobia.&quot;;
/// assert!(Regex::new(r&quot;\b\w{13}\b&quot;).unwrap().is_match(text));
/// # }
/// ```
</span><span class="kw">pub fn </span>is_match(<span class="kw-2">&amp;</span><span class="self">self</span>, text: <span class="kw-2">&amp;</span>[u8]) -&gt; bool {
<span class="self">self</span>.is_match_at(text, <span class="number">0</span>)
}
<span class="doccomment">/// Returns the start and end byte range of the leftmost-first match in
/// `text`. If no match exists, then `None` is returned.
///
/// 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
/// `is_match`.
///
/// # Example
///
/// Find the start and end location of the first word with exactly 13
/// ASCII word bytes:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let text = b&quot;I categorically deny having triskaidekaphobia.&quot;;
/// let mat = Regex::new(r&quot;\b\w{13}\b&quot;).unwrap().find(text).unwrap();
/// assert_eq!((mat.start(), mat.end()), (2, 15));
/// # }
/// ```
</span><span class="kw">pub fn </span>find&lt;<span class="lifetime">&#39;t</span>&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8]) -&gt; <span class="prelude-ty">Option</span>&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="self">self</span>.find_at(text, <span class="number">0</span>)
}
<span class="doccomment">/// Returns an iterator for each successive non-overlapping match in
/// `text`, returning the start and end byte indices with respect to
/// `text`.
///
/// # Example
///
/// Find the start and end location of every word with exactly 13 ASCII
/// word bytes:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let text = b&quot;Retroactively relinquishing remunerations is reprehensible.&quot;;
/// for mat in Regex::new(r&quot;\b\w{13}\b&quot;).unwrap().find_iter(text) {
/// println!(&quot;{:?}&quot;, mat);
/// }
/// # }
/// ```
</span><span class="kw">pub fn </span>find_iter&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;r </span><span class="self">self</span>, text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8]) -&gt; Matches&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {
Matches(<span class="self">self</span>.<span class="number">0</span>.searcher().find_iter(text))
}
<span class="doccomment">/// Returns the capture groups corresponding to the leftmost-first
/// match in `text`. Capture group `0` always corresponds to the entire
/// match. If no match is found, then `None` is returned.
///
/// You should only use `captures` if you need access to the location of
/// capturing group matches. Otherwise, `find` is faster for discovering
/// the location of the overall match.
///
/// # Examples
///
/// Say you have some text with movie names and their release years,
/// like &quot;&#39;Citizen Kane&#39; (1941)&quot;. It&#39;d be nice if we could search for text
/// looking like that, while also extracting the movie name and its release
/// year separately.
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let re = Regex::new(r&quot;&#39;([^&#39;]+)&#39;\s+\((\d{4})\)&quot;).unwrap();
/// let text = b&quot;Not my favorite movie: &#39;Citizen Kane&#39; (1941).&quot;;
/// let caps = re.captures(text).unwrap();
/// assert_eq!(caps.get(1).unwrap().as_bytes(), &amp;b&quot;Citizen Kane&quot;[..]);
/// assert_eq!(caps.get(2).unwrap().as_bytes(), &amp;b&quot;1941&quot;[..]);
/// assert_eq!(caps.get(0).unwrap().as_bytes(), &amp;b&quot;&#39;Citizen Kane&#39; (1941)&quot;[..]);
/// // You can also access the groups by index using the Index notation.
/// // Note that this will panic on an invalid index.
/// assert_eq!(&amp;caps[1], b&quot;Citizen Kane&quot;);
/// assert_eq!(&amp;caps[2], b&quot;1941&quot;);
/// assert_eq!(&amp;caps[0], b&quot;&#39;Citizen Kane&#39; (1941)&quot;);
/// # }
/// ```
///
/// Note that the full match is at capture group `0`. Each subsequent
/// capture group is indexed by the order of its opening `(`.
///
/// We can make this example a bit clearer by using *named* capture groups:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let re = Regex::new(r&quot;&#39;(?P&lt;title&gt;[^&#39;]+)&#39;\s+\((?P&lt;year&gt;\d{4})\)&quot;)
/// .unwrap();
/// let text = b&quot;Not my favorite movie: &#39;Citizen Kane&#39; (1941).&quot;;
/// let caps = re.captures(text).unwrap();
/// assert_eq!(caps.name(&quot;title&quot;).unwrap().as_bytes(), b&quot;Citizen Kane&quot;);
/// assert_eq!(caps.name(&quot;year&quot;).unwrap().as_bytes(), b&quot;1941&quot;);
/// assert_eq!(caps.get(0).unwrap().as_bytes(), &amp;b&quot;&#39;Citizen Kane&#39; (1941)&quot;[..]);
/// // You can also access the groups by name using the Index notation.
/// // Note that this will panic on an invalid group name.
/// assert_eq!(&amp;caps[&quot;title&quot;], b&quot;Citizen Kane&quot;);
/// assert_eq!(&amp;caps[&quot;year&quot;], b&quot;1941&quot;);
/// assert_eq!(&amp;caps[0], b&quot;&#39;Citizen Kane&#39; (1941)&quot;);
///
/// # }
/// ```
///
/// Here we name the capture groups, which we can access with the `name`
/// method or the `Index` notation with a `&amp;str`. Note that the named
/// capture groups are still accessible with `get` or the `Index` notation
/// with a `usize`.
///
/// The `0`th capture group is always unnamed, so it must always be
/// accessed with `get(0)` or `[0]`.
</span><span class="kw">pub fn </span>captures&lt;<span class="lifetime">&#39;t</span>&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8]) -&gt; <span class="prelude-ty">Option</span>&lt;Captures&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="self">self</span>.captures_at(text, <span class="number">0</span>)
}
<span class="doccomment">/// Returns an iterator over all the non-overlapping capture groups matched
/// in `text`. This is operationally the same as `find_iter`, except it
/// yields information about capturing group matches.
///
/// # Example
///
/// We can use this to find all movie titles and their release years in
/// some text, where the movie is formatted like &quot;&#39;Title&#39; (xxxx)&quot;:
///
/// ```rust
/// # use std::str; use regex::bytes::Regex;
/// # fn main() {
/// let re = Regex::new(r&quot;&#39;(?P&lt;title&gt;[^&#39;]+)&#39;\s+\((?P&lt;year&gt;\d{4})\)&quot;)
/// .unwrap();
/// let text = b&quot;&#39;Citizen Kane&#39; (1941), &#39;The Wizard of Oz&#39; (1939), &#39;M&#39; (1931).&quot;;
/// for caps in re.captures_iter(text) {
/// let title = str::from_utf8(&amp;caps[&quot;title&quot;]).unwrap();
/// let year = str::from_utf8(&amp;caps[&quot;year&quot;]).unwrap();
/// println!(&quot;Movie: {:?}, Released: {:?}&quot;, title, year);
/// }
/// // Output:
/// // Movie: Citizen Kane, Released: 1941
/// // Movie: The Wizard of Oz, Released: 1939
/// // Movie: M, Released: 1931
/// # }
/// ```
</span><span class="kw">pub fn </span>captures_iter&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt;(
<span class="kw-2">&amp;</span><span class="lifetime">&#39;r </span><span class="self">self</span>,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
) -&gt; CaptureMatches&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {
CaptureMatches(<span class="self">self</span>.<span class="number">0</span>.searcher().captures_iter(text))
}
<span class="doccomment">/// Returns an iterator of substrings of `text` delimited by a match of the
/// regular expression. Namely, each element of the iterator corresponds to
/// text that *isn&#39;t* matched by the regular expression.
///
/// This method will *not* copy the text given.
///
/// # Example
///
/// To split a string delimited by arbitrary amounts of spaces or tabs:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let re = Regex::new(r&quot;[ \t]+&quot;).unwrap();
/// let fields: Vec&lt;&amp;[u8]&gt; = re.split(b&quot;a b \t c\td e&quot;).collect();
/// assert_eq!(fields, vec![
/// &amp;b&quot;a&quot;[..], &amp;b&quot;b&quot;[..], &amp;b&quot;c&quot;[..], &amp;b&quot;d&quot;[..], &amp;b&quot;e&quot;[..],
/// ]);
/// # }
/// ```
</span><span class="kw">pub fn </span>split&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;r </span><span class="self">self</span>, text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8]) -&gt; Split&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {
Split { finder: <span class="self">self</span>.find_iter(text), last: <span class="number">0 </span>}
}
<span class="doccomment">/// Returns an iterator of at most `limit` substrings of `text` delimited
/// by a match of the regular expression. (A `limit` of `0` will return no
/// substrings.) Namely, each element of the iterator corresponds to text
/// that *isn&#39;t* matched by the regular expression. The remainder of the
/// string that is not split will be the last element in the iterator.
///
/// This method will *not* copy the text given.
///
/// # Example
///
/// Get the first two words in some text:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let re = Regex::new(r&quot;\W+&quot;).unwrap();
/// let fields: Vec&lt;&amp;[u8]&gt; = re.splitn(b&quot;Hey! How are you?&quot;, 3).collect();
/// assert_eq!(fields, vec![&amp;b&quot;Hey&quot;[..], &amp;b&quot;How&quot;[..], &amp;b&quot;are you?&quot;[..]]);
/// # }
/// ```
</span><span class="kw">pub fn </span>splitn&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt;(
<span class="kw-2">&amp;</span><span class="lifetime">&#39;r </span><span class="self">self</span>,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
limit: usize,
) -&gt; SplitN&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {
SplitN { splits: <span class="self">self</span>.split(text), n: limit }
}
<span class="doccomment">/// Replaces the leftmost-first match with the replacement provided. The
/// replacement can be a regular byte string (where `$N` and `$name` are
/// expanded to match capture groups) or a function that takes the matches&#39;
/// `Captures` and returns the replaced byte string.
///
/// If no match is found, then a copy of the byte string is returned
/// unchanged.
///
/// # Replacement string syntax
///
/// All instances of `$name` in the replacement text is replaced with the
/// corresponding capture group `name`.
///
/// `name` may be an integer corresponding to the index of the
/// capture group (counted by order of opening parenthesis where `0` is the
/// entire match) or it can be a name (consisting of letters, digits or
/// underscores) corresponding to a named capture group.
///
/// If `name` isn&#39;t a valid capture group (whether the name doesn&#39;t exist
/// or isn&#39;t a valid index), then it is replaced with the empty string.
///
/// The longest possible name is used. e.g., `$1a` looks up the capture
/// group named `1a` and not the capture group at index `1`. To exert more
/// precise control over the name, use braces, e.g., `${1}a`.
///
/// To write a literal `$` use `$$`.
///
/// # Examples
///
/// Note that this function is polymorphic with respect to the replacement.
/// In typical usage, this can just be a normal byte string:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let re = Regex::new(&quot;[^01]+&quot;).unwrap();
/// assert_eq!(re.replace(b&quot;1078910&quot;, &amp;b&quot;&quot;[..]), &amp;b&quot;1010&quot;[..]);
/// # }
/// ```
///
/// But anything satisfying the `Replacer` trait will work. For example, a
/// closure of type `|&amp;Captures| -&gt; Vec&lt;u8&gt;` provides direct access to the
/// captures corresponding to a match. This allows one to access capturing
/// group matches easily:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # use regex::bytes::Captures; fn main() {
/// let re = Regex::new(r&quot;([^,\s]+),\s+(\S+)&quot;).unwrap();
/// let result = re.replace(b&quot;Springsteen, Bruce&quot;, |caps: &amp;Captures| {
/// let mut replacement = caps[2].to_owned();
/// replacement.push(b&#39; &#39;);
/// replacement.extend(&amp;caps[1]);
/// replacement
/// });
/// assert_eq!(result, &amp;b&quot;Bruce Springsteen&quot;[..]);
/// # }
/// ```
///
/// But this is a bit cumbersome to use all the time. Instead, a simple
/// syntax is supported that expands `$name` into the corresponding capture
/// group. Here&#39;s the last example, but using this expansion technique
/// with named capture groups:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let re = Regex::new(r&quot;(?P&lt;last&gt;[^,\s]+),\s+(?P&lt;first&gt;\S+)&quot;).unwrap();
/// let result = re.replace(b&quot;Springsteen, Bruce&quot;, &amp;b&quot;$first $last&quot;[..]);
/// assert_eq!(result, &amp;b&quot;Bruce Springsteen&quot;[..]);
/// # }
/// ```
///
/// Note that using `$2` instead of `$first` or `$1` instead of `$last`
/// would produce the same result. To write a literal `$` use `$$`.
///
/// Sometimes the replacement string requires use of curly braces to
/// delineate a capture group replacement and surrounding literal text.
/// For example, if we wanted to join two words together with an
/// underscore:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let re = Regex::new(r&quot;(?P&lt;first&gt;\w+)\s+(?P&lt;second&gt;\w+)&quot;).unwrap();
/// let result = re.replace(b&quot;deep fried&quot;, &amp;b&quot;${first}_$second&quot;[..]);
/// assert_eq!(result, &amp;b&quot;deep_fried&quot;[..]);
/// # }
/// ```
///
/// Without the curly braces, the capture group name `first_` would be
/// used, and since it doesn&#39;t exist, it would be replaced with the empty
/// string.
///
/// Finally, sometimes you just want to replace a literal string with no
/// regard for capturing group expansion. This can be done by wrapping a
/// byte string with `NoExpand`:
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// use regex::bytes::NoExpand;
///
/// let re = Regex::new(r&quot;(?P&lt;last&gt;[^,\s]+),\s+(\S+)&quot;).unwrap();
/// let result = re.replace(b&quot;Springsteen, Bruce&quot;, NoExpand(b&quot;$2 $last&quot;));
/// assert_eq!(result, &amp;b&quot;$2 $last&quot;[..]);
/// # }
/// ```
</span><span class="kw">pub fn </span>replace&lt;<span class="lifetime">&#39;t</span>, R: Replacer&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
rep: R,
) -&gt; Cow&lt;<span class="lifetime">&#39;t</span>, [u8]&gt; {
<span class="self">self</span>.replacen(text, <span class="number">1</span>, rep)
}
<span class="doccomment">/// Replaces all non-overlapping matches in `text` with the replacement
/// provided. This is the same as calling `replacen` with `limit` set to
/// `0`.
///
/// See the documentation for `replace` for details on how to access
/// capturing group matches in the replacement text.
</span><span class="kw">pub fn </span>replace_all&lt;<span class="lifetime">&#39;t</span>, R: Replacer&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
rep: R,
) -&gt; Cow&lt;<span class="lifetime">&#39;t</span>, [u8]&gt; {
<span class="self">self</span>.replacen(text, <span class="number">0</span>, rep)
}
<span class="doccomment">/// Replaces at most `limit` non-overlapping matches in `text` with the
/// replacement provided. If `limit` is 0, then all non-overlapping matches
/// are replaced.
///
/// See the documentation for `replace` for details on how to access
/// capturing group matches in the replacement text.
</span><span class="kw">pub fn </span>replacen&lt;<span class="lifetime">&#39;t</span>, R: Replacer&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
limit: usize,
<span class="kw-2">mut </span>rep: R,
) -&gt; Cow&lt;<span class="lifetime">&#39;t</span>, [u8]&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(rep) = rep.no_expansion() {
<span class="kw">let </span><span class="kw-2">mut </span>it = <span class="self">self</span>.find_iter(text).enumerate().peekable();
<span class="kw">if </span>it.peek().is_none() {
<span class="kw">return </span>Cow::Borrowed(text);
}
<span class="kw">let </span><span class="kw-2">mut </span>new = Vec::with_capacity(text.len());
<span class="kw">let </span><span class="kw-2">mut </span>last_match = <span class="number">0</span>;
<span class="kw">for </span>(i, m) <span class="kw">in </span>it {
new.extend_from_slice(<span class="kw-2">&amp;</span>text[last_match..m.start()]);
new.extend_from_slice(<span class="kw-2">&amp;</span>rep);
last_match = m.end();
<span class="kw">if </span>limit &gt; <span class="number">0 </span>&amp;&amp; i &gt;= limit - <span class="number">1 </span>{
<span class="kw">break</span>;
}
}
new.extend_from_slice(<span class="kw-2">&amp;</span>text[last_match..]);
<span class="kw">return </span>Cow::Owned(new);
}
<span class="comment">// The slower path, which we use if the replacement needs access to
// capture groups.
</span><span class="kw">let </span><span class="kw-2">mut </span>it = <span class="self">self</span>.captures_iter(text).enumerate().peekable();
<span class="kw">if </span>it.peek().is_none() {
<span class="kw">return </span>Cow::Borrowed(text);
}
<span class="kw">let </span><span class="kw-2">mut </span>new = Vec::with_capacity(text.len());
<span class="kw">let </span><span class="kw-2">mut </span>last_match = <span class="number">0</span>;
<span class="kw">for </span>(i, cap) <span class="kw">in </span>it {
<span class="comment">// unwrap on 0 is OK because captures only reports matches
</span><span class="kw">let </span>m = cap.get(<span class="number">0</span>).unwrap();
new.extend_from_slice(<span class="kw-2">&amp;</span>text[last_match..m.start()]);
rep.replace_append(<span class="kw-2">&amp;</span>cap, <span class="kw-2">&amp;mut </span>new);
last_match = m.end();
<span class="kw">if </span>limit &gt; <span class="number">0 </span>&amp;&amp; i &gt;= limit - <span class="number">1 </span>{
<span class="kw">break</span>;
}
}
new.extend_from_slice(<span class="kw-2">&amp;</span>text[last_match..]);
Cow::Owned(new)
}
}
<span class="doccomment">/// Advanced or &quot;lower level&quot; search methods.
</span><span class="kw">impl </span>Regex {
<span class="doccomment">/// Returns the end location of a match in the text given.
///
/// This method may have the same performance characteristics as
/// `is_match`, except it provides an end location for a match. In
/// particular, the location returned *may be shorter* than the proper end
/// of the leftmost-first match that you would find via `Regex::find`.
///
/// Note that it is not guaranteed that this routine finds the shortest or
/// &quot;earliest&quot; possible match. Instead, the main idea of this API is that
/// it returns the offset at the point at which the internal regex engine
/// has determined that a match has occurred. This may vary depending on
/// which internal regex engine is used, and thus, the offset itself may
/// change.
///
/// # Example
///
/// Typically, `a+` would match the entire first sequence of `a` in some
/// text, but `shortest_match` can give up as soon as it sees the first
/// `a`.
///
/// ```rust
/// # use regex::bytes::Regex;
/// # fn main() {
/// let text = b&quot;aaaaa&quot;;
/// let pos = Regex::new(r&quot;a+&quot;).unwrap().shortest_match(text);
/// assert_eq!(pos, Some(1));
/// # }
/// ```
</span><span class="kw">pub fn </span>shortest_match(<span class="kw-2">&amp;</span><span class="self">self</span>, text: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<span class="self">self</span>.shortest_match_at(text, <span class="number">0</span>)
}
<span class="doccomment">/// Returns the same as shortest_match, but starts the search at the given
/// offset.
///
/// The significance of the starting point is that it takes the surrounding
/// context into consideration. For example, the `\A` anchor can only
/// match when `start == 0`.
</span><span class="kw">pub fn </span>shortest_match_at(
<span class="kw-2">&amp;</span><span class="self">self</span>,
text: <span class="kw-2">&amp;</span>[u8],
start: usize,
) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<span class="self">self</span>.<span class="number">0</span>.searcher().shortest_match_at(text, start)
}
<span class="doccomment">/// Returns the same as is_match, but starts the search at the given
/// offset.
///
/// The significance of the starting point is that it takes the surrounding
/// context into consideration. For example, the `\A` anchor can only
/// match when `start == 0`.
</span><span class="kw">pub fn </span>is_match_at(<span class="kw-2">&amp;</span><span class="self">self</span>, text: <span class="kw-2">&amp;</span>[u8], start: usize) -&gt; bool {
<span class="self">self</span>.<span class="number">0</span>.searcher().is_match_at(text, start)
}
<span class="doccomment">/// Returns the same as find, but starts the search at the given
/// offset.
///
/// The significance of the starting point is that it takes the surrounding
/// context into consideration. For example, the `\A` anchor can only
/// match when `start == 0`.
</span><span class="kw">pub fn </span>find_at&lt;<span class="lifetime">&#39;t</span>&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
start: usize,
) -&gt; <span class="prelude-ty">Option</span>&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="self">self</span>.<span class="number">0
</span>.searcher()
.find_at(text, start)
.map(|(s, e)| Match::new(text, s, e))
}
<span class="doccomment">/// Returns the same as [`Regex::captures`], but starts the search at the
/// given offset.
///
/// The significance of the starting point is that it takes the surrounding
/// context into consideration. For example, the `\A` anchor can only
/// match when `start == 0`.
</span><span class="kw">pub fn </span>captures_at&lt;<span class="lifetime">&#39;t</span>&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
start: usize,
) -&gt; <span class="prelude-ty">Option</span>&lt;Captures&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>locs = <span class="self">self</span>.capture_locations();
<span class="self">self</span>.captures_read_at(<span class="kw-2">&amp;mut </span>locs, text, start).map(<span class="kw">move </span>|<span class="kw">_</span>| Captures {
text,
locs: locs.<span class="number">0</span>,
named_groups: <span class="self">self</span>.<span class="number">0</span>.capture_name_idx().clone(),
})
}
<span class="doccomment">/// This is like `captures`, but uses
/// [`CaptureLocations`](struct.CaptureLocations.html)
/// instead of
/// [`Captures`](struct.Captures.html) in order to amortize allocations.
///
/// To create a `CaptureLocations` value, use the
/// `Regex::capture_locations` method.
///
/// This returns the overall match if this was successful, which is always
/// equivalence to the `0`th capture group.
</span><span class="kw">pub fn </span>captures_read&lt;<span class="lifetime">&#39;t</span>&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
locs: <span class="kw-2">&amp;mut </span>CaptureLocations,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
) -&gt; <span class="prelude-ty">Option</span>&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="self">self</span>.captures_read_at(locs, text, <span class="number">0</span>)
}
<span class="doccomment">/// Returns the same as `captures_read`, but starts the search at the given
/// offset and populates the capture locations given.
///
/// The significance of the starting point is that it takes the surrounding
/// context into consideration. For example, the `\A` anchor can only
/// match when `start == 0`.
</span><span class="kw">pub fn </span>captures_read_at&lt;<span class="lifetime">&#39;t</span>&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
locs: <span class="kw-2">&amp;mut </span>CaptureLocations,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
start: usize,
) -&gt; <span class="prelude-ty">Option</span>&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="self">self</span>.<span class="number">0
</span>.searcher()
.captures_read_at(<span class="kw-2">&amp;mut </span>locs.<span class="number">0</span>, text, start)
.map(|(s, e)| Match::new(text, s, e))
}
<span class="doccomment">/// An undocumented alias for `captures_read_at`.
///
/// The `regex-capi` crate previously used this routine, so to avoid
/// breaking that crate, we continue to provide the name as an undocumented
/// alias.
</span><span class="attribute">#[doc(hidden)]
</span><span class="kw">pub fn </span>read_captures_at&lt;<span class="lifetime">&#39;t</span>&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
locs: <span class="kw-2">&amp;mut </span>CaptureLocations,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
start: usize,
) -&gt; <span class="prelude-ty">Option</span>&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="self">self</span>.captures_read_at(locs, text, start)
}
}
<span class="doccomment">/// Auxiliary methods.
</span><span class="kw">impl </span>Regex {
<span class="doccomment">/// Returns the original string of this regex.
</span><span class="kw">pub fn </span>as_str(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>str {
<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>.regex_strings()[<span class="number">0</span>]
}
<span class="doccomment">/// Returns an iterator over the capture names.
</span><span class="kw">pub fn </span>capture_names(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; CaptureNames&lt;<span class="lifetime">&#39;_</span>&gt; {
CaptureNames(<span class="self">self</span>.<span class="number">0</span>.capture_names().iter())
}
<span class="doccomment">/// Returns the number of captures.
</span><span class="kw">pub fn </span>captures_len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.<span class="number">0</span>.capture_names().len()
}
<span class="doccomment">/// Returns the total number of capturing groups that appear in every
/// possible match.
///
/// If the number of capture groups can vary depending on the match, then
/// this returns `None`. That is, a value is only returned when the number
/// of matching groups is invariant or &quot;static.&quot;
///
/// Note that like [`Regex::captures_len`], this **does** include the
/// implicit capturing group corresponding to the entire match. Therefore,
/// when a non-None value is returned, it is guaranteed to be at least `1`.
/// Stated differently, a return value of `Some(0)` is impossible.
///
/// # Example
///
/// This shows a few cases where a static number of capture groups is
/// available and a few cases where it is not.
///
/// ```
/// use regex::bytes::Regex;
///
/// let len = |pattern| {
/// Regex::new(pattern).map(|re| re.static_captures_len())
/// };
///
/// assert_eq!(Some(1), len(&quot;a&quot;)?);
/// assert_eq!(Some(2), len(&quot;(a)&quot;)?);
/// assert_eq!(Some(2), len(&quot;(a)|(b)&quot;)?);
/// assert_eq!(Some(3), len(&quot;(a)(b)|(c)(d)&quot;)?);
/// assert_eq!(None, len(&quot;(a)|b&quot;)?);
/// assert_eq!(None, len(&quot;a|(b)&quot;)?);
/// assert_eq!(None, len(&quot;(b)*&quot;)?);
/// assert_eq!(Some(2), len(&quot;(b)+&quot;)?);
///
/// # Ok::&lt;(), Box&lt;dyn std::error::Error&gt;&gt;(())
/// ```
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>static_captures_len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<span class="self">self</span>.<span class="number">0</span>.static_captures_len().map(|len| len.saturating_add(<span class="number">1</span>))
}
<span class="doccomment">/// Returns an empty set of capture locations that can be reused in
/// multiple calls to `captures_read` or `captures_read_at`.
</span><span class="kw">pub fn </span>capture_locations(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; CaptureLocations {
CaptureLocations(<span class="self">self</span>.<span class="number">0</span>.searcher().locations())
}
<span class="doccomment">/// An alias for `capture_locations` to preserve backward compatibility.
///
/// The `regex-capi` crate uses this method, so to avoid breaking that
/// crate, we continue to export it as an undocumented API.
</span><span class="attribute">#[doc(hidden)]
</span><span class="kw">pub fn </span>locations(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; CaptureLocations {
CaptureLocations(<span class="self">self</span>.<span class="number">0</span>.searcher().locations())
}
}
<span class="doccomment">/// An iterator over all non-overlapping matches for a particular string.
///
/// The iterator yields a tuple of integers corresponding to the start and end
/// of the match. The indices are byte offsets. The iterator stops when no more
/// matches can be found.
///
/// `&#39;r` is the lifetime of the compiled regular expression and `&#39;t` is the
/// lifetime of the matched byte string.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Matches&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt;(re_trait::Matches&lt;<span class="lifetime">&#39;t</span>, ExecNoSync&lt;<span class="lifetime">&#39;r</span>&gt;&gt;);
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; Iterator <span class="kw">for </span>Matches&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {
<span class="kw">type </span>Item = Match&lt;<span class="lifetime">&#39;t</span>&gt;;
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="kw">let </span>text = <span class="self">self</span>.<span class="number">0</span>.text();
<span class="self">self</span>.<span class="number">0</span>.next().map(|(s, e)| Match::new(text, s, e))
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; FusedIterator <span class="kw">for </span>Matches&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {}
<span class="doccomment">/// An iterator that yields all non-overlapping capture groups matching a
/// particular regular expression.
///
/// The iterator stops when no more matches can be found.
///
/// `&#39;r` is the lifetime of the compiled regular expression and `&#39;t` is the
/// lifetime of the matched byte string.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>CaptureMatches&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt;(
re_trait::CaptureMatches&lt;<span class="lifetime">&#39;t</span>, ExecNoSync&lt;<span class="lifetime">&#39;r</span>&gt;&gt;,
);
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; Iterator <span class="kw">for </span>CaptureMatches&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {
<span class="kw">type </span>Item = Captures&lt;<span class="lifetime">&#39;t</span>&gt;;
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Captures&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="self">self</span>.<span class="number">0</span>.next().map(|locs| Captures {
text: <span class="self">self</span>.<span class="number">0</span>.text(),
locs,
named_groups: <span class="self">self</span>.<span class="number">0</span>.regex().capture_name_idx().clone(),
})
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; FusedIterator <span class="kw">for </span>CaptureMatches&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {}
<span class="doccomment">/// Yields all substrings delimited by a regular expression match.
///
/// `&#39;r` is the lifetime of the compiled regular expression and `&#39;t` is the
/// lifetime of the byte string being split.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Split&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {
finder: Matches&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt;,
last: usize,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; Iterator <span class="kw">for </span>Split&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {
<span class="kw">type </span>Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8];
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8]&gt; {
<span class="kw">let </span>text = <span class="self">self</span>.finder.<span class="number">0</span>.text();
<span class="kw">match </span><span class="self">self</span>.finder.next() {
<span class="prelude-val">None </span>=&gt; {
<span class="kw">if </span><span class="self">self</span>.last &gt; text.len() {
<span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="kw">let </span>s = <span class="kw-2">&amp;</span>text[<span class="self">self</span>.last..];
<span class="self">self</span>.last = text.len() + <span class="number">1</span>; <span class="comment">// Next call will return None
</span><span class="prelude-val">Some</span>(s)
}
}
<span class="prelude-val">Some</span>(m) =&gt; {
<span class="kw">let </span>matched = <span class="kw-2">&amp;</span>text[<span class="self">self</span>.last..m.start()];
<span class="self">self</span>.last = m.end();
<span class="prelude-val">Some</span>(matched)
}
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; FusedIterator <span class="kw">for </span>Split&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {}
<span class="doccomment">/// Yields at most `N` substrings delimited by a regular expression match.
///
/// The last substring will be whatever remains after splitting.
///
/// `&#39;r` is the lifetime of the compiled regular expression and `&#39;t` is the
/// lifetime of the byte string being split.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>SplitN&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {
splits: Split&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt;,
n: usize,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; Iterator <span class="kw">for </span>SplitN&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {
<span class="kw">type </span>Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8];
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8]&gt; {
<span class="kw">if </span><span class="self">self</span>.n == <span class="number">0 </span>{
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="self">self</span>.n -= <span class="number">1</span>;
<span class="kw">if </span><span class="self">self</span>.n &gt; <span class="number">0 </span>{
<span class="kw">return </span><span class="self">self</span>.splits.next();
}
<span class="kw">let </span>text = <span class="self">self</span>.splits.finder.<span class="number">0</span>.text();
<span class="kw">if </span><span class="self">self</span>.splits.last &gt; text.len() {
<span class="comment">// We&#39;ve already returned all substrings.
</span><span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="comment">// self.n == 0, so future calls will return None immediately
</span><span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>text[<span class="self">self</span>.splits.last..])
}
}
<span class="kw">fn </span>size_hint(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (usize, <span class="prelude-ty">Option</span>&lt;usize&gt;) {
(<span class="number">0</span>, <span class="prelude-val">Some</span>(<span class="self">self</span>.n))
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; FusedIterator <span class="kw">for </span>SplitN&lt;<span class="lifetime">&#39;r</span>, <span class="lifetime">&#39;t</span>&gt; {}
<span class="doccomment">/// An iterator over the names of all possible captures.
///
/// `None` indicates an unnamed capture; the first element (capture 0, the
/// whole matched region) is always unnamed.
///
/// `&#39;r` is the lifetime of the compiled regular expression.
</span><span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>CaptureNames&lt;<span class="lifetime">&#39;r</span>&gt;(::std::slice::Iter&lt;<span class="lifetime">&#39;r</span>, <span class="prelude-ty">Option</span>&lt;String&gt;&gt;);
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>&gt; Iterator <span class="kw">for </span>CaptureNames&lt;<span class="lifetime">&#39;r</span>&gt; {
<span class="kw">type </span>Item = <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;r </span>str&gt;;
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;r </span>str&gt;&gt; {
<span class="self">self</span>.<span class="number">0
</span>.next()
.as_ref()
.map(|slot| slot.as_ref().map(|name| name.as_ref()))
}
<span class="kw">fn </span>size_hint(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (usize, <span class="prelude-ty">Option</span>&lt;usize&gt;) {
<span class="self">self</span>.<span class="number">0</span>.size_hint()
}
<span class="kw">fn </span>count(<span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.<span class="number">0</span>.count()
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>&gt; ExactSizeIterator <span class="kw">for </span>CaptureNames&lt;<span class="lifetime">&#39;r</span>&gt; {}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;r</span>&gt; FusedIterator <span class="kw">for </span>CaptureNames&lt;<span class="lifetime">&#39;r</span>&gt; {}
<span class="doccomment">/// CaptureLocations is a low level representation of the raw offsets of each
/// submatch.
///
/// You can think of this as a lower level
/// [`Captures`](struct.Captures.html), where this type does not support
/// named capturing groups directly and it does not borrow the text that these
/// offsets were matched on.
///
/// Primarily, this type is useful when using the lower level `Regex` APIs
/// such as `read_captures`, which permits amortizing the allocation in which
/// capture match locations are stored.
///
/// In order to build a value of this type, you&#39;ll need to call the
/// `capture_locations` method on the `Regex` being used to execute the search.
/// The value returned can then be reused in subsequent searches.
///
/// # Example
///
/// This example shows how to create and use `CaptureLocations` in a search.
///
/// ```
/// use regex::bytes::Regex;
///
/// let re = Regex::new(r&quot;(?&lt;first&gt;\w+)\s+(?&lt;last&gt;\w+)&quot;).unwrap();
/// let mut locs = re.capture_locations();
/// let m = re.captures_read(&amp;mut locs, b&quot;Bruce Springsteen&quot;).unwrap();
/// assert_eq!(0..17, m.range());
/// assert_eq!(Some((0, 17)), locs.get(0));
/// assert_eq!(Some((0, 5)), locs.get(1));
/// assert_eq!(Some((6, 17)), locs.get(2));
///
/// // Asking for an invalid capture group always returns None.
/// assert_eq!(None, locs.get(3));
/// assert_eq!(None, locs.get(34973498648));
/// assert_eq!(None, locs.get(9944060567225171988));
/// ```
</span><span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>CaptureLocations(re_trait::Locations);
<span class="doccomment">/// A type alias for `CaptureLocations` for backwards compatibility.
///
/// Previously, we exported `CaptureLocations` as `Locations` in an
/// undocumented API. To prevent breaking that code (e.g., in `regex-capi`),
/// we continue re-exporting the same undocumented API.
</span><span class="attribute">#[doc(hidden)]
</span><span class="kw">pub type </span>Locations = CaptureLocations;
<span class="kw">impl </span>CaptureLocations {
<span class="doccomment">/// Returns the start and end positions of the Nth capture group. Returns
/// `None` if `i` is not a valid capture group or if the capture group did
/// not match anything. The positions returned are *always* byte indices
/// with respect to the original string matched.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>get(<span class="kw-2">&amp;</span><span class="self">self</span>, i: usize) -&gt; <span class="prelude-ty">Option</span>&lt;(usize, usize)&gt; {
<span class="self">self</span>.<span class="number">0</span>.pos(i)
}
<span class="doccomment">/// Returns the total number of capture groups (even if they didn&#39;t match).
///
/// This is always at least `1` since every regex has at least `1`
/// capturing group that corresponds to the entire match.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.<span class="number">0</span>.len()
}
<span class="doccomment">/// An alias for the `get` method for backwards compatibility.
///
/// Previously, we exported `get` as `pos` in an undocumented API. To
/// prevent breaking that code (e.g., in `regex-capi`), we continue
/// re-exporting the same undocumented API.
</span><span class="attribute">#[doc(hidden)]
#[inline]
</span><span class="kw">pub fn </span>pos(<span class="kw-2">&amp;</span><span class="self">self</span>, i: usize) -&gt; <span class="prelude-ty">Option</span>&lt;(usize, usize)&gt; {
<span class="self">self</span>.get(i)
}
}
<span class="doccomment">/// Captures represents a group of captured byte strings for a single match.
///
/// The 0th capture always corresponds to the entire match. Each subsequent
/// index corresponds to the next capture group in the regex. If a capture
/// group is named, then the matched byte string is *also* available via the
/// `name` method. (Note that the 0th capture is always unnamed and so must be
/// accessed with the `get` method.)
///
/// Positions returned from a capture group are always byte indices.
///
/// `&#39;t` is the lifetime of the matched text.
</span><span class="kw">pub struct </span>Captures&lt;<span class="lifetime">&#39;t</span>&gt; {
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8],
locs: re_trait::Locations,
named_groups: Arc&lt;HashMap&lt;String, usize&gt;&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;t</span>&gt; Captures&lt;<span class="lifetime">&#39;t</span>&gt; {
<span class="doccomment">/// Returns the match associated with the capture group at index `i`. If
/// `i` does not correspond to a capture group, or if the capture group
/// did not participate in the match, then `None` is returned.
///
/// # Examples
///
/// Get the text of the match with a default of an empty string if this
/// group didn&#39;t participate in the match:
///
/// ```rust
/// # use regex::bytes::Regex;
/// let re = Regex::new(r&quot;[a-z]+(?:([0-9]+)|([A-Z]+))&quot;).unwrap();
/// let caps = re.captures(b&quot;abc123&quot;).unwrap();
///
/// let text1 = caps.get(1).map_or(&amp;b&quot;&quot;[..], |m| m.as_bytes());
/// let text2 = caps.get(2).map_or(&amp;b&quot;&quot;[..], |m| m.as_bytes());
/// assert_eq!(text1, &amp;b&quot;123&quot;[..]);
/// assert_eq!(text2, &amp;b&quot;&quot;[..]);
/// ```
</span><span class="kw">pub fn </span>get(<span class="kw-2">&amp;</span><span class="self">self</span>, i: usize) -&gt; <span class="prelude-ty">Option</span>&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="self">self</span>.locs.pos(i).map(|(s, e)| Match::new(<span class="self">self</span>.text, s, e))
}
<span class="doccomment">/// Returns the match for the capture group named `name`. If `name` isn&#39;t a
/// valid capture group or didn&#39;t match anything, then `None` is returned.
</span><span class="kw">pub fn </span>name(<span class="kw-2">&amp;</span><span class="self">self</span>, name: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt; {
<span class="self">self</span>.named_groups.get(name).and_then(|<span class="kw-2">&amp;</span>i| <span class="self">self</span>.get(i))
}
<span class="doccomment">/// An iterator that yields all capturing matches in the order in which
/// they appear in the regex. If a particular capture group didn&#39;t
/// participate in the match, then `None` is yielded for that capture.
///
/// The first match always corresponds to the overall match of the regex.
</span><span class="kw">pub fn </span>iter&lt;<span class="lifetime">&#39;c</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;c </span><span class="self">self</span>) -&gt; SubCaptureMatches&lt;<span class="lifetime">&#39;c</span>, <span class="lifetime">&#39;t</span>&gt; {
SubCaptureMatches { caps: <span class="self">self</span>, it: <span class="self">self</span>.locs.iter() }
}
<span class="doccomment">/// Expands all instances of `$name` in `replacement` to the corresponding
/// capture group `name`, and writes them to the `dst` buffer given.
///
/// `name` may be an integer corresponding to the index of the capture
/// group (counted by order of opening parenthesis where `0` is the
/// entire match) or it can be a name (consisting of letters, digits or
/// underscores) corresponding to a named capture group.
///
/// If `name` isn&#39;t a valid capture group (whether the name doesn&#39;t exist
/// or isn&#39;t a valid index), then it is replaced with the empty string.
///
/// The longest possible name consisting of the characters `[_0-9A-Za-z]`
/// is used. e.g., `$1a` looks up the capture group named `1a` and not the
/// capture group at index `1`. To exert more precise control over the
/// name, or to refer to a capture group name that uses characters outside
/// of `[_0-9A-Za-z]`, use braces, e.g., `${1}a` or `${foo[bar].baz}`. When
/// using braces, any sequence of valid UTF-8 bytes is permitted. If the
/// sequence does not refer to a capture group name in the corresponding
/// regex, then it is replaced with an empty string.
///
/// To write a literal `$` use `$$`.
</span><span class="kw">pub fn </span>expand(<span class="kw-2">&amp;</span><span class="self">self</span>, replacement: <span class="kw-2">&amp;</span>[u8], dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
expand_bytes(<span class="self">self</span>, replacement, dst)
}
<span class="doccomment">/// Returns the total number of capture groups (even if they didn&#39;t match).
///
/// This is always at least `1`, since every regex has at least one capture
/// group that corresponds to the full match.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.locs.len()
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;t</span>&gt; fmt::Debug <span class="kw">for </span>Captures&lt;<span class="lifetime">&#39;t</span>&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
f.debug_tuple(<span class="string">&quot;Captures&quot;</span>).field(<span class="kw-2">&amp;</span>CapturesDebug(<span class="self">self</span>)).finish()
}
}
<span class="kw">struct </span>CapturesDebug&lt;<span class="lifetime">&#39;c</span>, <span class="lifetime">&#39;t</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;c </span>Captures&lt;<span class="lifetime">&#39;t</span>&gt;);
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;c</span>, <span class="lifetime">&#39;t</span>&gt; fmt::Debug <span class="kw">for </span>CapturesDebug&lt;<span class="lifetime">&#39;c</span>, <span class="lifetime">&#39;t</span>&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
<span class="kw">fn </span>escape_bytes(bytes: <span class="kw-2">&amp;</span>[u8]) -&gt; String {
<span class="kw">let </span><span class="kw-2">mut </span>s = String::new();
<span class="kw">for </span><span class="kw-2">&amp;</span>b <span class="kw">in </span>bytes {
s.push_str(<span class="kw-2">&amp;</span>escape_byte(b));
}
s
}
<span class="kw">fn </span>escape_byte(byte: u8) -&gt; String {
<span class="kw">use </span>std::ascii::escape_default;
<span class="kw">let </span>escaped: Vec&lt;u8&gt; = escape_default(byte).collect();
String::from_utf8_lossy(<span class="kw-2">&amp;</span>escaped).into_owned()
}
<span class="comment">// We&#39;d like to show something nice here, even if it means an
// allocation to build a reverse index.
</span><span class="kw">let </span>slot_to_name: HashMap&lt;<span class="kw-2">&amp;</span>usize, <span class="kw-2">&amp;</span>String&gt; =
<span class="self">self</span>.<span class="number">0</span>.named_groups.iter().map(|(a, b)| (b, a)).collect();
<span class="kw">let </span><span class="kw-2">mut </span>map = f.debug_map();
<span class="kw">for </span>(slot, m) <span class="kw">in </span><span class="self">self</span>.<span class="number">0</span>.locs.iter().enumerate() {
<span class="kw">let </span>m = m.map(|(s, e)| escape_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>.text[s..e]));
<span class="kw">if let </span><span class="prelude-val">Some</span>(name) = slot_to_name.get(<span class="kw-2">&amp;</span>slot) {
map.entry(<span class="kw-2">&amp;</span>name, <span class="kw-2">&amp;</span>m);
} <span class="kw">else </span>{
map.entry(<span class="kw-2">&amp;</span>slot, <span class="kw-2">&amp;</span>m);
}
}
map.finish()
}
}
<span class="doccomment">/// Get a group by index.
///
/// `&#39;t` is the lifetime of the matched text.
///
/// The text can&#39;t outlive the `Captures` object if this method is
/// used, because of how `Index` is defined (normally `a[i]` is part
/// of `a` and can&#39;t outlive it); to do that, use `get()` instead.
///
/// # Panics
///
/// If there is no group at the given index.
</span><span class="kw">impl</span>&lt;<span class="lifetime">&#39;t</span>&gt; Index&lt;usize&gt; <span class="kw">for </span>Captures&lt;<span class="lifetime">&#39;t</span>&gt; {
<span class="kw">type </span>Output = [u8];
<span class="kw">fn </span>index(<span class="kw-2">&amp;</span><span class="self">self</span>, i: usize) -&gt; <span class="kw-2">&amp;</span>[u8] {
<span class="self">self</span>.get(i)
.map(|m| m.as_bytes())
.unwrap_or_else(|| <span class="macro">panic!</span>(<span class="string">&quot;no group at index &#39;{}&#39;&quot;</span>, i))
}
}
<span class="doccomment">/// Get a group by name.
///
/// `&#39;t` is the lifetime of the matched text and `&#39;i` is the lifetime
/// of the group name (the index).
///
/// The text can&#39;t outlive the `Captures` object if this method is
/// used, because of how `Index` is defined (normally `a[i]` is part
/// of `a` and can&#39;t outlive it); to do that, use `name` instead.
///
/// # Panics
///
/// If there is no group named by the given value.
</span><span class="kw">impl</span>&lt;<span class="lifetime">&#39;t</span>, <span class="lifetime">&#39;i</span>&gt; Index&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;i </span>str&gt; <span class="kw">for </span>Captures&lt;<span class="lifetime">&#39;t</span>&gt; {
<span class="kw">type </span>Output = [u8];
<span class="kw">fn </span>index&lt;<span class="lifetime">&#39;a</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="self">self</span>, name: <span class="kw-2">&amp;</span><span class="lifetime">&#39;i </span>str) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[u8] {
<span class="self">self</span>.name(name)
.map(|m| m.as_bytes())
.unwrap_or_else(|| <span class="macro">panic!</span>(<span class="string">&quot;no group named &#39;{}&#39;&quot;</span>, name))
}
}
<span class="doccomment">/// An iterator that yields all capturing matches in the order in which they
/// appear in the regex.
///
/// If a particular capture group didn&#39;t participate in the match, then `None`
/// is yielded for that capture. The first match always corresponds to the
/// overall match of the regex.
///
/// The lifetime `&#39;c` corresponds to the lifetime of the `Captures` value, and
/// the lifetime `&#39;t` corresponds to the originally matched text.
</span><span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>SubCaptureMatches&lt;<span class="lifetime">&#39;c</span>, <span class="lifetime">&#39;t</span>&gt; {
caps: <span class="kw-2">&amp;</span><span class="lifetime">&#39;c </span>Captures&lt;<span class="lifetime">&#39;t</span>&gt;,
it: SubCapturesPosIter&lt;<span class="lifetime">&#39;c</span>&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;c</span>, <span class="lifetime">&#39;t</span>&gt; Iterator <span class="kw">for </span>SubCaptureMatches&lt;<span class="lifetime">&#39;c</span>, <span class="lifetime">&#39;t</span>&gt; {
<span class="kw">type </span>Item = <span class="prelude-ty">Option</span>&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt;;
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="prelude-ty">Option</span>&lt;Match&lt;<span class="lifetime">&#39;t</span>&gt;&gt;&gt; {
<span class="self">self</span>.it
.next()
.map(|cap| cap.map(|(s, e)| Match::new(<span class="self">self</span>.caps.text, s, e)))
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;c</span>, <span class="lifetime">&#39;t</span>&gt; FusedIterator <span class="kw">for </span>SubCaptureMatches&lt;<span class="lifetime">&#39;c</span>, <span class="lifetime">&#39;t</span>&gt; {}
<span class="doccomment">/// Replacer describes types that can be used to replace matches in a byte
/// string.
///
/// In general, users of this crate shouldn&#39;t need to implement this trait,
/// since implementations are already provided for `&amp;[u8]` along with other
/// variants of bytes types and `FnMut(&amp;Captures) -&gt; Vec&lt;u8&gt;` (or any
/// `FnMut(&amp;Captures) -&gt; T` where `T: AsRef&lt;[u8]&gt;`), which covers most use cases.
</span><span class="kw">pub trait </span>Replacer {
<span class="doccomment">/// Appends text to `dst` to replace the current match.
///
/// The current match is represented by `caps`, which is guaranteed to
/// have a match at capture group `0`.
///
/// For example, a no-op replacement would be
/// `dst.extend(&amp;caps[0])`.
</span><span class="kw">fn </span>replace_append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, caps: <span class="kw-2">&amp;</span>Captures&lt;<span class="lifetime">&#39;_</span>&gt;, dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;);
<span class="doccomment">/// Return a fixed unchanging replacement byte string.
///
/// When doing replacements, if access to `Captures` is not needed (e.g.,
/// the replacement byte string does not need `$` expansion), then it can
/// be beneficial to avoid finding sub-captures.
///
/// In general, this is called once for every call to `replacen`.
</span><span class="kw">fn </span>no_expansion&lt;<span class="lifetime">&#39;r</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;r </span><span class="kw-2">mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Cow&lt;<span class="lifetime">&#39;r</span>, [u8]&gt;&gt; {
<span class="prelude-val">None
</span>}
<span class="doccomment">/// Return a `Replacer` that borrows and wraps this `Replacer`.
///
/// This is useful when you want to take a generic `Replacer` (which might
/// not be cloneable) and use it without consuming it, so it can be used
/// more than once.
///
/// # Example
///
/// ```
/// use regex::bytes::{Regex, Replacer};
///
/// fn replace_all_twice&lt;R: Replacer&gt;(
/// re: Regex,
/// src: &amp;[u8],
/// mut rep: R,
/// ) -&gt; Vec&lt;u8&gt; {
/// let dst = re.replace_all(src, rep.by_ref());
/// let dst = re.replace_all(&amp;dst, rep.by_ref());
/// dst.into_owned()
/// }
/// ```
</span><span class="kw">fn </span>by_ref&lt;<span class="lifetime">&#39;r</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;r </span><span class="kw-2">mut </span><span class="self">self</span>) -&gt; ReplacerRef&lt;<span class="lifetime">&#39;r</span>, <span class="self">Self</span>&gt; {
ReplacerRef(<span class="self">self</span>)
}
}
<span class="doccomment">/// By-reference adaptor for a `Replacer`
///
/// Returned by [`Replacer::by_ref`](trait.Replacer.html#method.by_ref).
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>ReplacerRef&lt;<span class="lifetime">&#39;a</span>, R: <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>R);
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, R: Replacer + <span class="question-mark">?</span>Sized + <span class="lifetime">&#39;a</span>&gt; Replacer <span class="kw">for </span>ReplacerRef&lt;<span class="lifetime">&#39;a</span>, R&gt; {
<span class="kw">fn </span>replace_append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, caps: <span class="kw-2">&amp;</span>Captures&lt;<span class="lifetime">&#39;_</span>&gt;, dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
<span class="self">self</span>.<span class="number">0</span>.replace_append(caps, dst)
}
<span class="kw">fn </span>no_expansion&lt;<span class="lifetime">&#39;r</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;r </span><span class="kw-2">mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Cow&lt;<span class="lifetime">&#39;r</span>, [u8]&gt;&gt; {
<span class="self">self</span>.<span class="number">0</span>.no_expansion()
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Replacer <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[u8] {
<span class="kw">fn </span>replace_append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, caps: <span class="kw-2">&amp;</span>Captures&lt;<span class="lifetime">&#39;_</span>&gt;, dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
caps.expand(<span class="kw-2">*</span><span class="self">self</span>, dst);
}
<span class="kw">fn </span>no_expansion(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Cow&lt;<span class="lifetime">&#39;_</span>, [u8]&gt;&gt; {
no_expansion(<span class="self">self</span>)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Replacer <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Vec&lt;u8&gt; {
<span class="kw">fn </span>replace_append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, caps: <span class="kw-2">&amp;</span>Captures&lt;<span class="lifetime">&#39;_</span>&gt;, dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
caps.expand(<span class="kw-2">*</span><span class="self">self</span>, dst);
}
<span class="kw">fn </span>no_expansion(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Cow&lt;<span class="lifetime">&#39;_</span>, [u8]&gt;&gt; {
no_expansion(<span class="self">self</span>)
}
}
<span class="kw">impl </span>Replacer <span class="kw">for </span>Vec&lt;u8&gt; {
<span class="kw">fn </span>replace_append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, caps: <span class="kw-2">&amp;</span>Captures&lt;<span class="lifetime">&#39;_</span>&gt;, dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
caps.expand(<span class="self">self</span>, dst);
}
<span class="kw">fn </span>no_expansion(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Cow&lt;<span class="lifetime">&#39;_</span>, [u8]&gt;&gt; {
no_expansion(<span class="self">self</span>)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Replacer <span class="kw">for </span>Cow&lt;<span class="lifetime">&#39;a</span>, [u8]&gt; {
<span class="kw">fn </span>replace_append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, caps: <span class="kw-2">&amp;</span>Captures&lt;<span class="lifetime">&#39;_</span>&gt;, dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
caps.expand(<span class="self">self</span>.as_ref(), dst);
}
<span class="kw">fn </span>no_expansion(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Cow&lt;<span class="lifetime">&#39;_</span>, [u8]&gt;&gt; {
no_expansion(<span class="self">self</span>)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Replacer <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Cow&lt;<span class="lifetime">&#39;a</span>, [u8]&gt; {
<span class="kw">fn </span>replace_append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, caps: <span class="kw-2">&amp;</span>Captures&lt;<span class="lifetime">&#39;_</span>&gt;, dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
caps.expand(<span class="self">self</span>.as_ref(), dst);
}
<span class="kw">fn </span>no_expansion(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Cow&lt;<span class="lifetime">&#39;_</span>, [u8]&gt;&gt; {
no_expansion(<span class="self">self</span>)
}
}
<span class="kw">fn </span>no_expansion&lt;T: AsRef&lt;[u8]&gt;&gt;(t: <span class="kw-2">&amp;</span>T) -&gt; <span class="prelude-ty">Option</span>&lt;Cow&lt;<span class="lifetime">&#39;_</span>, [u8]&gt;&gt; {
<span class="kw">let </span>s = t.as_ref();
<span class="kw">match </span>find_byte(<span class="string">b&#39;$&#39;</span>, s) {
<span class="prelude-val">Some</span>(<span class="kw">_</span>) =&gt; <span class="prelude-val">None</span>,
<span class="prelude-val">None </span>=&gt; <span class="prelude-val">Some</span>(Cow::Borrowed(s)),
}
}
<span class="kw">impl</span>&lt;F, T&gt; Replacer <span class="kw">for </span>F
<span class="kw">where
</span>F: FnMut(<span class="kw-2">&amp;</span>Captures&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; T,
T: AsRef&lt;[u8]&gt;,
{
<span class="kw">fn </span>replace_append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, caps: <span class="kw-2">&amp;</span>Captures&lt;<span class="lifetime">&#39;_</span>&gt;, dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
dst.extend_from_slice((<span class="kw-2">*</span><span class="self">self</span>)(caps).as_ref());
}
}
<span class="doccomment">/// `NoExpand` indicates literal byte string replacement.
///
/// It can be used with `replace` and `replace_all` to do a literal byte string
/// replacement without expanding `$name` to their corresponding capture
/// groups. This can be both convenient (to avoid escaping `$`, for example)
/// and performant (since capture groups don&#39;t need to be found).
///
/// `&#39;t` is the lifetime of the literal text.
</span><span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>NoExpand&lt;<span class="lifetime">&#39;t</span>&gt;(<span class="kw">pub </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span>[u8]);
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;t</span>&gt; Replacer <span class="kw">for </span>NoExpand&lt;<span class="lifetime">&#39;t</span>&gt; {
<span class="kw">fn </span>replace_append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&amp;</span>Captures&lt;<span class="lifetime">&#39;_</span>&gt;, dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
dst.extend_from_slice(<span class="self">self</span>.<span class="number">0</span>);
}
<span class="kw">fn </span>no_expansion(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Cow&lt;<span class="lifetime">&#39;_</span>, [u8]&gt;&gt; {
<span class="prelude-val">Some</span>(Cow::Borrowed(<span class="self">self</span>.<span class="number">0</span>))
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="regex" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>