| <!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/primitives.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>primitives.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> |
| </pre><pre class="rust"><code><span class="doccomment">/*! |
| Lower level primitive types that are useful in a variety of circumstances. |
| |
| # Overview |
| |
| This list represents the principle types in this module and briefly describes |
| when you might want to use them. |
| |
| * [`PatternID`] - A type that represents the identifier of a regex pattern. |
| This is probably the most widely used type in this module (which is why it's |
| also re-exported in the crate root). |
| * [`StateID`] - A type the represents the identifier of a finite automaton |
| state. This is used for both NFAs and DFAs, with the notable exception of |
| the hybrid NFA/DFA. (The hybrid NFA/DFA uses a special purpose "lazy" state |
| identifier.) |
| * [`SmallIndex`] - The internal representation of both a `PatternID` and a |
| `StateID`. Its purpose is to serve as a type that can index memory without |
| being as big as a `usize` on 64-bit targets. The main idea behind this type |
| is that there are many things in regex engines that will, in practice, never |
| overflow a 32-bit integer. (For example, like the number of patterns in a regex |
| or the number of states in an NFA.) Thus, a `SmallIndex` can be used to index |
| memory without peppering `as` casts everywhere. Moreover, it forces callers |
| to handle errors in the case where, somehow, the value would otherwise overflow |
| either a 32-bit integer or a `usize` (e.g., on 16-bit targets). |
| */ |
| |
| </span><span class="comment">// The macro we use to define some types below adds methods that we don't |
| // use on some of the types. There isn't much, so we just squash the warning. |
| </span><span class="attribute">#![allow(dead_code)] |
| |
| </span><span class="kw">use </span>alloc::vec::Vec; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::util::int::{Usize, U16, U32, U64}; |
| |
| <span class="doccomment">/// A type that represents a "small" index. |
| /// |
| /// The main idea of this type is to provide something that can index memory, |
| /// but uses less memory than `usize` on 64-bit systems. Specifically, its |
| /// representation is always a `u32` and has `repr(transparent)` enabled. (So |
| /// it is safe to transmute between a `u32` and a `SmallIndex`.) |
| /// |
| /// A small index is typically useful in cases where there is no practical way |
| /// that the index will overflow a 32-bit integer. A good example of this is |
| /// an NFA state. If you could somehow build an NFA with `2^30` states, its |
| /// memory usage would be exorbitant and its runtime execution would be so |
| /// slow as to be completely worthless. Therefore, this crate generally deems |
| /// it acceptable to return an error if it would otherwise build an NFA that |
| /// requires a slice longer than what a 32-bit integer can index. In exchange, |
| /// we can use 32-bit indices instead of 64-bit indices in various places. |
| /// |
| /// This type ensures this by providing a constructor that will return an error |
| /// if its argument cannot fit into the type. This makes it much easier to |
| /// handle these sorts of boundary cases that are otherwise extremely subtle. |
| /// |
| /// On all targets, this type guarantees that its value will fit in a `u32`, |
| /// `i32`, `usize` and an `isize`. This means that on 16-bit targets, for |
| /// example, this type's maximum value will never overflow an `isize`, |
| /// which means it will never overflow a `i16` even though its internal |
| /// representation is still a `u32`. |
| /// |
| /// The purpose for making the type fit into even signed integer types like |
| /// `isize` is to guarantee that the difference between any two small indices |
| /// is itself also a small index. This is useful in certain contexts, e.g., |
| /// for delta encoding. |
| /// |
| /// # Other types |
| /// |
| /// The following types wrap `SmallIndex` to provide a more focused use case: |
| /// |
| /// * [`PatternID`] is for representing the identifiers of patterns. |
| /// * [`StateID`] is for representing the identifiers of states in finite |
| /// automata. It is used for both NFAs and DFAs. |
| /// |
| /// # Representation |
| /// |
| /// This type is always represented internally by a `u32` and is marked as |
| /// `repr(transparent)`. Thus, this type always has the same representation as |
| /// a `u32`. It is thus safe to transmute between a `u32` and a `SmallIndex`. |
| /// |
| /// # Indexing |
| /// |
| /// For convenience, callers may use a `SmallIndex` to index slices. |
| /// |
| /// # Safety |
| /// |
| /// While a `SmallIndex` is meant to guarantee that its value fits into `usize` |
| /// without using as much space as a `usize` on all targets, callers must |
| /// not rely on this property for safety. Callers may choose to rely on this |
| /// property for correctness however. For example, creating a `SmallIndex` with |
| /// an invalid value can be done in entirely safe code. This may in turn result |
| /// in panics or silent logical errors. |
| </span><span class="attribute">#[derive( |
| Clone, Copy, Debug, Default, Eq, Hash, PartialEq, PartialOrd, Ord, |
| )] |
| #[repr(transparent)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>SmallIndex(u32); |
| |
| <span class="kw">impl </span>SmallIndex { |
| <span class="doccomment">/// The maximum index value. |
| </span><span class="attribute">#[cfg(any(target_pointer_width = <span class="string">"32"</span>, target_pointer_width = <span class="string">"64"</span>))] |
| </span><span class="kw">pub const </span>MAX: SmallIndex = |
| <span class="comment">// FIXME: Use as_usize() once const functions in traits are stable. |
| </span>SmallIndex::new_unchecked(core::i32::MAX <span class="kw">as </span>usize - <span class="number">1</span>); |
| |
| <span class="doccomment">/// The maximum index value. |
| </span><span class="attribute">#[cfg(target_pointer_width = <span class="string">"16"</span>)] |
| </span><span class="kw">pub const </span>MAX: SmallIndex = |
| SmallIndex::new_unchecked(core::isize::MAX - <span class="number">1</span>); |
| |
| <span class="doccomment">/// The total number of values that can be represented as a small index. |
| </span><span class="kw">pub const </span>LIMIT: usize = SmallIndex::MAX.as_usize() + <span class="number">1</span>; |
| |
| <span class="doccomment">/// The zero index value. |
| </span><span class="kw">pub const </span>ZERO: SmallIndex = SmallIndex::new_unchecked(<span class="number">0</span>); |
| |
| <span class="doccomment">/// The number of bytes that a single small index uses in memory. |
| </span><span class="kw">pub const </span>SIZE: usize = core::mem::size_of::<SmallIndex>(); |
| |
| <span class="doccomment">/// Create a new small index. |
| /// |
| /// If the given index exceeds [`SmallIndex::MAX`], then this returns |
| /// an error. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>new(index: usize) -> <span class="prelude-ty">Result</span><SmallIndex, SmallIndexError> { |
| SmallIndex::try_from(index) |
| } |
| |
| <span class="doccomment">/// Create a new small index without checking whether the given value |
| /// exceeds [`SmallIndex::MAX`]. |
| /// |
| /// Using this routine with an invalid index value will result in |
| /// unspecified behavior, but *not* undefined behavior. In particular, an |
| /// invalid index value is likely to cause panics or possibly even silent |
| /// logical errors. |
| /// |
| /// Callers must never rely on a `SmallIndex` to be within a certain range |
| /// for memory safety. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>new_unchecked(index: usize) -> SmallIndex { |
| <span class="comment">// FIXME: Use as_u32() once const functions in traits are stable. |
| </span>SmallIndex::from_u32_unchecked(index <span class="kw">as </span>u32) |
| } |
| |
| <span class="doccomment">/// Create a new small index from a `u32` without checking whether the |
| /// given value exceeds [`SmallIndex::MAX`]. |
| /// |
| /// Using this routine with an invalid index value will result in |
| /// unspecified behavior, but *not* undefined behavior. In particular, an |
| /// invalid index value is likely to cause panics or possibly even silent |
| /// logical errors. |
| /// |
| /// Callers must never rely on a `SmallIndex` to be within a certain range |
| /// for memory safety. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>from_u32_unchecked(index: u32) -> SmallIndex { |
| SmallIndex(index) |
| } |
| |
| <span class="doccomment">/// Like [`SmallIndex::new`], but panics if the given index is not valid. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>must(index: usize) -> SmallIndex { |
| SmallIndex::new(index).expect(<span class="string">"invalid small index"</span>) |
| } |
| |
| <span class="doccomment">/// Return this small index as a `usize`. This is guaranteed to never |
| /// overflow `usize`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>as_usize(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="comment">// FIXME: Use as_usize() once const functions in traits are stable. |
| </span><span class="self">self</span>.<span class="number">0 </span><span class="kw">as </span>usize |
| } |
| |
| <span class="doccomment">/// Return this small index as a `u64`. This is guaranteed to never |
| /// overflow. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>as_u64(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="comment">// FIXME: Use u64::from() once const functions in traits are stable. |
| </span><span class="self">self</span>.<span class="number">0 </span><span class="kw">as </span>u64 |
| } |
| |
| <span class="doccomment">/// Return the internal `u32` of this small index. This is guaranteed to |
| /// never overflow `u32`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>as_u32(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| <span class="self">self</span>.<span class="number">0 |
| </span>} |
| |
| <span class="doccomment">/// Return the internal `u32` of this small index represented as an `i32`. |
| /// This is guaranteed to never overflow an `i32`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>as_i32(<span class="kw-2">&</span><span class="self">self</span>) -> i32 { |
| <span class="comment">// This is OK because we guarantee that our max value is <= i32::MAX. |
| </span><span class="self">self</span>.<span class="number">0 </span><span class="kw">as </span>i32 |
| } |
| |
| <span class="doccomment">/// Returns one more than this small index as a usize. |
| /// |
| /// Since a small index has constraints on its maximum value, adding `1` to |
| /// it will always fit in a `usize`, `isize`, `u32` and a `i32`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>one_more(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.as_usize() + <span class="number">1 |
| </span>} |
| |
| <span class="doccomment">/// Decode this small index from the bytes given using the native endian |
| /// byte order for the current target. |
| /// |
| /// If the decoded integer is not representable as a small index for the |
| /// current target, then this returns an error. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>from_ne_bytes( |
| bytes: [u8; <span class="number">4</span>], |
| ) -> <span class="prelude-ty">Result</span><SmallIndex, SmallIndexError> { |
| <span class="kw">let </span>id = u32::from_ne_bytes(bytes); |
| <span class="kw">if </span>id > SmallIndex::MAX.as_u32() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(SmallIndexError { attempted: u64::from(id) }); |
| } |
| <span class="prelude-val">Ok</span>(SmallIndex::new_unchecked(id.as_usize())) |
| } |
| |
| <span class="doccomment">/// Decode this small index from the bytes given using the native endian |
| /// byte order for the current target. |
| /// |
| /// This is analogous to [`SmallIndex::new_unchecked`] in that is does not |
| /// check whether the decoded integer is representable as a small index. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>from_ne_bytes_unchecked(bytes: [u8; <span class="number">4</span>]) -> SmallIndex { |
| SmallIndex::new_unchecked(u32::from_ne_bytes(bytes).as_usize()) |
| } |
| |
| <span class="doccomment">/// Return the underlying small index integer as raw bytes in native endian |
| /// format. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>to_ne_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> [u8; <span class="number">4</span>] { |
| <span class="self">self</span>.<span class="number">0</span>.to_ne_bytes() |
| } |
| } |
| |
| <span class="kw">impl</span><T> core::ops::Index<SmallIndex> <span class="kw">for </span>[T] { |
| <span class="kw">type </span>Output = T; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>index(<span class="kw-2">&</span><span class="self">self</span>, index: SmallIndex) -> <span class="kw-2">&</span>T { |
| <span class="kw-2">&</span><span class="self">self</span>[index.as_usize()] |
| } |
| } |
| |
| <span class="kw">impl</span><T> core::ops::IndexMut<SmallIndex> <span class="kw">for </span>[T] { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>index_mut(<span class="kw-2">&mut </span><span class="self">self</span>, index: SmallIndex) -> <span class="kw-2">&mut </span>T { |
| <span class="kw-2">&mut </span><span class="self">self</span>[index.as_usize()] |
| } |
| } |
| |
| <span class="kw">impl</span><T> core::ops::Index<SmallIndex> <span class="kw">for </span>Vec<T> { |
| <span class="kw">type </span>Output = T; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>index(<span class="kw-2">&</span><span class="self">self</span>, index: SmallIndex) -> <span class="kw-2">&</span>T { |
| <span class="kw-2">&</span><span class="self">self</span>[index.as_usize()] |
| } |
| } |
| |
| <span class="kw">impl</span><T> core::ops::IndexMut<SmallIndex> <span class="kw">for </span>Vec<T> { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>index_mut(<span class="kw-2">&mut </span><span class="self">self</span>, index: SmallIndex) -> <span class="kw-2">&mut </span>T { |
| <span class="kw-2">&mut </span><span class="self">self</span>[index.as_usize()] |
| } |
| } |
| |
| <span class="kw">impl </span>From<StateID> <span class="kw">for </span>SmallIndex { |
| <span class="kw">fn </span>from(sid: StateID) -> SmallIndex { |
| sid.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">impl </span>From<PatternID> <span class="kw">for </span>SmallIndex { |
| <span class="kw">fn </span>from(pid: PatternID) -> SmallIndex { |
| pid.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">impl </span>From<u8> <span class="kw">for </span>SmallIndex { |
| <span class="kw">fn </span>from(index: u8) -> SmallIndex { |
| SmallIndex::new_unchecked(usize::from(index)) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<u16> <span class="kw">for </span>SmallIndex { |
| <span class="kw">type </span>Error = SmallIndexError; |
| |
| <span class="kw">fn </span>try_from(index: u16) -> <span class="prelude-ty">Result</span><SmallIndex, SmallIndexError> { |
| <span class="kw">if </span>u32::from(index) > SmallIndex::MAX.as_u32() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(SmallIndexError { attempted: u64::from(index) }); |
| } |
| <span class="prelude-val">Ok</span>(SmallIndex::new_unchecked(index.as_usize())) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<u32> <span class="kw">for </span>SmallIndex { |
| <span class="kw">type </span>Error = SmallIndexError; |
| |
| <span class="kw">fn </span>try_from(index: u32) -> <span class="prelude-ty">Result</span><SmallIndex, SmallIndexError> { |
| <span class="kw">if </span>index > SmallIndex::MAX.as_u32() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(SmallIndexError { attempted: u64::from(index) }); |
| } |
| <span class="prelude-val">Ok</span>(SmallIndex::new_unchecked(index.as_usize())) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<u64> <span class="kw">for </span>SmallIndex { |
| <span class="kw">type </span>Error = SmallIndexError; |
| |
| <span class="kw">fn </span>try_from(index: u64) -> <span class="prelude-ty">Result</span><SmallIndex, SmallIndexError> { |
| <span class="kw">if </span>index > SmallIndex::MAX.as_u64() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(SmallIndexError { attempted: index }); |
| } |
| <span class="prelude-val">Ok</span>(SmallIndex::new_unchecked(index.as_usize())) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<usize> <span class="kw">for </span>SmallIndex { |
| <span class="kw">type </span>Error = SmallIndexError; |
| |
| <span class="kw">fn </span>try_from(index: usize) -> <span class="prelude-ty">Result</span><SmallIndex, SmallIndexError> { |
| <span class="kw">if </span>index > SmallIndex::MAX.as_usize() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(SmallIndexError { attempted: index.as_u64() }); |
| } |
| <span class="prelude-val">Ok</span>(SmallIndex::new_unchecked(index)) |
| } |
| } |
| |
| <span class="doccomment">/// This error occurs when a small index could not be constructed. |
| /// |
| /// This occurs when given an integer exceeding the maximum small index value. |
| /// |
| /// When the `std` feature is enabled, this implements the `Error` trait. |
| </span><span class="attribute">#[derive(Clone, Debug, Eq, PartialEq)] |
| </span><span class="kw">pub struct </span>SmallIndexError { |
| attempted: u64, |
| } |
| |
| <span class="kw">impl </span>SmallIndexError { |
| <span class="doccomment">/// Returns the value that could not be converted to a small index. |
| </span><span class="kw">pub fn </span>attempted(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.attempted |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>SmallIndexError {} |
| |
| <span class="kw">impl </span>core::fmt::Display <span class="kw">for </span>SmallIndexError { |
| <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">"failed to create small index from {:?}, which exceeds {:?}"</span>, |
| <span class="self">self</span>.attempted(), |
| SmallIndex::MAX, |
| ) |
| } |
| } |
| |
| <span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>SmallIndexIter { |
| rng: core::ops::Range<usize>, |
| } |
| |
| <span class="kw">impl </span>Iterator <span class="kw">for </span>SmallIndexIter { |
| <span class="kw">type </span>Item = SmallIndex; |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><SmallIndex> { |
| <span class="kw">if </span><span class="self">self</span>.rng.start >= <span class="self">self</span>.rng.end { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| <span class="kw">let </span>next_id = <span class="self">self</span>.rng.start + <span class="number">1</span>; |
| <span class="kw">let </span>id = core::mem::replace(<span class="kw-2">&mut </span><span class="self">self</span>.rng.start, next_id); |
| <span class="comment">// new_unchecked is OK since we asserted that the number of |
| // elements in this iterator will fit in an ID at construction. |
| </span><span class="prelude-val">Some</span>(SmallIndex::new_unchecked(id)) |
| } |
| } |
| |
| <span class="macro">macro_rules! </span>index_type_impls { |
| (<span class="macro-nonterminal">$name</span>:ident, <span class="macro-nonterminal">$err</span>:ident, <span class="macro-nonterminal">$iter</span>:ident, <span class="macro-nonterminal">$withiter</span>:ident) => { |
| <span class="kw">impl </span><span class="macro-nonterminal">$name </span>{ |
| <span class="doccomment">/// The maximum value. |
| </span><span class="kw">pub const </span>MAX: <span class="macro-nonterminal">$name </span>= <span class="macro-nonterminal">$name</span>(SmallIndex::MAX); |
| |
| <span class="doccomment">/// The total number of values that can be represented. |
| </span><span class="kw">pub const </span>LIMIT: usize = SmallIndex::LIMIT; |
| |
| <span class="doccomment">/// The zero value. |
| </span><span class="kw">pub const </span>ZERO: <span class="macro-nonterminal">$name </span>= <span class="macro-nonterminal">$name</span>(SmallIndex::ZERO); |
| |
| <span class="doccomment">/// The number of bytes that a single value uses in memory. |
| </span><span class="kw">pub const </span>SIZE: usize = SmallIndex::SIZE; |
| |
| <span class="doccomment">/// Create a new value that is represented by a "small index." |
| /// |
| /// If the given index exceeds the maximum allowed value, then this |
| /// returns an error. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>new(value: usize) -> <span class="prelude-ty">Result</span><<span class="macro-nonterminal">$name</span>, <span class="macro-nonterminal">$err</span>> { |
| SmallIndex::new(value).map(<span class="macro-nonterminal">$name</span>).map_err(<span class="macro-nonterminal">$err</span>) |
| } |
| |
| <span class="doccomment">/// Create a new value without checking whether the given argument |
| /// exceeds the maximum. |
| /// |
| /// Using this routine with an invalid value will result in |
| /// unspecified behavior, but *not* undefined behavior. In |
| /// particular, an invalid ID value is likely to cause panics or |
| /// possibly even silent logical errors. |
| /// |
| /// Callers must never rely on this type to be within a certain |
| /// range for memory safety. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>new_unchecked(value: usize) -> <span class="macro-nonterminal">$name </span>{ |
| <span class="macro-nonterminal">$name</span>(SmallIndex::new_unchecked(value)) |
| } |
| |
| <span class="doccomment">/// Create a new value from a `u32` without checking whether the |
| /// given value exceeds the maximum. |
| /// |
| /// Using this routine with an invalid value will result in |
| /// unspecified behavior, but *not* undefined behavior. In |
| /// particular, an invalid ID value is likely to cause panics or |
| /// possibly even silent logical errors. |
| /// |
| /// Callers must never rely on this type to be within a certain |
| /// range for memory safety. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>from_u32_unchecked(index: u32) -> <span class="macro-nonterminal">$name </span>{ |
| <span class="macro-nonterminal">$name</span>(SmallIndex::from_u32_unchecked(index)) |
| } |
| |
| <span class="doccomment">/// Like `new`, but panics if the given value is not valid. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>must(value: usize) -> <span class="macro-nonterminal">$name </span>{ |
| <span class="macro-nonterminal">$name::new</span>(value).expect(<span class="macro">concat!</span>( |
| <span class="string">"invalid "</span>, |
| <span class="macro">stringify!</span>(<span class="macro-nonterminal">$name</span>), |
| <span class="string">" value" |
| </span>)) |
| } |
| |
| <span class="doccomment">/// Return the internal value as a `usize`. This is guaranteed to |
| /// never overflow `usize`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>as_usize(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.<span class="number">0</span>.as_usize() |
| } |
| |
| <span class="doccomment">/// Return the internal value as a `u64`. This is guaranteed to |
| /// never overflow. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>as_u64(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.<span class="number">0</span>.as_u64() |
| } |
| |
| <span class="doccomment">/// Return the internal value as a `u32`. This is guaranteed to |
| /// never overflow `u32`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>as_u32(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| <span class="self">self</span>.<span class="number">0</span>.as_u32() |
| } |
| |
| <span class="doccomment">/// Return the internal value as a `i32`. This is guaranteed to |
| /// never overflow an `i32`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>as_i32(<span class="kw-2">&</span><span class="self">self</span>) -> i32 { |
| <span class="self">self</span>.<span class="number">0</span>.as_i32() |
| } |
| |
| <span class="doccomment">/// Returns one more than this value as a usize. |
| /// |
| /// Since values represented by a "small index" have constraints |
| /// on their maximum value, adding `1` to it will always fit in a |
| /// `usize`, `u32` and a `i32`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>one_more(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.<span class="number">0</span>.one_more() |
| } |
| |
| <span class="doccomment">/// Decode this value from the bytes given using the native endian |
| /// byte order for the current target. |
| /// |
| /// If the decoded integer is not representable as a small index |
| /// for the current target, then this returns an error. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>from_ne_bytes(bytes: [u8; <span class="number">4</span>]) -> <span class="prelude-ty">Result</span><<span class="macro-nonterminal">$name</span>, <span class="macro-nonterminal">$err</span>> { |
| SmallIndex::from_ne_bytes(bytes).map(<span class="macro-nonterminal">$name</span>).map_err(<span class="macro-nonterminal">$err</span>) |
| } |
| |
| <span class="doccomment">/// Decode this value from the bytes given using the native endian |
| /// byte order for the current target. |
| /// |
| /// This is analogous to `new_unchecked` in that is does not check |
| /// whether the decoded integer is representable as a small index. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>from_ne_bytes_unchecked(bytes: [u8; <span class="number">4</span>]) -> <span class="macro-nonterminal">$name </span>{ |
| <span class="macro-nonterminal">$name</span>(SmallIndex::from_ne_bytes_unchecked(bytes)) |
| } |
| |
| <span class="doccomment">/// Return the underlying integer as raw bytes in native endian |
| /// format. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>to_ne_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> [u8; <span class="number">4</span>] { |
| <span class="self">self</span>.<span class="number">0</span>.to_ne_bytes() |
| } |
| |
| <span class="doccomment">/// Returns an iterator over all values from 0 up to and not |
| /// including the given length. |
| /// |
| /// If the given length exceeds this type's limit, then this |
| /// panics. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>iter(len: usize) -> <span class="macro-nonterminal">$iter </span>{ |
| <span class="macro-nonterminal">$iter::new</span>(len) |
| } |
| } |
| |
| <span class="comment">// We write our own Debug impl so that we get things like PatternID(5) |
| // instead of PatternID(SmallIndex(5)). |
| </span><span class="kw">impl </span>core::fmt::Debug <span class="kw">for </span><span class="macro-nonterminal">$name </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 { |
| f.debug_tuple(<span class="macro">stringify!</span>(<span class="macro-nonterminal">$name</span>)).field(<span class="kw-2">&</span><span class="self">self</span>.as_u32()).finish() |
| } |
| } |
| |
| <span class="kw">impl</span><T> core::ops::Index<<span class="macro-nonterminal">$name</span>> <span class="kw">for </span>[T] { |
| <span class="kw">type </span>Output = T; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>index(<span class="kw-2">&</span><span class="self">self</span>, index: <span class="macro-nonterminal">$name</span>) -> <span class="kw-2">&</span>T { |
| <span class="kw-2">&</span><span class="self">self</span>[index.as_usize()] |
| } |
| } |
| |
| <span class="kw">impl</span><T> core::ops::IndexMut<<span class="macro-nonterminal">$name</span>> <span class="kw">for </span>[T] { |
| <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 class="macro-nonterminal">$name</span>) -> <span class="kw-2">&mut </span>T { |
| <span class="kw-2">&mut </span><span class="self">self</span>[index.as_usize()] |
| } |
| } |
| |
| <span class="kw">impl</span><T> core::ops::Index<<span class="macro-nonterminal">$name</span>> <span class="kw">for </span>Vec<T> { |
| <span class="kw">type </span>Output = T; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>index(<span class="kw-2">&</span><span class="self">self</span>, index: <span class="macro-nonterminal">$name</span>) -> <span class="kw-2">&</span>T { |
| <span class="kw-2">&</span><span class="self">self</span>[index.as_usize()] |
| } |
| } |
| |
| <span class="kw">impl</span><T> core::ops::IndexMut<<span class="macro-nonterminal">$name</span>> <span class="kw">for </span>Vec<T> { |
| <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 class="macro-nonterminal">$name</span>) -> <span class="kw-2">&mut </span>T { |
| <span class="kw-2">&mut </span><span class="self">self</span>[index.as_usize()] |
| } |
| } |
| |
| <span class="kw">impl </span>From<SmallIndex> <span class="kw">for </span><span class="macro-nonterminal">$name </span>{ |
| <span class="kw">fn </span>from(index: SmallIndex) -> <span class="macro-nonterminal">$name </span>{ |
| <span class="macro-nonterminal">$name</span>(index) |
| } |
| } |
| |
| <span class="kw">impl </span>From<u8> <span class="kw">for </span><span class="macro-nonterminal">$name </span>{ |
| <span class="kw">fn </span>from(value: u8) -> <span class="macro-nonterminal">$name </span>{ |
| <span class="macro-nonterminal">$name</span>(SmallIndex::from(value)) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<u16> <span class="kw">for </span><span class="macro-nonterminal">$name </span>{ |
| <span class="kw">type </span>Error = <span class="macro-nonterminal">$err</span>; |
| |
| <span class="kw">fn </span>try_from(value: u16) -> <span class="prelude-ty">Result</span><<span class="macro-nonterminal">$name</span>, <span class="macro-nonterminal">$err</span>> { |
| SmallIndex::try_from(value).map(<span class="macro-nonterminal">$name</span>).map_err(<span class="macro-nonterminal">$err</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<u32> <span class="kw">for </span><span class="macro-nonterminal">$name </span>{ |
| <span class="kw">type </span>Error = <span class="macro-nonterminal">$err</span>; |
| |
| <span class="kw">fn </span>try_from(value: u32) -> <span class="prelude-ty">Result</span><<span class="macro-nonterminal">$name</span>, <span class="macro-nonterminal">$err</span>> { |
| SmallIndex::try_from(value).map(<span class="macro-nonterminal">$name</span>).map_err(<span class="macro-nonterminal">$err</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<u64> <span class="kw">for </span><span class="macro-nonterminal">$name </span>{ |
| <span class="kw">type </span>Error = <span class="macro-nonterminal">$err</span>; |
| |
| <span class="kw">fn </span>try_from(value: u64) -> <span class="prelude-ty">Result</span><<span class="macro-nonterminal">$name</span>, <span class="macro-nonterminal">$err</span>> { |
| SmallIndex::try_from(value).map(<span class="macro-nonterminal">$name</span>).map_err(<span class="macro-nonterminal">$err</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<usize> <span class="kw">for </span><span class="macro-nonterminal">$name </span>{ |
| <span class="kw">type </span>Error = <span class="macro-nonterminal">$err</span>; |
| |
| <span class="kw">fn </span>try_from(value: usize) -> <span class="prelude-ty">Result</span><<span class="macro-nonterminal">$name</span>, <span class="macro-nonterminal">$err</span>> { |
| SmallIndex::try_from(value).map(<span class="macro-nonterminal">$name</span>).map_err(<span class="macro-nonterminal">$err</span>) |
| } |
| } |
| |
| <span class="doccomment">/// This error occurs when an ID could not be constructed. |
| /// |
| /// This occurs when given an integer exceeding the maximum allowed |
| /// value. |
| /// |
| /// When the `std` feature is enabled, this implements the `Error` |
| /// trait. |
| </span><span class="attribute">#[derive(Clone, Debug, Eq, PartialEq)] |
| </span><span class="kw">pub struct </span><span class="macro-nonterminal">$err</span>(SmallIndexError); |
| |
| <span class="kw">impl </span><span class="macro-nonterminal">$err </span>{ |
| <span class="doccomment">/// Returns the value that could not be converted to an ID. |
| </span><span class="kw">pub fn </span>attempted(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.<span class="number">0</span>.attempted() |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>std::error::Error <span class="kw">for </span><span class="macro-nonterminal">$err </span>{} |
| |
| <span class="kw">impl </span>core::fmt::Display <span class="kw">for </span><span class="macro-nonterminal">$err </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">"failed to create {} from {:?}, which exceeds {:?}"</span>, |
| <span class="macro">stringify!</span>(<span class="macro-nonterminal">$name</span>), |
| <span class="self">self</span>.attempted(), |
| <span class="macro-nonterminal">$name::MAX</span>, |
| ) |
| } |
| } |
| |
| <span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span><span class="macro-nonterminal">$iter</span>(SmallIndexIter); |
| |
| <span class="kw">impl </span><span class="macro-nonterminal">$iter </span>{ |
| <span class="kw">fn </span>new(len: usize) -> <span class="macro-nonterminal">$iter </span>{ |
| <span class="macro">assert!</span>( |
| len <= <span class="macro-nonterminal">$name::LIMIT</span>, |
| <span class="string">"cannot create iterator for {} when number of \ |
| elements exceed {:?}"</span>, |
| <span class="macro">stringify!</span>(<span class="macro-nonterminal">$name</span>), |
| <span class="macro-nonterminal">$name::LIMIT</span>, |
| ); |
| <span class="macro-nonterminal">$iter</span>(SmallIndexIter { rng: <span class="number">0</span>..len }) |
| } |
| } |
| |
| <span class="kw">impl </span>Iterator <span class="kw">for </span><span class="macro-nonterminal">$iter </span>{ |
| <span class="kw">type </span>Item = <span class="macro-nonterminal">$name</span>; |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="macro-nonterminal">$name</span>> { |
| <span class="self">self</span>.<span class="number">0</span>.next().map(<span class="macro-nonterminal">$name</span>) |
| } |
| } |
| |
| <span class="doccomment">/// An iterator adapter that is like std::iter::Enumerate, but attaches |
| /// small index values instead. It requires `ExactSizeIterator`. At |
| /// construction, it ensures that the index of each element in the |
| /// iterator is representable in the corresponding small index type. |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span><span class="macro-nonterminal">$withiter</span><I> { |
| it: I, |
| ids: <span class="macro-nonterminal">$iter</span>, |
| } |
| |
| <span class="kw">impl</span><I: Iterator + ExactSizeIterator> <span class="macro-nonterminal">$withiter</span><I> { |
| <span class="kw">fn </span>new(it: I) -> <span class="macro-nonterminal">$withiter</span><I> { |
| <span class="kw">let </span>ids = <span class="macro-nonterminal">$name::iter</span>(it.len()); |
| <span class="macro-nonterminal">$withiter </span>{ it, ids } |
| } |
| } |
| |
| <span class="kw">impl</span><I: Iterator + ExactSizeIterator> Iterator <span class="kw">for </span><span class="macro-nonterminal">$withiter</span><I> { |
| <span class="kw">type </span>Item = (<span class="macro-nonterminal">$name</span>, I::Item); |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><(<span class="macro-nonterminal">$name</span>, I::Item)> { |
| <span class="kw">let </span>item = <span class="self">self</span>.it.next()<span class="question-mark">?</span>; |
| <span class="comment">// Number of elements in this iterator must match, according |
| // to contract of ExactSizeIterator. |
| </span><span class="kw">let </span>id = <span class="self">self</span>.ids.next().unwrap(); |
| <span class="prelude-val">Some</span>((id, item)) |
| } |
| } |
| }; |
| } |
| |
| <span class="doccomment">/// The identifier of a pattern in an Aho-Corasick automaton. |
| /// |
| /// It is represented by a `u32` even on 64-bit systems in order to conserve |
| /// space. Namely, on all targets, this type guarantees that its value will |
| /// fit in a `u32`, `i32`, `usize` and an `isize`. This means that on 16-bit |
| /// targets, for example, this type's maximum value will never overflow an |
| /// `isize`, which means it will never overflow a `i16` even though its |
| /// internal representation is still a `u32`. |
| /// |
| /// # Safety |
| /// |
| /// While a `PatternID` is meant to guarantee that its value fits into `usize` |
| /// without using as much space as a `usize` on all targets, callers must |
| /// not rely on this property for safety. Callers may choose to rely on this |
| /// property for correctness however. For example, creating a `StateID` with an |
| /// invalid value can be done in entirely safe code. This may in turn result in |
| /// panics or silent logical errors. |
| </span><span class="attribute">#[derive(Clone, Copy, Default, Eq, Hash, PartialEq, PartialOrd, Ord)] |
| #[repr(transparent)] |
| </span><span class="kw">pub struct </span>PatternID(SmallIndex); |
| |
| <span class="doccomment">/// The identifier of a finite automaton state. |
| /// |
| /// It is represented by a `u32` even on 64-bit systems in order to conserve |
| /// space. Namely, on all targets, this type guarantees that its value will |
| /// fit in a `u32`, `i32`, `usize` and an `isize`. This means that on 16-bit |
| /// targets, for example, this type's maximum value will never overflow an |
| /// `isize`, which means it will never overflow a `i16` even though its |
| /// internal representation is still a `u32`. |
| /// |
| /// # Safety |
| /// |
| /// While a `StateID` is meant to guarantee that its value fits into `usize` |
| /// without using as much space as a `usize` on all targets, callers must |
| /// not rely on this property for safety. Callers may choose to rely on this |
| /// property for correctness however. For example, creating a `StateID` with an |
| /// invalid value can be done in entirely safe code. This may in turn result in |
| /// panics or silent logical errors. |
| </span><span class="attribute">#[derive(Clone, Copy, Default, Eq, Hash, PartialEq, PartialOrd, Ord)] |
| #[repr(transparent)] |
| </span><span class="kw">pub struct </span>StateID(SmallIndex); |
| |
| <span class="macro">index_type_impls!</span>(PatternID, PatternIDError, PatternIDIter, WithPatternIDIter); |
| <span class="macro">index_type_impls!</span>(StateID, StateIDError, StateIDIter, WithStateIDIter); |
| |
| <span class="doccomment">/// A utility trait that defines a couple of adapters for making it convenient |
| /// to access indices as "small index" types. We require ExactSizeIterator so |
| /// that iterator construction can do a single check to make sure the index of |
| /// each element is representable by its small index type. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait </span>IteratorIndexExt: Iterator { |
| <span class="kw">fn </span>with_pattern_ids(<span class="self">self</span>) -> WithPatternIDIter<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized + ExactSizeIterator, |
| { |
| WithPatternIDIter::new(<span class="self">self</span>) |
| } |
| |
| <span class="kw">fn </span>with_state_ids(<span class="self">self</span>) -> WithStateIDIter<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized + ExactSizeIterator, |
| { |
| WithStateIDIter::new(<span class="self">self</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><I: Iterator> IteratorIndexExt <span class="kw">for </span>I {} |
| </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> |
