| <!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/packed/api.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>api.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> |
| </pre><pre class="rust"><code><span class="kw">use crate</span>::{ |
| packed::{ |
| pattern::Patterns, |
| rabinkarp::RabinKarp, |
| teddy::{<span class="self">self</span>, Teddy}, |
| }, |
| util::search::{Match, Span}, |
| }; |
| |
| <span class="doccomment">/// This is a limit placed on the total number of patterns we're willing to try |
| /// and match at once. As more sophisticated algorithms are added, this number |
| /// may be increased. |
| </span><span class="kw">const </span>PATTERN_LIMIT: usize = <span class="number">128</span>; |
| |
| <span class="doccomment">/// A knob for controlling the match semantics of a packed multiple string |
| /// searcher. |
| /// |
| /// This differs from the [`MatchKind`](crate::MatchKind) type in the top-level |
| /// crate module in that it doesn't support "standard" match semantics, |
| /// and instead only supports leftmost-first or leftmost-longest. Namely, |
| /// "standard" semantics cannot be easily supported by packed searchers. |
| /// |
| /// For more information on the distinction between leftmost-first and |
| /// leftmost-longest, see the docs on the top-level `MatchKind` type. |
| /// |
| /// Unlike the top-level `MatchKind` type, the default match semantics for this |
| /// type are leftmost-first. |
| </span><span class="attribute">#[derive(Clone, Copy, Debug, Eq, PartialEq)] |
| #[non_exhaustive] |
| </span><span class="kw">pub enum </span>MatchKind { |
| <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 is the default. |
| </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. |
| </span>LeftmostLongest, |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>MatchKind { |
| <span class="kw">fn </span>default() -> MatchKind { |
| MatchKind::LeftmostFirst |
| } |
| } |
| |
| <span class="doccomment">/// The configuration for a packed multiple pattern searcher. |
| /// |
| /// The configuration is currently limited only to being able to select the |
| /// match semantics (leftmost-first or leftmost-longest) of a searcher. In the |
| /// future, more knobs may be made available. |
| /// |
| /// A configuration produces a [`packed::Builder`](Builder), which in turn can |
| /// be used to construct a [`packed::Searcher`](Searcher) for searching. |
| /// |
| /// # Example |
| /// |
| /// This example shows how to use leftmost-longest semantics instead of the |
| /// default (leftmost-first). |
| /// |
| /// ``` |
| /// use aho_corasick::{packed::{Config, MatchKind}, PatternID}; |
| /// |
| /// # fn example() -> Option<()> { |
| /// let searcher = Config::new() |
| /// .match_kind(MatchKind::LeftmostLongest) |
| /// .builder() |
| /// .add("foo") |
| /// .add("foobar") |
| /// .build()?; |
| /// let matches: Vec<PatternID> = searcher |
| /// .find_iter("foobar") |
| /// .map(|mat| mat.pattern()) |
| /// .collect(); |
| /// assert_eq!(vec![PatternID::must(1)], matches); |
| /// # Some(()) } |
| /// # if cfg!(all(feature = "std", target_arch = "x86_64")) { |
| /// # example().unwrap() |
| /// # } else { |
| /// # assert!(example().is_none()); |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub struct </span>Config { |
| kind: MatchKind, |
| force: <span class="prelude-ty">Option</span><ForceAlgorithm>, |
| force_teddy_fat: <span class="prelude-ty">Option</span><bool>, |
| force_avx: <span class="prelude-ty">Option</span><bool>, |
| } |
| |
| <span class="doccomment">/// An internal option for forcing the use of a particular packed algorithm. |
| /// |
| /// When an algorithm is forced, if a searcher could not be constructed for it, |
| /// then no searcher will be returned even if an alternative algorithm would |
| /// work. |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">enum </span>ForceAlgorithm { |
| Teddy, |
| RabinKarp, |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>Config { |
| <span class="kw">fn </span>default() -> Config { |
| Config::new() |
| } |
| } |
| |
| <span class="kw">impl </span>Config { |
| <span class="doccomment">/// Create a new default configuration. A default configuration uses |
| /// leftmost-first match semantics. |
| </span><span class="kw">pub fn </span>new() -> Config { |
| Config { |
| kind: MatchKind::LeftmostFirst, |
| force: <span class="prelude-val">None</span>, |
| force_teddy_fat: <span class="prelude-val">None</span>, |
| force_avx: <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Create a packed builder from this configuration. The builder can be |
| /// used to accumulate patterns and create a [`Searcher`] from them. |
| </span><span class="kw">pub fn </span>builder(<span class="kw-2">&</span><span class="self">self</span>) -> Builder { |
| Builder::from_config(<span class="self">self</span>.clone()) |
| } |
| |
| <span class="doccomment">/// Set the match semantics for this configuration. |
| </span><span class="kw">pub fn </span>match_kind(<span class="kw-2">&mut </span><span class="self">self</span>, kind: MatchKind) -> <span class="kw-2">&mut </span>Config { |
| <span class="self">self</span>.kind = kind; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// An undocumented method for forcing the use of the Teddy algorithm. |
| /// |
| /// This is only exposed for more precise testing and benchmarks. Callers |
| /// should not use it as it is not part of the API stability guarantees of |
| /// this crate. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub fn </span>force_teddy(<span class="kw-2">&mut </span><span class="self">self</span>, yes: bool) -> <span class="kw-2">&mut </span>Config { |
| <span class="kw">if </span>yes { |
| <span class="self">self</span>.force = <span class="prelude-val">Some</span>(ForceAlgorithm::Teddy); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.force = <span class="prelude-val">None</span>; |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// An undocumented method for forcing the use of the Fat Teddy algorithm. |
| /// |
| /// This is only exposed for more precise testing and benchmarks. Callers |
| /// should not use it as it is not part of the API stability guarantees of |
| /// this crate. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub fn </span>force_teddy_fat(<span class="kw-2">&mut </span><span class="self">self</span>, yes: <span class="prelude-ty">Option</span><bool>) -> <span class="kw-2">&mut </span>Config { |
| <span class="self">self</span>.force_teddy_fat = yes; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// An undocumented method for forcing the use of SSE (`Some(false)`) or |
| /// AVX (`Some(true)`) algorithms. |
| /// |
| /// This is only exposed for more precise testing and benchmarks. Callers |
| /// should not use it as it is not part of the API stability guarantees of |
| /// this crate. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub fn </span>force_avx(<span class="kw-2">&mut </span><span class="self">self</span>, yes: <span class="prelude-ty">Option</span><bool>) -> <span class="kw-2">&mut </span>Config { |
| <span class="self">self</span>.force_avx = yes; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// An undocumented method for forcing the use of the Rabin-Karp algorithm. |
| /// |
| /// This is only exposed for more precise testing and benchmarks. Callers |
| /// should not use it as it is not part of the API stability guarantees of |
| /// this crate. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub fn </span>force_rabin_karp(<span class="kw-2">&mut </span><span class="self">self</span>, yes: bool) -> <span class="kw-2">&mut </span>Config { |
| <span class="kw">if </span>yes { |
| <span class="self">self</span>.force = <span class="prelude-val">Some</span>(ForceAlgorithm::RabinKarp); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.force = <span class="prelude-val">None</span>; |
| } |
| <span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// A builder for constructing a packed searcher from a collection of patterns. |
| /// |
| /// # Example |
| /// |
| /// This example shows how to use a builder to construct a searcher. By |
| /// default, leftmost-first match semantics are used. |
| /// |
| /// ``` |
| /// use aho_corasick::{packed::{Builder, MatchKind}, PatternID}; |
| /// |
| /// # fn example() -> Option<()> { |
| /// let searcher = Builder::new() |
| /// .add("foobar") |
| /// .add("foo") |
| /// .build()?; |
| /// let matches: Vec<PatternID> = searcher |
| /// .find_iter("foobar") |
| /// .map(|mat| mat.pattern()) |
| /// .collect(); |
| /// assert_eq!(vec![PatternID::ZERO], matches); |
| /// # Some(()) } |
| /// # if cfg!(all(feature = "std", target_arch = "x86_64")) { |
| /// # example().unwrap() |
| /// # } else { |
| /// # assert!(example().is_none()); |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub struct </span>Builder { |
| <span class="doccomment">/// The configuration of this builder and subsequent matcher. |
| </span>config: Config, |
| <span class="doccomment">/// Set to true if the builder detects that a matcher cannot be built. |
| </span>inert: bool, |
| <span class="doccomment">/// The patterns provided by the caller. |
| </span>patterns: Patterns, |
| } |
| |
| <span class="kw">impl </span>Builder { |
| <span class="doccomment">/// Create a new builder for constructing a multi-pattern searcher. This |
| /// constructor uses the default configuration. |
| </span><span class="kw">pub fn </span>new() -> Builder { |
| Builder::from_config(Config::new()) |
| } |
| |
| <span class="kw">fn </span>from_config(config: Config) -> Builder { |
| Builder { config, inert: <span class="bool-val">false</span>, patterns: Patterns::new() } |
| } |
| |
| <span class="doccomment">/// Build a searcher from the patterns added to this builder so far. |
| </span><span class="kw">pub fn </span>build(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Searcher> { |
| <span class="kw">if </span><span class="self">self</span>.inert || <span class="self">self</span>.patterns.is_empty() { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| <span class="kw">let </span><span class="kw-2">mut </span>patterns = <span class="self">self</span>.patterns.clone(); |
| patterns.set_match_kind(<span class="self">self</span>.config.kind); |
| <span class="kw">let </span>rabinkarp = RabinKarp::new(<span class="kw-2">&</span>patterns); |
| <span class="comment">// Effectively, we only want to return a searcher if we can use Teddy, |
| // since Teddy is our only fast packed searcher at the moment. |
| // Rabin-Karp is only used when searching haystacks smaller than what |
| // Teddy can support. Thus, the only way to get a Rabin-Karp searcher |
| // is to force it using undocumented APIs (for tests/benchmarks). |
| </span><span class="kw">let </span>(search_kind, minimum_len) = <span class="kw">match </span><span class="self">self</span>.config.force { |
| <span class="prelude-val">None </span>| <span class="prelude-val">Some</span>(ForceAlgorithm::Teddy) => { |
| <span class="macro">debug!</span>(<span class="string">"trying to build Teddy packed matcher"</span>); |
| <span class="kw">let </span>teddy = <span class="kw">match </span><span class="self">self</span>.build_teddy(<span class="kw-2">&</span>patterns) { |
| <span class="prelude-val">None </span>=> <span class="kw">return </span><span class="prelude-val">None</span>, |
| <span class="prelude-val">Some</span>(teddy) => teddy, |
| }; |
| <span class="kw">let </span>minimum_len = teddy.minimum_len(); |
| (SearchKind::Teddy(teddy), minimum_len) |
| } |
| <span class="prelude-val">Some</span>(ForceAlgorithm::RabinKarp) => { |
| <span class="macro">debug!</span>(<span class="string">"using Rabin-Karp packed matcher"</span>); |
| (SearchKind::RabinKarp, <span class="number">0</span>) |
| } |
| }; |
| <span class="prelude-val">Some</span>(Searcher { patterns, rabinkarp, search_kind, minimum_len }) |
| } |
| |
| <span class="kw">fn </span>build_teddy(<span class="kw-2">&</span><span class="self">self</span>, patterns: <span class="kw-2">&</span>Patterns) -> <span class="prelude-ty">Option</span><Teddy> { |
| teddy::Builder::new() |
| .avx(<span class="self">self</span>.config.force_avx) |
| .fat(<span class="self">self</span>.config.force_teddy_fat) |
| .build(<span class="kw-2">&</span>patterns) |
| } |
| |
| <span class="doccomment">/// Add the given pattern to this set to match. |
| /// |
| /// The order in which patterns are added is significant. Namely, when |
| /// using leftmost-first match semantics, then when multiple patterns can |
| /// match at a particular location, the pattern that was added first is |
| /// used as the match. |
| /// |
| /// If the number of patterns added exceeds the amount supported by packed |
| /// searchers, then the builder will stop accumulating patterns and render |
| /// itself inert. At this point, constructing a searcher will always return |
| /// `None`. |
| </span><span class="kw">pub fn </span>add<P: AsRef<[u8]>>(<span class="kw-2">&mut </span><span class="self">self</span>, pattern: P) -> <span class="kw-2">&mut </span>Builder { |
| <span class="kw">if </span><span class="self">self</span>.inert { |
| <span class="kw">return </span><span class="self">self</span>; |
| } <span class="kw">else if </span><span class="self">self</span>.patterns.len() >= PATTERN_LIMIT { |
| <span class="self">self</span>.inert = <span class="bool-val">true</span>; |
| <span class="self">self</span>.patterns.reset(); |
| <span class="kw">return </span><span class="self">self</span>; |
| } |
| <span class="comment">// Just in case PATTERN_LIMIT increases beyond u16::MAX. |
| </span><span class="macro">assert!</span>(<span class="self">self</span>.patterns.len() <= core::u16::MAX <span class="kw">as </span>usize); |
| |
| <span class="kw">let </span>pattern = pattern.as_ref(); |
| <span class="kw">if </span>pattern.is_empty() { |
| <span class="self">self</span>.inert = <span class="bool-val">true</span>; |
| <span class="self">self</span>.patterns.reset(); |
| <span class="kw">return </span><span class="self">self</span>; |
| } |
| <span class="self">self</span>.patterns.add(pattern); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Add the given iterator of patterns to this set to match. |
| /// |
| /// The iterator must yield elements that can be converted into a `&[u8]`. |
| /// |
| /// The order in which patterns are added is significant. Namely, when |
| /// using leftmost-first match semantics, then when multiple patterns can |
| /// match at a particular location, the pattern that was added first is |
| /// used as the match. |
| /// |
| /// If the number of patterns added exceeds the amount supported by packed |
| /// searchers, then the builder will stop accumulating patterns and render |
| /// itself inert. At this point, constructing a searcher will always return |
| /// `None`. |
| </span><span class="kw">pub fn </span>extend<I, P>(<span class="kw-2">&mut </span><span class="self">self</span>, patterns: I) -> <span class="kw-2">&mut </span>Builder |
| <span class="kw">where |
| </span>I: IntoIterator<Item = P>, |
| P: AsRef<[u8]>, |
| { |
| <span class="kw">for </span>p <span class="kw">in </span>patterns { |
| <span class="self">self</span>.add(p); |
| } |
| <span class="self">self |
| </span>} |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>Builder { |
| <span class="kw">fn </span>default() -> Builder { |
| Builder::new() |
| } |
| } |
| |
| <span class="doccomment">/// A packed searcher for quickly finding occurrences of multiple patterns. |
| /// |
| /// If callers need more flexible construction, or if one wants to change the |
| /// match semantics (either leftmost-first or leftmost-longest), then one can |
| /// use the [`Config`] and/or [`Builder`] types for more fine grained control. |
| /// |
| /// # Example |
| /// |
| /// This example shows how to create a searcher from an iterator of patterns. |
| /// By default, leftmost-first match semantics are used. |
| /// |
| /// ``` |
| /// use aho_corasick::{packed::{MatchKind, Searcher}, PatternID}; |
| /// |
| /// # fn example() -> Option<()> { |
| /// let searcher = Searcher::new(["foobar", "foo"].iter().cloned())?; |
| /// let matches: Vec<PatternID> = searcher |
| /// .find_iter("foobar") |
| /// .map(|mat| mat.pattern()) |
| /// .collect(); |
| /// assert_eq!(vec![PatternID::ZERO], matches); |
| /// # Some(()) } |
| /// # if cfg!(all(feature = "std", target_arch = "x86_64")) { |
| /// # example().unwrap() |
| /// # } else { |
| /// # assert!(example().is_none()); |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub struct </span>Searcher { |
| patterns: Patterns, |
| rabinkarp: RabinKarp, |
| search_kind: SearchKind, |
| minimum_len: usize, |
| } |
| |
| <span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">enum </span>SearchKind { |
| Teddy(Teddy), |
| RabinKarp, |
| } |
| |
| <span class="kw">impl </span>Searcher { |
| <span class="doccomment">/// A convenience function for constructing a searcher from an iterator |
| /// of things that can be converted to a `&[u8]`. |
| /// |
| /// If a searcher could not be constructed (either because of an |
| /// unsupported CPU or because there are too many patterns), then `None` |
| /// is returned. |
| /// |
| /// # Example |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use aho_corasick::{packed::{MatchKind, Searcher}, PatternID}; |
| /// |
| /// # fn example() -> Option<()> { |
| /// let searcher = Searcher::new(["foobar", "foo"].iter().cloned())?; |
| /// let matches: Vec<PatternID> = searcher |
| /// .find_iter("foobar") |
| /// .map(|mat| mat.pattern()) |
| /// .collect(); |
| /// assert_eq!(vec![PatternID::ZERO], matches); |
| /// # Some(()) } |
| /// # if cfg!(all(feature = "std", target_arch = "x86_64")) { |
| /// # example().unwrap() |
| /// # } else { |
| /// # assert!(example().is_none()); |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>new<I, P>(patterns: I) -> <span class="prelude-ty">Option</span><Searcher> |
| <span class="kw">where |
| </span>I: IntoIterator<Item = P>, |
| P: AsRef<[u8]>, |
| { |
| Builder::new().extend(patterns).build() |
| } |
| |
| <span class="doccomment">/// A convenience function for calling `Config::new()`. |
| /// |
| /// This is useful for avoiding an additional import. |
| </span><span class="kw">pub fn </span>config() -> Config { |
| Config::new() |
| } |
| |
| <span class="doccomment">/// A convenience function for calling `Builder::new()`. |
| /// |
| /// This is useful for avoiding an additional import. |
| </span><span class="kw">pub fn </span>builder() -> Builder { |
| Builder::new() |
| } |
| |
| <span class="doccomment">/// Return the first occurrence of any of the patterns in this searcher, |
| /// according to its match semantics, in the given haystack. The `Match` |
| /// returned will include the identifier of the pattern that matched, which |
| /// corresponds to the index of the pattern (starting from `0`) in which it |
| /// was added. |
| /// |
| /// # Example |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use aho_corasick::{packed::{MatchKind, Searcher}, PatternID}; |
| /// |
| /// # fn example() -> Option<()> { |
| /// let searcher = Searcher::new(["foobar", "foo"].iter().cloned())?; |
| /// let mat = searcher.find("foobar")?; |
| /// assert_eq!(PatternID::ZERO, mat.pattern()); |
| /// assert_eq!(0, mat.start()); |
| /// assert_eq!(6, mat.end()); |
| /// # Some(()) } |
| /// # if cfg!(all(feature = "std", target_arch = "x86_64")) { |
| /// # example().unwrap() |
| /// # } else { |
| /// # assert!(example().is_none()); |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>find<B: AsRef<[u8]>>(<span class="kw-2">&</span><span class="self">self</span>, haystack: B) -> <span class="prelude-ty">Option</span><Match> { |
| <span class="kw">let </span>haystack = haystack.as_ref(); |
| <span class="self">self</span>.find_in(haystack, Span::from(<span class="number">0</span>..haystack.len())) |
| } |
| |
| <span class="doccomment">/// Return the first occurrence of any of the patterns in this searcher, |
| /// according to its match semantics, in the given haystack starting from |
| /// the given position. |
| /// |
| /// The `Match` returned will include the identifier of the pattern that |
| /// matched, which corresponds to the index of the pattern (starting from |
| /// `0`) in which it was added. The offsets in the `Match` will be relative |
| /// to the start of `haystack` (and not `at`). |
| /// |
| /// # Example |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use aho_corasick::{packed::{MatchKind, Searcher}, PatternID, Span}; |
| /// |
| /// # fn example() -> Option<()> { |
| /// let haystack = "foofoobar"; |
| /// let searcher = Searcher::new(["foobar", "foo"].iter().cloned())?; |
| /// let mat = searcher.find_in(haystack, Span::from(3..haystack.len()))?; |
| /// assert_eq!(PatternID::ZERO, mat.pattern()); |
| /// assert_eq!(3, mat.start()); |
| /// assert_eq!(9, mat.end()); |
| /// # Some(()) } |
| /// # if cfg!(all(feature = "std", target_arch = "x86_64")) { |
| /// # example().unwrap() |
| /// # } else { |
| /// # assert!(example().is_none()); |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>find_in<B: AsRef<[u8]>>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| haystack: B, |
| span: Span, |
| ) -> <span class="prelude-ty">Option</span><Match> { |
| <span class="kw">let </span>haystack = haystack.as_ref(); |
| <span class="kw">match </span><span class="self">self</span>.search_kind { |
| SearchKind::Teddy(<span class="kw-2">ref </span>teddy) => { |
| <span class="kw">if </span>haystack[span].len() < teddy.minimum_len() { |
| <span class="kw">return </span><span class="self">self</span>.find_in_slow(haystack, span); |
| } |
| teddy.find_at( |
| <span class="kw-2">&</span><span class="self">self</span>.patterns, |
| <span class="kw-2">&</span>haystack[..span.end], |
| span.start, |
| ) |
| } |
| SearchKind::RabinKarp => <span class="self">self</span>.rabinkarp.find_at( |
| <span class="kw-2">&</span><span class="self">self</span>.patterns, |
| <span class="kw-2">&</span>haystack[..span.end], |
| span.start, |
| ), |
| } |
| } |
| |
| <span class="doccomment">/// Return an iterator of non-overlapping occurrences of the patterns in |
| /// this searcher, according to its match semantics, in the given haystack. |
| /// |
| /// # Example |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use aho_corasick::{packed::{MatchKind, Searcher}, PatternID}; |
| /// |
| /// # fn example() -> Option<()> { |
| /// let searcher = Searcher::new(["foobar", "foo"].iter().cloned())?; |
| /// let matches: Vec<PatternID> = searcher |
| /// .find_iter("foobar fooba foofoo") |
| /// .map(|mat| mat.pattern()) |
| /// .collect(); |
| /// assert_eq!(vec![ |
| /// PatternID::must(0), |
| /// PatternID::must(1), |
| /// PatternID::must(1), |
| /// PatternID::must(1), |
| /// ], matches); |
| /// # Some(()) } |
| /// # if cfg!(all(feature = "std", target_arch = "x86_64")) { |
| /// # example().unwrap() |
| /// # } else { |
| /// # assert!(example().is_none()); |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>find_iter<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>, B: <span class="question-mark">?</span>Sized + AsRef<[u8]>>( |
| <span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, |
| haystack: <span class="kw-2">&</span><span class="lifetime">'b </span>B, |
| ) -> FindIter<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> { |
| <span class="kw">let </span>haystack = haystack.as_ref(); |
| <span class="kw">let </span>span = Span::from(<span class="number">0</span>..haystack.len()); |
| FindIter { searcher: <span class="self">self</span>, haystack, span } |
| } |
| |
| <span class="doccomment">/// Returns the match kind used by this packed searcher. |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use aho_corasick::packed::{MatchKind, Searcher}; |
| /// |
| /// # fn example() -> Option<()> { |
| /// let searcher = Searcher::new(["foobar", "foo"].iter().cloned())?; |
| /// // leftmost-first is the default. |
| /// assert_eq!(&MatchKind::LeftmostFirst, searcher.match_kind()); |
| /// # Some(()) } |
| /// # if cfg!(all(feature = "std", target_arch = "x86_64")) { |
| /// # example().unwrap() |
| /// # } else { |
| /// # assert!(example().is_none()); |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>match_kind(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>MatchKind { |
| <span class="self">self</span>.patterns.match_kind() |
| } |
| |
| <span class="doccomment">/// Returns the minimum length of a haystack that is required in order for |
| /// packed searching to be effective. |
| /// |
| /// In some cases, the underlying packed searcher may not be able to search |
| /// very short haystacks. When that occurs, the implementation will defer |
| /// to a slower non-packed searcher (which is still generally faster than |
| /// Aho-Corasick for a small number of patterns). However, callers may |
| /// want to avoid ever using the slower variant, which one can do by |
| /// never passing a haystack shorter than the minimum length returned by |
| /// this method. |
| </span><span class="kw">pub fn </span>minimum_len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.minimum_len |
| } |
| |
| <span class="doccomment">/// Returns the approximate total amount of heap used by this searcher, in |
| /// units of bytes. |
| </span><span class="kw">pub fn </span>memory_usage(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.patterns.memory_usage() |
| + <span class="self">self</span>.rabinkarp.memory_usage() |
| + <span class="self">self</span>.search_kind.memory_usage() |
| } |
| |
| <span class="doccomment">/// Use a slow (non-packed) searcher. |
| /// |
| /// This is useful when a packed searcher could be constructed, but could |
| /// not be used to search a specific haystack. For example, if Teddy was |
| /// built but the haystack is smaller than ~34 bytes, then Teddy might not |
| /// be able to run. |
| </span><span class="kw">fn </span>find_in_slow(<span class="kw-2">&</span><span class="self">self</span>, haystack: <span class="kw-2">&</span>[u8], span: Span) -> <span class="prelude-ty">Option</span><Match> { |
| <span class="self">self</span>.rabinkarp.find_at( |
| <span class="kw-2">&</span><span class="self">self</span>.patterns, |
| <span class="kw-2">&</span>haystack[..span.end], |
| span.start, |
| ) |
| } |
| } |
| |
| <span class="kw">impl </span>SearchKind { |
| <span class="kw">fn </span>memory_usage(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| SearchKind::Teddy(<span class="kw-2">ref </span>ted) => ted.memory_usage(), |
| SearchKind::RabinKarp => <span class="number">0</span>, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// An iterator over non-overlapping matches from a packed searcher. |
| /// |
| /// The lifetime `'s` refers to the lifetime of the underlying [`Searcher`], |
| /// while the lifetime `'h` refers to the lifetime of the haystack being |
| /// searched. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>FindIter<<span class="lifetime">'s</span>, <span class="lifetime">'h</span>> { |
| searcher: <span class="kw-2">&</span><span class="lifetime">'s </span>Searcher, |
| haystack: <span class="kw-2">&</span><span class="lifetime">'h </span>[u8], |
| span: Span, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'s</span>, <span class="lifetime">'h</span>> Iterator <span class="kw">for </span>FindIter<<span class="lifetime">'s</span>, <span class="lifetime">'h</span>> { |
| <span class="kw">type </span>Item = Match; |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Match> { |
| <span class="kw">if </span><span class="self">self</span>.span.start > <span class="self">self</span>.span.end { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| <span class="kw">match </span><span class="self">self</span>.searcher.find_in(<span class="kw-2">&</span><span class="self">self</span>.haystack, <span class="self">self</span>.span) { |
| <span class="prelude-val">None </span>=> <span class="prelude-val">None</span>, |
| <span class="prelude-val">Some</span>(m) => { |
| <span class="self">self</span>.span.start = m.end(); |
| <span class="prelude-val">Some</span>(m) |
| } |
| } |
| } |
| } |
| </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> |