| <!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/aho-corasick-1.0.2/src/util/search.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>search.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="../../../aho_corasick/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="../../../aho_corasick/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>core::ops::{Range, RangeBounds}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::util::primitives::PatternID; |
| |
| <span class="doccomment">/// The configuration and the haystack to use for an Aho-Corasick search. |
| /// |
| /// When executing a search, there are a few parameters one might want to |
| /// configure: |
| /// |
| /// * The haystack to search, provided to the [`Input::new`] constructor. This |
| /// is the only required parameter. |
| /// * The span _within_ the haystack to limit a search to. (The default |
| /// is the entire haystack.) This is configured via [`Input::span`] or |
| /// [`Input::range`]. |
| /// * Whether to run an unanchored (matches can occur anywhere after the |
| /// start of the search) or anchored (matches can only occur beginning at |
| /// the start of the search) search. Unanchored search is the default. This is |
| /// configured via [`Input::anchored`]. |
| /// * Whether to quit the search as soon as a match has been found, regardless |
| /// of the [`MatchKind`] that the searcher was built with. This is configured |
| /// via [`Input::earliest`]. |
| /// |
| /// For most cases, the defaults for all optional parameters are appropriate. |
| /// The utility of this type is that it keeps the default or common case simple |
| /// while permitting tweaking parameters in more niche use cases while reusing |
| /// the same search APIs. |
| /// |
| /// # Valid bounds and search termination |
| /// |
| /// An `Input` permits setting the bounds of a search via either |
| /// [`Input::span`] or [`Input::range`]. The bounds set must be valid, or |
| /// else a panic will occur. Bounds are valid if and only if: |
| /// |
| /// * The bounds represent a valid range into the input's haystack. |
| /// * **or** the end bound is a valid ending bound for the haystack *and* |
| /// the start bound is exactly one greater than the end bound. |
| /// |
| /// In the latter case, [`Input::is_done`] will return true and indicates any |
| /// search receiving such an input should immediately return with no match. |
| /// |
| /// Other than representing "search is complete," the `Input::span` and |
| /// `Input::range` APIs are never necessary. Instead, callers can slice the |
| /// haystack instead, e.g., with `&haystack[start..end]`. With that said, they |
| /// can be more convenient than slicing because the match positions reported |
| /// when using `Input::span` or `Input::range` are in terms of the original |
| /// haystack. If you instead use `&haystack[start..end]`, then you'll need to |
| /// add `start` to any match position returned in order for it to be a correct |
| /// index into `haystack`. |
| /// |
| /// # Example: `&str` and `&[u8]` automatically convert to an `Input` |
| /// |
| /// There is a `From<&T> for Input` implementation for all `T: AsRef<[u8]>`. |
| /// Additionally, the [`AhoCorasick`](crate::AhoCorasick) search APIs accept |
| /// a `Into<Input>`. These two things combined together mean you can provide |
| /// things like `&str` and `&[u8]` to search APIs when the defaults are |
| /// suitable, but also an `Input` when they're not. For example: |
| /// |
| /// ``` |
| /// use aho_corasick::{AhoCorasick, Anchored, Input, Match, StartKind}; |
| /// |
| /// // Build a searcher that supports both unanchored and anchored modes. |
| /// let ac = AhoCorasick::builder() |
| /// .start_kind(StartKind::Both) |
| /// .build(&["abcd", "b"]) |
| /// .unwrap(); |
| /// let haystack = "abcd"; |
| /// |
| /// // A search using default parameters is unanchored. With standard |
| /// // semantics, this finds `b` first. |
| /// assert_eq!( |
| /// Some(Match::must(1, 1..2)), |
| /// ac.find(haystack), |
| /// ); |
| /// // Using the same 'find' routine, we can provide an 'Input' explicitly |
| /// // that is configured to do an anchored search. Since 'b' doesn't start |
| /// // at the beginning of the search, it is not reported as a match. |
| /// assert_eq!( |
| /// Some(Match::must(0, 0..4)), |
| /// ac.find(Input::new(haystack).anchored(Anchored::Yes)), |
| /// ); |
| /// ``` |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>Input<<span class="lifetime">'h</span>> { |
| haystack: <span class="kw-2">&</span><span class="lifetime">'h </span>[u8], |
| span: Span, |
| anchored: Anchored, |
| earliest: bool, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'h</span>> Input<<span class="lifetime">'h</span>> { |
| <span class="doccomment">/// Create a new search configuration for the given haystack. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>new<H: <span class="question-mark">?</span>Sized + AsRef<[u8]>>(haystack: <span class="kw-2">&</span><span class="lifetime">'h </span>H) -> Input<<span class="lifetime">'h</span>> { |
| Input { |
| haystack: haystack.as_ref(), |
| span: Span { start: <span class="number">0</span>, end: haystack.as_ref().len() }, |
| anchored: Anchored::No, |
| earliest: <span class="bool-val">false</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Set the span for this search. |
| /// |
| /// This routine is generic over how a span is provided. While |
| /// a [`Span`] may be given directly, one may also provide a |
| /// `std::ops::Range<usize>`. To provide anything supported by range |
| /// syntax, use the [`Input::range`] method. |
| /// |
| /// The default span is the entire haystack. |
| /// |
| /// Note that [`Input::range`] overrides this method and vice versa. |
| /// |
| /// # Panics |
| /// |
| /// This panics if the given span does not correspond to valid bounds in |
| /// the haystack or the termination of a search. |
| /// |
| /// # Example |
| /// |
| /// This example shows how the span of the search can impact whether a |
| /// match is reported or not. |
| /// |
| /// ``` |
| /// use aho_corasick::{AhoCorasick, Input, MatchKind}; |
| /// |
| /// let patterns = &["b", "abcd", "abc"]; |
| /// let haystack = "abcd"; |
| /// |
| /// let ac = AhoCorasick::builder() |
| /// .match_kind(MatchKind::LeftmostFirst) |
| /// .build(patterns) |
| /// .unwrap(); |
| /// let input = Input::new(haystack).span(0..3); |
| /// let mat = ac.try_find(input)?.expect("should have a match"); |
| /// // Without the span stopping the search early, 'abcd' would be reported |
| /// // because it is the correct leftmost-first match. |
| /// assert_eq!("abc", &haystack[mat.span()]); |
| /// |
| /// # Ok::<(), Box<dyn std::error::Error>>(()) |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>span<S: Into<Span>>(<span class="kw-2">mut </span><span class="self">self</span>, span: S) -> Input<<span class="lifetime">'h</span>> { |
| <span class="self">self</span>.set_span(span); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Like `Input::span`, but accepts any range instead. |
| /// |
| /// The default range is the entire haystack. |
| /// |
| /// Note that [`Input::span`] overrides this method and vice versa. |
| /// |
| /// # Panics |
| /// |
| /// This routine will panic if the given range could not be converted |
| /// to a valid [`Range`]. For example, this would panic when given |
| /// `0..=usize::MAX` since it cannot be represented using a half-open |
| /// interval in terms of `usize`. |
| /// |
| /// This routine also panics if the given range does not correspond to |
| /// valid bounds in the haystack or the termination of a search. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let input = Input::new("foobar"); |
| /// assert_eq!(0..6, input.get_range()); |
| /// |
| /// let input = Input::new("foobar").range(2..=4); |
| /// assert_eq!(2..5, input.get_range()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>range<R: RangeBounds<usize>>(<span class="kw-2">mut </span><span class="self">self</span>, range: R) -> Input<<span class="lifetime">'h</span>> { |
| <span class="self">self</span>.set_range(range); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the anchor mode of a search. |
| /// |
| /// When a search is anchored (via [`Anchored::Yes`]), a match must begin |
| /// at the start of a search. When a search is not anchored (that's |
| /// [`Anchored::No`]), searchers will look for a match anywhere in the |
| /// haystack. |
| /// |
| /// By default, the anchored mode is [`Anchored::No`]. |
| /// |
| /// # Support for anchored searches |
| /// |
| /// Anchored or unanchored searches might not always be available, |
| /// depending on the type of searcher used and its configuration: |
| /// |
| /// * [`noncontiguous::NFA`](crate::nfa::noncontiguous::NFA) always |
| /// supports both unanchored and anchored searches. |
| /// * [`contiguous::NFA`](crate::nfa::contiguous::NFA) always supports both |
| /// unanchored and anchored searches. |
| /// * [`dfa::DFA`](crate::dfa::DFA) supports only unanchored |
| /// searches by default. |
| /// [`dfa::Builder::start_kind`](crate::dfa::Builder::start_kind) can |
| /// be used to change the default to supporting both kinds of searches |
| /// or even just anchored searches. |
| /// * [`AhoCorasick`](crate::AhoCorasick) inherits the same setup as a |
| /// `DFA`. Namely, it only supports unanchored searches by default, but |
| /// [`AhoCorasickBuilder::start_kind`](crate::AhoCorasickBuilder::start_kind) |
| /// can change this. |
| /// |
| /// If you try to execute a search using a `try_` ("fallible") method with |
| /// an unsupported anchor mode, then an error will be returned. For calls |
| /// to infallible search methods, a panic will result. |
| /// |
| /// # Example |
| /// |
| /// This demonstrates the differences between an anchored search and |
| /// an unanchored search. Notice that we build our `AhoCorasick` searcher |
| /// with [`StartKind::Both`] so that it supports both unanchored and |
| /// anchored searches simultaneously. |
| /// |
| /// ``` |
| /// use aho_corasick::{ |
| /// AhoCorasick, Anchored, Input, MatchKind, StartKind, |
| /// }; |
| /// |
| /// let patterns = &["bcd"]; |
| /// let haystack = "abcd"; |
| /// |
| /// let ac = AhoCorasick::builder() |
| /// .start_kind(StartKind::Both) |
| /// .build(patterns) |
| /// .unwrap(); |
| /// |
| /// // Note that 'Anchored::No' is the default, so it doesn't need to |
| /// // be explicitly specified here. |
| /// let input = Input::new(haystack); |
| /// let mat = ac.try_find(input)?.expect("should have a match"); |
| /// assert_eq!("bcd", &haystack[mat.span()]); |
| /// |
| /// // While 'bcd' occurs in the haystack, it does not begin where our |
| /// // search begins, so no match is found. |
| /// let input = Input::new(haystack).anchored(Anchored::Yes); |
| /// assert_eq!(None, ac.try_find(input)?); |
| /// |
| /// // However, if we start our search where 'bcd' starts, then we will |
| /// // find a match. |
| /// let input = Input::new(haystack).range(1..).anchored(Anchored::Yes); |
| /// let mat = ac.try_find(input)?.expect("should have a match"); |
| /// assert_eq!("bcd", &haystack[mat.span()]); |
| /// |
| /// # Ok::<(), Box<dyn std::error::Error>>(()) |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>anchored(<span class="kw-2">mut </span><span class="self">self</span>, mode: Anchored) -> Input<<span class="lifetime">'h</span>> { |
| <span class="self">self</span>.set_anchored(mode); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Whether to execute an "earliest" search or not. |
| /// |
| /// When running a non-overlapping search, an "earliest" search will |
| /// return the match location as early as possible. For example, given |
| /// the patterns `abc` and `b`, and a haystack of `abc`, a normal |
| /// leftmost-first search will return `abc` as a match. But an "earliest" |
| /// search will return as soon as it is known that a match occurs, which |
| /// happens once `b` is seen. |
| /// |
| /// Note that when using [`MatchKind::Standard`], the "earliest" option |
| /// has no effect since standard semantics are already "earliest." Note |
| /// also that this has no effect in overlapping searches, since overlapping |
| /// searches also use standard semantics and report all possible matches. |
| /// |
| /// This is disabled by default. |
| /// |
| /// # Example |
| /// |
| /// This example shows the difference between "earliest" searching and |
| /// normal leftmost searching. |
| /// |
| /// ``` |
| /// use aho_corasick::{AhoCorasick, Anchored, Input, MatchKind, StartKind}; |
| /// |
| /// let patterns = &["abc", "b"]; |
| /// let haystack = "abc"; |
| /// |
| /// let ac = AhoCorasick::builder() |
| /// .match_kind(MatchKind::LeftmostFirst) |
| /// .build(patterns) |
| /// .unwrap(); |
| /// |
| /// // The normal leftmost-first match. |
| /// let input = Input::new(haystack); |
| /// let mat = ac.try_find(input)?.expect("should have a match"); |
| /// assert_eq!("abc", &haystack[mat.span()]); |
| /// |
| /// // The "earliest" possible match, even if it isn't leftmost-first. |
| /// let input = Input::new(haystack).earliest(true); |
| /// let mat = ac.try_find(input)?.expect("should have a match"); |
| /// assert_eq!("b", &haystack[mat.span()]); |
| /// |
| /// # Ok::<(), Box<dyn std::error::Error>>(()) |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>earliest(<span class="kw-2">mut </span><span class="self">self</span>, yes: bool) -> Input<<span class="lifetime">'h</span>> { |
| <span class="self">self</span>.set_earliest(yes); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Set the span for this search configuration. |
| /// |
| /// This is like the [`Input::span`] method, except this mutates the |
| /// span in place. |
| /// |
| /// This routine is generic over how a span is provided. While |
| /// a [`Span`] may be given directly, one may also provide a |
| /// `std::ops::Range<usize>`. |
| /// |
| /// # Panics |
| /// |
| /// This panics if the given span does not correspond to valid bounds in |
| /// the haystack or the termination of a search. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let mut input = Input::new("foobar"); |
| /// assert_eq!(0..6, input.get_range()); |
| /// input.set_span(2..4); |
| /// assert_eq!(2..4, input.get_range()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_span<S: Into<Span>>(<span class="kw-2">&mut </span><span class="self">self</span>, span: S) { |
| <span class="kw">let </span>span = span.into(); |
| <span class="macro">assert!</span>( |
| span.end <= <span class="self">self</span>.haystack.len() |
| && span.start <= span.end.wrapping_add(<span class="number">1</span>), |
| <span class="string">"invalid span {:?} for haystack of length {}"</span>, |
| span, |
| <span class="self">self</span>.haystack.len(), |
| ); |
| <span class="self">self</span>.span = span; |
| } |
| |
| <span class="doccomment">/// Set the span for this search configuration given any range. |
| /// |
| /// This is like the [`Input::range`] method, except this mutates the |
| /// span in place. |
| /// |
| /// # Panics |
| /// |
| /// This routine will panic if the given range could not be converted |
| /// to a valid [`Range`]. For example, this would panic when given |
| /// `0..=usize::MAX` since it cannot be represented using a half-open |
| /// interval in terms of `usize`. |
| /// |
| /// This routine also panics if the given range does not correspond to |
| /// valid bounds in the haystack or the termination of a search. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let mut input = Input::new("foobar"); |
| /// assert_eq!(0..6, input.get_range()); |
| /// input.set_range(2..=4); |
| /// assert_eq!(2..5, input.get_range()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_range<R: RangeBounds<usize>>(<span class="kw-2">&mut </span><span class="self">self</span>, range: R) { |
| <span class="kw">use </span>core::ops::Bound; |
| |
| <span class="comment">// It's a little weird to convert ranges into spans, and then spans |
| // back into ranges when we actually slice the haystack. Because |
| // of that process, we always represent everything as a half-open |
| // internal. Therefore, handling things like m..=n is a little awkward. |
| </span><span class="kw">let </span>start = <span class="kw">match </span>range.start_bound() { |
| Bound::Included(<span class="kw-2">&</span>i) => i, |
| <span class="comment">// Can this case ever happen? Range syntax doesn't support it... |
| </span>Bound::Excluded(<span class="kw-2">&</span>i) => i.checked_add(<span class="number">1</span>).unwrap(), |
| Bound::Unbounded => <span class="number">0</span>, |
| }; |
| <span class="kw">let </span>end = <span class="kw">match </span>range.end_bound() { |
| Bound::Included(<span class="kw-2">&</span>i) => i.checked_add(<span class="number">1</span>).unwrap(), |
| Bound::Excluded(<span class="kw-2">&</span>i) => i, |
| Bound::Unbounded => <span class="self">self</span>.haystack().len(), |
| }; |
| <span class="self">self</span>.set_span(Span { start, end }); |
| } |
| |
| <span class="doccomment">/// Set the starting offset for the span for this search configuration. |
| /// |
| /// This is a convenience routine for only mutating the start of a span |
| /// without having to set the entire span. |
| /// |
| /// # Panics |
| /// |
| /// This panics if the given span does not correspond to valid bounds in |
| /// the haystack or the termination of a search. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let mut input = Input::new("foobar"); |
| /// assert_eq!(0..6, input.get_range()); |
| /// input.set_start(5); |
| /// assert_eq!(5..6, input.get_range()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_start(<span class="kw-2">&mut </span><span class="self">self</span>, start: usize) { |
| <span class="self">self</span>.set_span(Span { start, ..<span class="self">self</span>.get_span() }); |
| } |
| |
| <span class="doccomment">/// Set the ending offset for the span for this search configuration. |
| /// |
| /// This is a convenience routine for only mutating the end of a span |
| /// without having to set the entire span. |
| /// |
| /// # Panics |
| /// |
| /// This panics if the given span does not correspond to valid bounds in |
| /// the haystack or the termination of a search. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let mut input = Input::new("foobar"); |
| /// assert_eq!(0..6, input.get_range()); |
| /// input.set_end(5); |
| /// assert_eq!(0..5, input.get_range()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_end(<span class="kw-2">&mut </span><span class="self">self</span>, end: usize) { |
| <span class="self">self</span>.set_span(Span { end, ..<span class="self">self</span>.get_span() }); |
| } |
| |
| <span class="doccomment">/// Set the anchor mode of a search. |
| /// |
| /// This is like [`Input::anchored`], except it mutates the search |
| /// configuration in place. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::{Anchored, Input}; |
| /// |
| /// let mut input = Input::new("foobar"); |
| /// assert_eq!(Anchored::No, input.get_anchored()); |
| /// |
| /// input.set_anchored(Anchored::Yes); |
| /// assert_eq!(Anchored::Yes, input.get_anchored()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_anchored(<span class="kw-2">&mut </span><span class="self">self</span>, mode: Anchored) { |
| <span class="self">self</span>.anchored = mode; |
| } |
| |
| <span class="doccomment">/// Set whether the search should execute in "earliest" mode or not. |
| /// |
| /// This is like [`Input::earliest`], except it mutates the search |
| /// configuration in place. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let mut input = Input::new("foobar"); |
| /// assert!(!input.get_earliest()); |
| /// input.set_earliest(true); |
| /// assert!(input.get_earliest()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_earliest(<span class="kw-2">&mut </span><span class="self">self</span>, yes: bool) { |
| <span class="self">self</span>.earliest = yes; |
| } |
| |
| <span class="doccomment">/// Return a borrow of the underlying haystack as a slice of bytes. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let input = Input::new("foobar"); |
| /// assert_eq!(b"foobar", input.haystack()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>haystack(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="self">self</span>.haystack |
| } |
| |
| <span class="doccomment">/// Return the start position of this search. |
| /// |
| /// This is a convenience routine for `search.get_span().start()`. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let input = Input::new("foobar"); |
| /// assert_eq!(0, input.start()); |
| /// |
| /// let input = Input::new("foobar").span(2..4); |
| /// assert_eq!(2, input.start()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>start(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.get_span().start |
| } |
| |
| <span class="doccomment">/// Return the end position of this search. |
| /// |
| /// This is a convenience routine for `search.get_span().end()`. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let input = Input::new("foobar"); |
| /// assert_eq!(6, input.end()); |
| /// |
| /// let input = Input::new("foobar").span(2..4); |
| /// assert_eq!(4, input.end()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>end(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.get_span().end |
| } |
| |
| <span class="doccomment">/// Return the span for this search configuration. |
| /// |
| /// If one was not explicitly set, then the span corresponds to the entire |
| /// range of the haystack. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::{Input, Span}; |
| /// |
| /// let input = Input::new("foobar"); |
| /// assert_eq!(Span { start: 0, end: 6 }, input.get_span()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>get_span(<span class="kw-2">&</span><span class="self">self</span>) -> Span { |
| <span class="self">self</span>.span |
| } |
| |
| <span class="doccomment">/// Return the span as a range for this search configuration. |
| /// |
| /// If one was not explicitly set, then the span corresponds to the entire |
| /// range of the haystack. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let input = Input::new("foobar"); |
| /// assert_eq!(0..6, input.get_range()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>get_range(<span class="kw-2">&</span><span class="self">self</span>) -> Range<usize> { |
| <span class="self">self</span>.get_span().range() |
| } |
| |
| <span class="doccomment">/// Return the anchored mode for this search configuration. |
| /// |
| /// If no anchored mode was set, then it defaults to [`Anchored::No`]. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::{Anchored, Input}; |
| /// |
| /// let mut input = Input::new("foobar"); |
| /// assert_eq!(Anchored::No, input.get_anchored()); |
| /// |
| /// input.set_anchored(Anchored::Yes); |
| /// assert_eq!(Anchored::Yes, input.get_anchored()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>get_anchored(<span class="kw-2">&</span><span class="self">self</span>) -> Anchored { |
| <span class="self">self</span>.anchored |
| } |
| |
| <span class="doccomment">/// Return whether this search should execute in "earliest" mode. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let input = Input::new("foobar"); |
| /// assert!(!input.get_earliest()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>get_earliest(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.earliest |
| } |
| |
| <span class="doccomment">/// Return true if this input has been exhausted, which in turn means all |
| /// subsequent searches will return no matches. |
| /// |
| /// This occurs precisely when the start position of this search is greater |
| /// than the end position of the search. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Input; |
| /// |
| /// let mut input = Input::new("foobar"); |
| /// assert!(!input.is_done()); |
| /// input.set_start(6); |
| /// assert!(!input.is_done()); |
| /// input.set_start(7); |
| /// assert!(input.is_done()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>is_done(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.get_span().start > <span class="self">self</span>.get_span().end |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'h</span>> core::fmt::Debug <span class="kw">for </span>Input<<span class="lifetime">'h</span>> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter) -> core::fmt::Result { |
| <span class="kw">let </span><span class="kw-2">mut </span>fmter = f.debug_struct(<span class="string">"Input"</span>); |
| <span class="kw">match </span>core::str::from_utf8(<span class="self">self</span>.haystack()) { |
| <span class="prelude-val">Ok</span>(nice) => fmter.field(<span class="string">"haystack"</span>, <span class="kw-2">&</span>nice), |
| <span class="prelude-val">Err</span>(<span class="kw">_</span>) => fmter.field(<span class="string">"haystack"</span>, <span class="kw-2">&</span><span class="self">self</span>.haystack()), |
| } |
| .field(<span class="string">"span"</span>, <span class="kw-2">&</span><span class="self">self</span>.span) |
| .field(<span class="string">"anchored"</span>, <span class="kw-2">&</span><span class="self">self</span>.anchored) |
| .field(<span class="string">"earliest"</span>, <span class="kw-2">&</span><span class="self">self</span>.earliest) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'h</span>, H: <span class="question-mark">?</span>Sized + AsRef<[u8]>> From<<span class="kw-2">&</span><span class="lifetime">'h </span>H> <span class="kw">for </span>Input<<span class="lifetime">'h</span>> { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>from(haystack: <span class="kw-2">&</span><span class="lifetime">'h </span>H) -> Input<<span class="lifetime">'h</span>> { |
| Input::new(haystack) |
| } |
| } |
| |
| <span class="doccomment">/// A representation of a range in a haystack. |
| /// |
| /// A span corresponds to the starting and ending _byte offsets_ of a |
| /// contiguous region of bytes. The starting offset is inclusive while the |
| /// ending offset is exclusive. That is, a span is a half-open interval. |
| /// |
| /// A span is used to report the offsets of a match, but it is also used to |
| /// convey which region of a haystack should be searched via routines like |
| /// [`Input::span`]. |
| /// |
| /// This is basically equivalent to a `std::ops::Range<usize>`, except this |
| /// type implements `Copy` which makes it more ergonomic to use in the context |
| /// of this crate. Indeed, `Span` exists only because `Range<usize>` does |
| /// not implement `Copy`. Like a range, this implements `Index` for `[u8]` |
| /// and `str`, and `IndexMut` for `[u8]`. For convenience, this also impls |
| /// `From<Range>`, which means things like `Span::from(5..10)` work. |
| /// |
| /// There are no constraints on the values of a span. It is, for example, legal |
| /// to create a span where `start > end`. |
| </span><span class="attribute">#[derive(Clone, Copy, Eq, Hash, PartialEq)] |
| </span><span class="kw">pub struct </span>Span { |
| <span class="doccomment">/// The start offset of the span, inclusive. |
| </span><span class="kw">pub </span>start: usize, |
| <span class="doccomment">/// The end offset of the span, exclusive. |
| </span><span class="kw">pub </span>end: usize, |
| } |
| |
| <span class="kw">impl </span>Span { |
| <span class="doccomment">/// Returns this span as a range. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>range(<span class="kw-2">&</span><span class="self">self</span>) -> Range<usize> { |
| Range::from(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Returns true when this span is empty. That is, when `start >= end`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.start >= <span class="self">self</span>.end |
| } |
| |
| <span class="doccomment">/// Returns the length of this span. |
| /// |
| /// This returns `0` in precisely the cases that `is_empty` returns `true`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.end.saturating_sub(<span class="self">self</span>.start) |
| } |
| |
| <span class="doccomment">/// Returns true when the given offset is contained within this span. |
| /// |
| /// Note that an empty span contains no offsets and will always return |
| /// false. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>contains(<span class="kw-2">&</span><span class="self">self</span>, offset: usize) -> bool { |
| !<span class="self">self</span>.is_empty() && <span class="self">self</span>.start <= offset && offset <= <span class="self">self</span>.end |
| } |
| |
| <span class="doccomment">/// Returns a new span with `offset` added to this span's `start` and `end` |
| /// values. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>offset(<span class="kw-2">&</span><span class="self">self</span>, offset: usize) -> Span { |
| Span { start: <span class="self">self</span>.start + offset, end: <span class="self">self</span>.end + offset } |
| } |
| } |
| |
| <span class="kw">impl </span>core::fmt::Debug <span class="kw">for </span>Span { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter) -> core::fmt::Result { |
| <span class="macro">write!</span>(f, <span class="string">"{}..{}"</span>, <span class="self">self</span>.start, <span class="self">self</span>.end) |
| } |
| } |
| |
| <span class="kw">impl </span>core::ops::Index<Span> <span class="kw">for </span>[u8] { |
| <span class="kw">type </span>Output = [u8]; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>index(<span class="kw-2">&</span><span class="self">self</span>, index: Span) -> <span class="kw-2">&</span>[u8] { |
| <span class="kw-2">&</span><span class="self">self</span>[index.range()] |
| } |
| } |
| |
| <span class="kw">impl </span>core::ops::IndexMut<Span> <span class="kw">for </span>[u8] { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>index_mut(<span class="kw-2">&mut </span><span class="self">self</span>, index: Span) -> <span class="kw-2">&mut </span>[u8] { |
| <span class="kw-2">&mut </span><span class="self">self</span>[index.range()] |
| } |
| } |
| |
| <span class="kw">impl </span>core::ops::Index<Span> <span class="kw">for </span>str { |
| <span class="kw">type </span>Output = str; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>index(<span class="kw-2">&</span><span class="self">self</span>, index: Span) -> <span class="kw-2">&</span>str { |
| <span class="kw-2">&</span><span class="self">self</span>[index.range()] |
| } |
| } |
| |
| <span class="kw">impl </span>From<Range<usize>> <span class="kw">for </span>Span { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>from(range: Range<usize>) -> Span { |
| Span { start: range.start, end: range.end } |
| } |
| } |
| |
| <span class="kw">impl </span>From<Span> <span class="kw">for </span>Range<usize> { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>from(span: Span) -> Range<usize> { |
| Range { start: span.start, end: span.end } |
| } |
| } |
| |
| <span class="kw">impl </span>PartialEq<Range<usize>> <span class="kw">for </span>Span { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, range: <span class="kw-2">&</span>Range<usize>) -> bool { |
| <span class="self">self</span>.start == range.start && <span class="self">self</span>.end == range.end |
| } |
| } |
| |
| <span class="kw">impl </span>PartialEq<Span> <span class="kw">for </span>Range<usize> { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, span: <span class="kw-2">&</span>Span) -> bool { |
| <span class="self">self</span>.start == span.start && <span class="self">self</span>.end == span.end |
| } |
| } |
| |
| <span class="doccomment">/// The type of anchored search to perform. |
| /// |
| /// If an Aho-Corasick searcher does not support the anchored mode selected, |
| /// then the search will return an error or panic, depending on whether a |
| /// fallible or an infallible routine was called. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Clone, Copy, Debug, Eq, PartialEq)] |
| </span><span class="kw">pub enum </span>Anchored { |
| <span class="doccomment">/// Run an unanchored search. This means a match may occur anywhere at or |
| /// after the start position of the search up until the end position of the |
| /// search. |
| </span>No, |
| <span class="doccomment">/// Run an anchored search. This means that a match must begin at the start |
| /// position of the search and end before the end position of the search. |
| </span>Yes, |
| } |
| |
| <span class="kw">impl </span>Anchored { |
| <span class="doccomment">/// Returns true if and only if this anchor mode corresponds to an anchored |
| /// search. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use aho_corasick::Anchored; |
| /// |
| /// assert!(!Anchored::No.is_anchored()); |
| /// assert!(Anchored::Yes.is_anchored()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>is_anchored(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="macro">matches!</span>(<span class="kw-2">*</span><span class="self">self</span>, Anchored::Yes) |
| } |
| } |
| |
| <span class="doccomment">/// A representation of a match reported by an Aho-Corasick searcher. |
| /// |
| /// A match has two essential pieces of information: the [`PatternID`] that |
| /// matches, and the [`Span`] of the match in a haystack. |
| /// |
| /// The pattern is identified by an ID, which corresponds to its position |
| /// (starting from `0`) relative to other patterns used to construct the |
| /// corresponding searcher. If only a single pattern is provided, then all |
| /// matches are guaranteed to have a pattern ID of `0`. |
| /// |
| /// Every match reported by a searcher guarantees that its span has its start |
| /// offset as less than or equal to its end offset. |
| </span><span class="attribute">#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] |
| </span><span class="kw">pub struct </span>Match { |
| <span class="doccomment">/// The pattern ID. |
| </span>pattern: PatternID, |
| <span class="doccomment">/// The underlying match span. |
| </span>span: Span, |
| } |
| |
| <span class="kw">impl </span>Match { |
| <span class="doccomment">/// Create a new match from a pattern ID and a span. |
| /// |
| /// This constructor is generic over how a span is provided. While |
| /// a [`Span`] may be given directly, one may also provide a |
| /// `std::ops::Range<usize>`. |
| /// |
| /// # Panics |
| /// |
| /// This panics if `end < start`. |
| /// |
| /// # Example |
| /// |
| /// This shows how to create a match for the first pattern in an |
| /// Aho-Corasick searcher using convenient range syntax. |
| /// |
| /// ``` |
| /// use aho_corasick::{Match, PatternID}; |
| /// |
| /// let m = Match::new(PatternID::ZERO, 5..10); |
| /// assert_eq!(0, m.pattern().as_usize()); |
| /// assert_eq!(5, m.start()); |
| /// assert_eq!(10, m.end()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>new<S: Into<Span>>(pattern: PatternID, span: S) -> Match { |
| <span class="kw">let </span>span = span.into(); |
| <span class="macro">assert!</span>(span.start <= span.end, <span class="string">"invalid match span"</span>); |
| Match { pattern, span } |
| } |
| |
| <span class="doccomment">/// Create a new match from a pattern ID and a byte offset span. |
| /// |
| /// This constructor is generic over how a span is provided. While |
| /// a [`Span`] may be given directly, one may also provide a |
| /// `std::ops::Range<usize>`. |
| /// |
| /// This is like [`Match::new`], but accepts a `usize` instead of a |
| /// [`PatternID`]. This panics if the given `usize` is not representable |
| /// as a `PatternID`. |
| /// |
| /// # Panics |
| /// |
| /// This panics if `end < start` or if `pattern > PatternID::MAX`. |
| /// |
| /// # Example |
| /// |
| /// This shows how to create a match for the third pattern in an |
| /// Aho-Corasick searcher using convenient range syntax. |
| /// |
| /// ``` |
| /// use aho_corasick::Match; |
| /// |
| /// let m = Match::must(3, 5..10); |
| /// assert_eq!(3, m.pattern().as_usize()); |
| /// assert_eq!(5, m.start()); |
| /// assert_eq!(10, m.end()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>must<S: Into<Span>>(pattern: usize, span: S) -> Match { |
| Match::new(PatternID::must(pattern), span) |
| } |
| |
| <span class="doccomment">/// Returns the ID of the pattern that matched. |
| /// |
| /// The ID of a pattern is derived from the position in which it was |
| /// originally inserted into the corresponding searcher. The first pattern |
| /// has identifier `0`, and each subsequent pattern is `1`, `2` and so on. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>pattern(<span class="kw-2">&</span><span class="self">self</span>) -> PatternID { |
| <span class="self">self</span>.pattern |
| } |
| |
| <span class="doccomment">/// The starting position of the match. |
| /// |
| /// This is a convenience routine for `Match::span().start`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>start(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.span().start |
| } |
| |
| <span class="doccomment">/// The ending position of the match. |
| /// |
| /// This is a convenience routine for `Match::span().end`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>end(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.span().end |
| } |
| |
| <span class="doccomment">/// Returns the match span as a range. |
| /// |
| /// This is a convenience routine for `Match::span().range()`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>range(<span class="kw-2">&</span><span class="self">self</span>) -> core::ops::Range<usize> { |
| <span class="self">self</span>.span().range() |
| } |
| |
| <span class="doccomment">/// Returns the span for this match. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>span(<span class="kw-2">&</span><span class="self">self</span>) -> Span { |
| <span class="self">self</span>.span |
| } |
| |
| <span class="doccomment">/// Returns true when the span in this match is empty. |
| /// |
| /// An empty match can only be returned when empty pattern is in the |
| /// Aho-Corasick searcher. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.span().is_empty() |
| } |
| |
| <span class="doccomment">/// Returns the length of this match. |
| /// |
| /// This returns `0` in precisely the cases that `is_empty` returns `true`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.span().len() |
| } |
| |
| <span class="doccomment">/// Returns a new match with `offset` added to its span's `start` and `end` |
| /// values. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>offset(<span class="kw-2">&</span><span class="self">self</span>, offset: usize) -> Match { |
| Match { |
| pattern: <span class="self">self</span>.pattern, |
| span: Span { |
| start: <span class="self">self</span>.start() + offset, |
| end: <span class="self">self</span>.end() + offset, |
| }, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// A knob for controlling the match semantics of an Aho-Corasick automaton. |
| /// |
| /// There are two generally different ways that Aho-Corasick automatons can |
| /// report matches. The first way is the "standard" approach that results from |
| /// implementing most textbook explanations of Aho-Corasick. The second way is |
| /// to report only the leftmost non-overlapping matches. The leftmost approach |
| /// is in turn split into two different ways of resolving ambiguous matches: |
| /// leftmost-first and leftmost-longest. |
| /// |
| /// The `Standard` match kind is the default and is the only one that supports |
| /// overlapping matches and stream searching. (Trying to find overlapping or |
| /// streaming matches using leftmost match semantics will result in an error in |
| /// fallible APIs and a panic when using infallibe APIs.) The `Standard` match |
| /// kind will report matches as they are seen. When searching for overlapping |
| /// matches, then all possible matches are reported. When searching for |
| /// non-overlapping matches, the first match seen is reported. For example, for |
| /// non-overlapping matches, given the patterns `abcd` and `b` and the haystack |
| /// `abcdef`, only a match for `b` is reported since it is detected first. The |
| /// `abcd` match is never reported since it overlaps with the `b` match. |
| /// |
| /// In contrast, the leftmost match kind always prefers the leftmost match |
| /// among all possible matches. Given the same example as above with `abcd` and |
| /// `b` as patterns and `abcdef` as the haystack, the leftmost match is `abcd` |
| /// since it begins before the `b` match, even though the `b` match is detected |
| /// before the `abcd` match. In this case, the `b` match is not reported at all |
| /// since it overlaps with the `abcd` match. |
| /// |
| /// The difference between leftmost-first and leftmost-longest is in how they |
| /// resolve ambiguous matches when there are multiple leftmost matches to |
| /// choose from. Leftmost-first always chooses the pattern that was provided |
| /// earliest, where as leftmost-longest always chooses the longest matching |
| /// pattern. For example, given the patterns `a` and `ab` and the subject |
| /// string `ab`, the leftmost-first match is `a` but the leftmost-longest match |
| /// is `ab`. Conversely, if the patterns were given in reverse order, i.e., |
| /// `ab` and `a`, then both the leftmost-first and leftmost-longest matches |
| /// would be `ab`. Stated differently, the leftmost-first match depends on the |
| /// order in which the patterns were given to the Aho-Corasick automaton. |
| /// Because of that, when leftmost-first matching is used, if a pattern `A` |
| /// that appears before a pattern `B` is a prefix of `B`, then it is impossible |
| /// to ever observe a match of `B`. |
| /// |
| /// If you're not sure which match kind to pick, then stick with the standard |
| /// kind, which is the default. In particular, if you need overlapping or |
| /// streaming matches, then you _must_ use the standard kind. The leftmost |
| /// kinds are useful in specific circumstances. For example, leftmost-first can |
| /// be very useful as a way to implement match priority based on the order of |
| /// patterns given and leftmost-longest can be useful for dictionary searching |
| /// such that only the longest matching words are reported. |
| /// |
| /// # Relationship with regular expression alternations |
| /// |
| /// Understanding match semantics can be a little tricky, and one easy way |
| /// to conceptualize non-overlapping matches from an Aho-Corasick automaton |
| /// is to think about them as a simple alternation of literals in a regular |
| /// expression. For example, let's say we wanted to match the strings |
| /// `Sam` and `Samwise`, which would turn into the regex `Sam|Samwise`. It |
| /// turns out that regular expression engines have two different ways of |
| /// matching this alternation. The first way, leftmost-longest, is commonly |
| /// found in POSIX compatible implementations of regular expressions (such as |
| /// `grep`). The second way, leftmost-first, is commonly found in backtracking |
| /// implementations such as Perl. (Some regex engines, such as RE2 and Rust's |
| /// regex engine do not use backtracking, but still implement leftmost-first |
| /// semantics in an effort to match the behavior of dominant backtracking |
| /// regex engines such as those found in Perl, Ruby, Python, Javascript and |
| /// PHP.) |
| /// |
| /// That is, when matching `Sam|Samwise` against `Samwise`, a POSIX regex |
| /// will match `Samwise` because it is the longest possible match, but a |
| /// Perl-like regex will match `Sam` since it appears earlier in the |
| /// alternation. Indeed, the regex `Sam|Samwise` in a Perl-like regex engine |
| /// will never match `Samwise` since `Sam` will always have higher priority. |
| /// Conversely, matching the regex `Samwise|Sam` against `Samwise` will lead to |
| /// a match of `Samwise` in both POSIX and Perl-like regexes since `Samwise` is |
| /// still longest match, but it also appears earlier than `Sam`. |
| /// |
| /// The "standard" match semantics of Aho-Corasick generally don't correspond |
| /// to the match semantics of any large group of regex implementations, so |
| /// there's no direct analogy that can be made here. Standard match semantics |
| /// are generally useful for overlapping matches, or if you just want to see |
| /// matches as they are detected. |
| /// |
| /// The main conclusion to draw from this section is that the match semantics |
| /// can be tweaked to precisely match either Perl-like regex alternations or |
| /// POSIX regex alternations. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Clone, Copy, Debug, Eq, PartialEq)] |
| </span><span class="kw">pub enum </span>MatchKind { |
| <span class="doccomment">/// Use standard match semantics, which support overlapping matches. When |
| /// used with non-overlapping matches, matches are reported as they are |
| /// seen. |
| </span>Standard, |
| <span class="doccomment">/// Use leftmost-first match semantics, which reports leftmost matches. |
| /// When there are multiple possible leftmost matches, the match |
| /// corresponding to the pattern that appeared earlier when constructing |
| /// the automaton is reported. |
| /// |
| /// This does **not** support overlapping matches or stream searching. If |
| /// this match kind is used, attempting to find overlapping matches or |
| /// stream matches will fail. |
| </span>LeftmostFirst, |
| <span class="doccomment">/// Use leftmost-longest match semantics, which reports leftmost matches. |
| /// When there are multiple possible leftmost matches, the longest match |
| /// is chosen. |
| /// |
| /// This does **not** support overlapping matches or stream searching. If |
| /// this match kind is used, attempting to find overlapping matches or |
| /// stream matches will fail. |
| </span>LeftmostLongest, |
| } |
| |
| <span class="doccomment">/// The default match kind is `MatchKind::Standard`. |
| </span><span class="kw">impl </span>Default <span class="kw">for </span>MatchKind { |
| <span class="kw">fn </span>default() -> MatchKind { |
| MatchKind::Standard |
| } |
| } |
| |
| <span class="kw">impl </span>MatchKind { |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_standard(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="macro">matches!</span>(<span class="kw-2">*</span><span class="self">self</span>, MatchKind::Standard) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_leftmost(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="macro">matches!</span>(<span class="kw-2">*</span><span class="self">self</span>, MatchKind::LeftmostFirst | MatchKind::LeftmostLongest) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_leftmost_first(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="macro">matches!</span>(<span class="kw-2">*</span><span class="self">self</span>, MatchKind::LeftmostFirst) |
| } |
| |
| <span class="doccomment">/// Convert this match kind into a packed match kind. If this match kind |
| /// corresponds to standard semantics, then this returns None, since |
| /// packed searching does not support standard semantics. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>as_packed(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw">crate</span>::packed::MatchKind> { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| MatchKind::Standard => <span class="prelude-val">None</span>, |
| MatchKind::LeftmostFirst => { |
| <span class="prelude-val">Some</span>(<span class="kw">crate</span>::packed::MatchKind::LeftmostFirst) |
| } |
| MatchKind::LeftmostLongest => { |
| <span class="prelude-val">Some</span>(<span class="kw">crate</span>::packed::MatchKind::LeftmostLongest) |
| } |
| } |
| } |
| } |
| |
| <span class="doccomment">/// The kind of anchored starting configurations to support in an Aho-Corasick |
| /// searcher. |
| /// |
| /// Depending on which searcher is used internally by |
| /// [`AhoCorasick`](crate::AhoCorasick), supporting both unanchored |
| /// and anchored searches can be quite costly. For this reason, |
| /// [`AhoCorasickBuilder::start_kind`](crate::AhoCorasickBuilder::start_kind) |
| /// can be used to configure whether your searcher supports unanchored, |
| /// anchored or both kinds of searches. |
| /// |
| /// This searcher configuration knob works in concert with the search time |
| /// configuration [`Input::anchored`]. Namely, if one requests an unsupported |
| /// anchored mode, then the search will either panic or return an error, |
| /// depending on whether you're using infallible or fallibe APIs, respectively. |
| /// |
| /// `AhoCorasick` by default only supports unanchored searches. |
| </span><span class="attribute">#[derive(Clone, Copy, Debug, Eq, PartialEq)] |
| </span><span class="kw">pub enum </span>StartKind { |
| <span class="doccomment">/// Support both anchored and unanchored searches. |
| </span>Both, |
| <span class="doccomment">/// Support only unanchored searches. Requesting an anchored search will |
| /// return an error in fallible APIs and panic in infallible APIs. |
| </span>Unanchored, |
| <span class="doccomment">/// Support only anchored searches. Requesting an unanchored search will |
| /// return an error in fallible APIs and panic in infallible APIs. |
| </span>Anchored, |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>StartKind { |
| <span class="kw">fn </span>default() -> StartKind { |
| StartKind::Unanchored |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="aho_corasick" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |