| <!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/tantivy-fst-0.4.0/src/map.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>map.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="../../tantivy_fst/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="../../tantivy_fst/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| <span id="634">634</span> |
| <span id="635">635</span> |
| <span id="636">636</span> |
| <span id="637">637</span> |
| <span id="638">638</span> |
| <span id="639">639</span> |
| <span id="640">640</span> |
| <span id="641">641</span> |
| <span id="642">642</span> |
| <span id="643">643</span> |
| <span id="644">644</span> |
| <span id="645">645</span> |
| <span id="646">646</span> |
| <span id="647">647</span> |
| <span id="648">648</span> |
| <span id="649">649</span> |
| <span id="650">650</span> |
| <span id="651">651</span> |
| <span id="652">652</span> |
| <span id="653">653</span> |
| <span id="654">654</span> |
| <span id="655">655</span> |
| <span id="656">656</span> |
| <span id="657">657</span> |
| <span id="658">658</span> |
| <span id="659">659</span> |
| <span id="660">660</span> |
| <span id="661">661</span> |
| <span id="662">662</span> |
| <span id="663">663</span> |
| <span id="664">664</span> |
| <span id="665">665</span> |
| <span id="666">666</span> |
| <span id="667">667</span> |
| <span id="668">668</span> |
| <span id="669">669</span> |
| <span id="670">670</span> |
| <span id="671">671</span> |
| <span id="672">672</span> |
| <span id="673">673</span> |
| <span id="674">674</span> |
| <span id="675">675</span> |
| <span id="676">676</span> |
| <span id="677">677</span> |
| <span id="678">678</span> |
| <span id="679">679</span> |
| <span id="680">680</span> |
| <span id="681">681</span> |
| <span id="682">682</span> |
| <span id="683">683</span> |
| <span id="684">684</span> |
| <span id="685">685</span> |
| <span id="686">686</span> |
| <span id="687">687</span> |
| <span id="688">688</span> |
| <span id="689">689</span> |
| <span id="690">690</span> |
| <span id="691">691</span> |
| <span id="692">692</span> |
| <span id="693">693</span> |
| <span id="694">694</span> |
| <span id="695">695</span> |
| <span id="696">696</span> |
| <span id="697">697</span> |
| <span id="698">698</span> |
| <span id="699">699</span> |
| <span id="700">700</span> |
| <span id="701">701</span> |
| <span id="702">702</span> |
| <span id="703">703</span> |
| <span id="704">704</span> |
| <span id="705">705</span> |
| <span id="706">706</span> |
| <span id="707">707</span> |
| <span id="708">708</span> |
| <span id="709">709</span> |
| <span id="710">710</span> |
| <span id="711">711</span> |
| <span id="712">712</span> |
| <span id="713">713</span> |
| <span id="714">714</span> |
| <span id="715">715</span> |
| <span id="716">716</span> |
| <span id="717">717</span> |
| <span id="718">718</span> |
| <span id="719">719</span> |
| <span id="720">720</span> |
| <span id="721">721</span> |
| <span id="722">722</span> |
| <span id="723">723</span> |
| <span id="724">724</span> |
| <span id="725">725</span> |
| <span id="726">726</span> |
| <span id="727">727</span> |
| <span id="728">728</span> |
| <span id="729">729</span> |
| <span id="730">730</span> |
| <span id="731">731</span> |
| <span id="732">732</span> |
| <span id="733">733</span> |
| <span id="734">734</span> |
| <span id="735">735</span> |
| <span id="736">736</span> |
| <span id="737">737</span> |
| <span id="738">738</span> |
| <span id="739">739</span> |
| <span id="740">740</span> |
| <span id="741">741</span> |
| <span id="742">742</span> |
| <span id="743">743</span> |
| <span id="744">744</span> |
| <span id="745">745</span> |
| <span id="746">746</span> |
| <span id="747">747</span> |
| <span id="748">748</span> |
| <span id="749">749</span> |
| <span id="750">750</span> |
| <span id="751">751</span> |
| <span id="752">752</span> |
| <span id="753">753</span> |
| <span id="754">754</span> |
| <span id="755">755</span> |
| <span id="756">756</span> |
| <span id="757">757</span> |
| <span id="758">758</span> |
| <span id="759">759</span> |
| <span id="760">760</span> |
| <span id="761">761</span> |
| <span id="762">762</span> |
| <span id="763">763</span> |
| <span id="764">764</span> |
| <span id="765">765</span> |
| <span id="766">766</span> |
| <span id="767">767</span> |
| <span id="768">768</span> |
| <span id="769">769</span> |
| <span id="770">770</span> |
| <span id="771">771</span> |
| <span id="772">772</span> |
| <span id="773">773</span> |
| <span id="774">774</span> |
| <span id="775">775</span> |
| <span id="776">776</span> |
| <span id="777">777</span> |
| <span id="778">778</span> |
| <span id="779">779</span> |
| <span id="780">780</span> |
| <span id="781">781</span> |
| <span id="782">782</span> |
| <span id="783">783</span> |
| <span id="784">784</span> |
| <span id="785">785</span> |
| <span id="786">786</span> |
| <span id="787">787</span> |
| <span id="788">788</span> |
| <span id="789">789</span> |
| <span id="790">790</span> |
| <span id="791">791</span> |
| <span id="792">792</span> |
| <span id="793">793</span> |
| <span id="794">794</span> |
| <span id="795">795</span> |
| <span id="796">796</span> |
| <span id="797">797</span> |
| <span id="798">798</span> |
| <span id="799">799</span> |
| <span id="800">800</span> |
| <span id="801">801</span> |
| <span id="802">802</span> |
| <span id="803">803</span> |
| <span id="804">804</span> |
| <span id="805">805</span> |
| <span id="806">806</span> |
| <span id="807">807</span> |
| <span id="808">808</span> |
| <span id="809">809</span> |
| <span id="810">810</span> |
| <span id="811">811</span> |
| <span id="812">812</span> |
| <span id="813">813</span> |
| <span id="814">814</span> |
| <span id="815">815</span> |
| <span id="816">816</span> |
| <span id="817">817</span> |
| <span id="818">818</span> |
| <span id="819">819</span> |
| <span id="820">820</span> |
| <span id="821">821</span> |
| <span id="822">822</span> |
| <span id="823">823</span> |
| <span id="824">824</span> |
| <span id="825">825</span> |
| <span id="826">826</span> |
| <span id="827">827</span> |
| <span id="828">828</span> |
| <span id="829">829</span> |
| <span id="830">830</span> |
| <span id="831">831</span> |
| <span id="832">832</span> |
| <span id="833">833</span> |
| <span id="834">834</span> |
| <span id="835">835</span> |
| <span id="836">836</span> |
| <span id="837">837</span> |
| <span id="838">838</span> |
| <span id="839">839</span> |
| <span id="840">840</span> |
| <span id="841">841</span> |
| <span id="842">842</span> |
| <span id="843">843</span> |
| <span id="844">844</span> |
| <span id="845">845</span> |
| <span id="846">846</span> |
| <span id="847">847</span> |
| <span id="848">848</span> |
| <span id="849">849</span> |
| <span id="850">850</span> |
| <span id="851">851</span> |
| <span id="852">852</span> |
| <span id="853">853</span> |
| <span id="854">854</span> |
| <span id="855">855</span> |
| <span id="856">856</span> |
| <span id="857">857</span> |
| <span id="858">858</span> |
| <span id="859">859</span> |
| <span id="860">860</span> |
| <span id="861">861</span> |
| <span id="862">862</span> |
| <span id="863">863</span> |
| <span id="864">864</span> |
| <span id="865">865</span> |
| <span id="866">866</span> |
| <span id="867">867</span> |
| <span id="868">868</span> |
| <span id="869">869</span> |
| <span id="870">870</span> |
| <span id="871">871</span> |
| <span id="872">872</span> |
| <span id="873">873</span> |
| <span id="874">874</span> |
| <span id="875">875</span> |
| <span id="876">876</span> |
| <span id="877">877</span> |
| <span id="878">878</span> |
| <span id="879">879</span> |
| <span id="880">880</span> |
| <span id="881">881</span> |
| <span id="882">882</span> |
| <span id="883">883</span> |
| <span id="884">884</span> |
| <span id="885">885</span> |
| <span id="886">886</span> |
| <span id="887">887</span> |
| <span id="888">888</span> |
| <span id="889">889</span> |
| <span id="890">890</span> |
| <span id="891">891</span> |
| <span id="892">892</span> |
| <span id="893">893</span> |
| <span id="894">894</span> |
| <span id="895">895</span> |
| <span id="896">896</span> |
| <span id="897">897</span> |
| <span id="898">898</span> |
| <span id="899">899</span> |
| <span id="900">900</span> |
| <span id="901">901</span> |
| <span id="902">902</span> |
| <span id="903">903</span> |
| <span id="904">904</span> |
| <span id="905">905</span> |
| <span id="906">906</span> |
| <span id="907">907</span> |
| <span id="908">908</span> |
| <span id="909">909</span> |
| <span id="910">910</span> |
| <span id="911">911</span> |
| <span id="912">912</span> |
| <span id="913">913</span> |
| <span id="914">914</span> |
| <span id="915">915</span> |
| <span id="916">916</span> |
| <span id="917">917</span> |
| <span id="918">918</span> |
| <span id="919">919</span> |
| <span id="920">920</span> |
| <span id="921">921</span> |
| <span id="922">922</span> |
| <span id="923">923</span> |
| <span id="924">924</span> |
| <span id="925">925</span> |
| <span id="926">926</span> |
| <span id="927">927</span> |
| <span id="928">928</span> |
| <span id="929">929</span> |
| <span id="930">930</span> |
| <span id="931">931</span> |
| <span id="932">932</span> |
| <span id="933">933</span> |
| <span id="934">934</span> |
| <span id="935">935</span> |
| <span id="936">936</span> |
| <span id="937">937</span> |
| <span id="938">938</span> |
| <span id="939">939</span> |
| <span id="940">940</span> |
| <span id="941">941</span> |
| <span id="942">942</span> |
| <span id="943">943</span> |
| <span id="944">944</span> |
| <span id="945">945</span> |
| <span id="946">946</span> |
| <span id="947">947</span> |
| <span id="948">948</span> |
| <span id="949">949</span> |
| <span id="950">950</span> |
| <span id="951">951</span> |
| <span id="952">952</span> |
| <span id="953">953</span> |
| <span id="954">954</span> |
| <span id="955">955</span> |
| <span id="956">956</span> |
| <span id="957">957</span> |
| <span id="958">958</span> |
| <span id="959">959</span> |
| <span id="960">960</span> |
| <span id="961">961</span> |
| <span id="962">962</span> |
| <span id="963">963</span> |
| <span id="964">964</span> |
| <span id="965">965</span> |
| <span id="966">966</span> |
| <span id="967">967</span> |
| <span id="968">968</span> |
| <span id="969">969</span> |
| <span id="970">970</span> |
| <span id="971">971</span> |
| <span id="972">972</span> |
| <span id="973">973</span> |
| <span id="974">974</span> |
| <span id="975">975</span> |
| <span id="976">976</span> |
| <span id="977">977</span> |
| <span id="978">978</span> |
| <span id="979">979</span> |
| <span id="980">980</span> |
| <span id="981">981</span> |
| <span id="982">982</span> |
| <span id="983">983</span> |
| <span id="984">984</span> |
| <span id="985">985</span> |
| <span id="986">986</span> |
| <span id="987">987</span> |
| <span id="988">988</span> |
| <span id="989">989</span> |
| <span id="990">990</span> |
| <span id="991">991</span> |
| <span id="992">992</span> |
| <span id="993">993</span> |
| <span id="994">994</span> |
| <span id="995">995</span> |
| <span id="996">996</span> |
| <span id="997">997</span> |
| <span id="998">998</span> |
| <span id="999">999</span> |
| <span id="1000">1000</span> |
| <span id="1001">1001</span> |
| <span id="1002">1002</span> |
| <span id="1003">1003</span> |
| <span id="1004">1004</span> |
| <span id="1005">1005</span> |
| <span id="1006">1006</span> |
| <span id="1007">1007</span> |
| <span id="1008">1008</span> |
| <span id="1009">1009</span> |
| <span id="1010">1010</span> |
| <span id="1011">1011</span> |
| <span id="1012">1012</span> |
| <span id="1013">1013</span> |
| <span id="1014">1014</span> |
| <span id="1015">1015</span> |
| <span id="1016">1016</span> |
| <span id="1017">1017</span> |
| <span id="1018">1018</span> |
| <span id="1019">1019</span> |
| <span id="1020">1020</span> |
| <span id="1021">1021</span> |
| <span id="1022">1022</span> |
| <span id="1023">1023</span> |
| <span id="1024">1024</span> |
| <span id="1025">1025</span> |
| <span id="1026">1026</span> |
| <span id="1027">1027</span> |
| <span id="1028">1028</span> |
| <span id="1029">1029</span> |
| <span id="1030">1030</span> |
| <span id="1031">1031</span> |
| <span id="1032">1032</span> |
| <span id="1033">1033</span> |
| <span id="1034">1034</span> |
| <span id="1035">1035</span> |
| <span id="1036">1036</span> |
| <span id="1037">1037</span> |
| <span id="1038">1038</span> |
| <span id="1039">1039</span> |
| <span id="1040">1040</span> |
| <span id="1041">1041</span> |
| <span id="1042">1042</span> |
| <span id="1043">1043</span> |
| <span id="1044">1044</span> |
| <span id="1045">1045</span> |
| <span id="1046">1046</span> |
| <span id="1047">1047</span> |
| <span id="1048">1048</span> |
| <span id="1049">1049</span> |
| <span id="1050">1050</span> |
| <span id="1051">1051</span> |
| <span id="1052">1052</span> |
| <span id="1053">1053</span> |
| <span id="1054">1054</span> |
| <span id="1055">1055</span> |
| <span id="1056">1056</span> |
| <span id="1057">1057</span> |
| <span id="1058">1058</span> |
| <span id="1059">1059</span> |
| <span id="1060">1060</span> |
| <span id="1061">1061</span> |
| <span id="1062">1062</span> |
| <span id="1063">1063</span> |
| <span id="1064">1064</span> |
| <span id="1065">1065</span> |
| <span id="1066">1066</span> |
| <span id="1067">1067</span> |
| <span id="1068">1068</span> |
| <span id="1069">1069</span> |
| <span id="1070">1070</span> |
| <span id="1071">1071</span> |
| <span id="1072">1072</span> |
| <span id="1073">1073</span> |
| <span id="1074">1074</span> |
| <span id="1075">1075</span> |
| <span id="1076">1076</span> |
| <span id="1077">1077</span> |
| <span id="1078">1078</span> |
| <span id="1079">1079</span> |
| <span id="1080">1080</span> |
| <span id="1081">1081</span> |
| <span id="1082">1082</span> |
| <span id="1083">1083</span> |
| <span id="1084">1084</span> |
| <span id="1085">1085</span> |
| <span id="1086">1086</span> |
| <span id="1087">1087</span> |
| <span id="1088">1088</span> |
| <span id="1089">1089</span> |
| <span id="1090">1090</span> |
| <span id="1091">1091</span> |
| <span id="1092">1092</span> |
| <span id="1093">1093</span> |
| <span id="1094">1094</span> |
| <span id="1095">1095</span> |
| <span id="1096">1096</span> |
| <span id="1097">1097</span> |
| <span id="1098">1098</span> |
| <span id="1099">1099</span> |
| <span id="1100">1100</span> |
| <span id="1101">1101</span> |
| <span id="1102">1102</span> |
| <span id="1103">1103</span> |
| <span id="1104">1104</span> |
| <span id="1105">1105</span> |
| <span id="1106">1106</span> |
| <span id="1107">1107</span> |
| <span id="1108">1108</span> |
| <span id="1109">1109</span> |
| <span id="1110">1110</span> |
| <span id="1111">1111</span> |
| <span id="1112">1112</span> |
| <span id="1113">1113</span> |
| <span id="1114">1114</span> |
| <span id="1115">1115</span> |
| <span id="1116">1116</span> |
| <span id="1117">1117</span> |
| <span id="1118">1118</span> |
| <span id="1119">1119</span> |
| <span id="1120">1120</span> |
| <span id="1121">1121</span> |
| <span id="1122">1122</span> |
| <span id="1123">1123</span> |
| <span id="1124">1124</span> |
| <span id="1125">1125</span> |
| <span id="1126">1126</span> |
| <span id="1127">1127</span> |
| <span id="1128">1128</span> |
| <span id="1129">1129</span> |
| <span id="1130">1130</span> |
| <span id="1131">1131</span> |
| <span id="1132">1132</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::iter::FromIterator; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::automaton::{AlwaysMatch, Automaton}; |
| <span class="kw">use </span><span class="kw">crate</span>::raw; |
| <span class="kw">pub use </span><span class="kw">crate</span>::raw::IndexedValue; |
| <span class="kw">use </span><span class="kw">crate</span>::raw::Output; |
| <span class="kw">use </span><span class="kw">crate</span>::stream::{IntoStreamer, Streamer}; |
| <span class="kw">use </span><span class="kw">crate</span>::Result; |
| <span class="kw">use </span>std::ops::Deref; |
| |
| <span class="doccomment">/// Map is a lexicographically ordered map from byte strings to integers. |
| /// |
| /// A `Map` is constructed with the `MapBuilder` type. Alternatively, a `Map` |
| /// can be constructed in memory from a lexicographically ordered iterator |
| /// of key-value pairs (`Map::from_iter`). |
| /// |
| /// A key feature of `Map` is that it can be serialized to disk compactly. Its |
| /// underlying representation is built such that the `Map` can be memory mapped |
| /// (`Map::from_path`) and searched without necessarily loading the entire |
| /// map into memory. |
| /// |
| /// It supports most common operations associated with maps, such as key |
| /// lookup and search. It also supports set operations on its keys along with |
| /// the ability to specify how conflicting values are merged together. Maps |
| /// also support range queries and automata based searches (e.g. a regular |
| /// expression). |
| /// |
| /// Maps are represented by a finite state transducer where inputs are the keys |
| /// and outputs are the values. As such, maps have the following invariants: |
| /// |
| /// 1. Once constructed, a `Map` can never be modified. |
| /// 2. Maps must be constructed with lexicographically ordered byte sequences. |
| /// There is no restricting on the ordering of values. |
| /// |
| /// # Differences with sets |
| /// |
| /// Maps and sets are represented by the same underlying data structure: the |
| /// finite state transducer. The principal difference between them is that |
| /// sets always have their output values set to `0`. This has an impact on the |
| /// representation size and is reflected in the type system for convenience. |
| /// A secondary but subtle difference is that duplicate values can be added |
| /// to a set, but it is an error to do so with maps. That is, a set can have |
| /// the same key added sequentially, but a map can't. |
| /// |
| /// # The future |
| /// |
| /// It is regrettable that the output value is fixed to `u64`. Indeed, it is |
| /// not necessary, but it was a major simplification in the implementation. |
| /// In the future, the value type may become generic to an extent (outputs must |
| /// satisfy a basic algebra). |
| /// |
| /// Keys will always be byte strings; however, we may grow more conveniences |
| /// around dealing with them (such as a serialization/deserialization step, |
| /// although it isn't clear where exactly this should live). |
| </span><span class="kw">pub struct </span>Map<Data>(raw::Fst<Data>); |
| |
| <span class="kw">impl </span>Map<Vec<u8>> { |
| <span class="doccomment">/// Creates a map from its representation as a raw byte sequence. |
| /// |
| /// Note that this operation is very cheap (no allocations and no copies). |
| /// |
| /// The map must have been written with a compatible finite state |
| /// transducer builder (`MapBuilder` qualifies). If the format is invalid |
| /// or if there is a mismatch between the API version of this library |
| /// and the map, then an error is returned. |
| </span><span class="kw">pub fn </span>from_bytes(bytes: Vec<u8>) -> <span class="prelude-ty">Result</span><Map<Vec<u8>>> { |
| raw::Fst::new(bytes).map(Map) |
| } |
| |
| <span class="doccomment">/// Create a `Map` from an iterator of lexicographically ordered byte |
| /// strings and associated values. |
| /// |
| /// If the iterator does not yield unique keys in lexicographic order, then |
| /// an error is returned. |
| /// |
| /// Note that this is a convenience function to build a map in memory. |
| /// To build a map that streams to an arbitrary `io::Write`, use |
| /// `MapBuilder`. |
| </span><span class="kw">pub fn </span>from_iter<K, I>(iter: I) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>> |
| <span class="kw">where |
| </span>K: AsRef<[u8]>, |
| I: IntoIterator<Item = (K, u64)>, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>builder = MapBuilder::memory(); |
| builder.extend_iter(iter)<span class="question-mark">?</span>; |
| Map::from_bytes(builder.into_inner()<span class="question-mark">?</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><Data: Deref<Target = [u8]>> Map<Data> { |
| <span class="doccomment">/// Tests the membership of a single key. |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tantivy_fst::Map; |
| /// |
| /// let map = Map::from_iter(vec![("a", 1), ("b", 2), ("c", 3)]).unwrap(); |
| /// |
| /// assert_eq!(map.contains_key("b"), true); |
| /// assert_eq!(map.contains_key("z"), false); |
| /// ``` |
| </span><span class="kw">pub fn </span>contains_key<K: AsRef<[u8]>>(<span class="kw-2">&</span><span class="self">self</span>, key: K) -> bool { |
| <span class="self">self</span>.<span class="number">0</span>.contains_key(key) |
| } |
| |
| <span class="doccomment">/// Retrieves the value associated with a key. |
| /// |
| /// If the key does not exist, then `None` is returned. |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tantivy_fst::Map; |
| /// |
| /// let map = Map::from_iter(vec![("a", 1), ("b", 2), ("c", 3)]).unwrap(); |
| /// |
| /// assert_eq!(map.get("b"), Some(2)); |
| /// assert_eq!(map.get("z"), None); |
| /// ``` |
| </span><span class="kw">pub fn </span>get<K: AsRef<[u8]>>(<span class="kw-2">&</span><span class="self">self</span>, key: K) -> <span class="prelude-ty">Option</span><u64> { |
| <span class="self">self</span>.<span class="number">0</span>.get(key).map(|output| output.value()) |
| } |
| |
| <span class="doccomment">/// Return a lexicographically ordered stream of all key-value pairs in |
| /// this map. |
| /// |
| /// While this is a stream, it does require heap space proportional to the |
| /// longest key in the map. |
| /// |
| /// If the map is memory mapped, then no further heap space is needed. |
| /// Note though that your operating system may fill your page cache |
| /// (which will cause the resident memory usage of the process to go up |
| /// correspondingly). |
| /// |
| /// # Example |
| /// |
| /// Since streams are not iterators, the traditional `for` loop cannot be |
| /// used. `while let` is useful instead: |
| /// |
| /// ```rust |
| /// use tantivy_fst::{IntoStreamer, Streamer, Map}; |
| /// |
| /// let map = Map::from_iter(vec![("a", 1), ("b", 2), ("c", 3)]).unwrap(); |
| /// let mut stream = map.stream(); |
| /// |
| /// let mut kvs = vec![]; |
| /// while let Some((k, v)) = stream.next() { |
| /// kvs.push((k.to_vec(), v)); |
| /// } |
| /// assert_eq!(kvs, vec![ |
| /// (b"a".to_vec(), 1), |
| /// (b"b".to_vec(), 2), |
| /// (b"c".to_vec(), 3), |
| /// ]); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>stream(<span class="kw-2">&</span><span class="self">self</span>) -> Stream { |
| Stream(<span class="self">self</span>.<span class="number">0</span>.stream()) |
| } |
| |
| <span class="doccomment">/// Return a lexicographically ordered stream of all keys in this map. |
| /// |
| /// Memory requirements are the same as described on `Map::stream`. |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tantivy_fst::{IntoStreamer, Streamer, Map}; |
| /// |
| /// let map = Map::from_iter(vec![("a", 1), ("b", 2), ("c", 3)]).unwrap(); |
| /// let mut stream = map.keys(); |
| /// |
| /// let mut keys = vec![]; |
| /// while let Some(k) = stream.next() { |
| /// keys.push(k.to_vec()); |
| /// } |
| /// assert_eq!(keys, vec![b"a", b"b", b"c"]); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>keys(<span class="kw-2">&</span><span class="self">self</span>) -> Keys { |
| Keys(<span class="self">self</span>.<span class="number">0</span>.stream()) |
| } |
| |
| <span class="doccomment">/// Return a stream of all values in this map ordered lexicographically |
| /// by each value's corresponding key. |
| /// |
| /// Memory requirements are the same as described on `Map::stream`. |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tantivy_fst::{IntoStreamer, Streamer, Map}; |
| /// |
| /// let map = Map::from_iter(vec![("a", 1), ("b", 2), ("c", 3)]).unwrap(); |
| /// let mut stream = map.values(); |
| /// |
| /// let mut values = vec![]; |
| /// while let Some(v) = stream.next() { |
| /// values.push(v); |
| /// } |
| /// assert_eq!(values, vec![1, 2, 3]); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>values(<span class="kw-2">&</span><span class="self">self</span>) -> Values { |
| Values(<span class="self">self</span>.<span class="number">0</span>.stream()) |
| } |
| |
| <span class="doccomment">/// Return a builder for range queries. |
| /// |
| /// A range query returns a subset of key-value pairs in this map in a |
| /// range given in lexicographic order. |
| /// |
| /// Memory requirements are the same as described on `Map::stream`. |
| /// Notably, only the keys in the range are read; keys outside the range |
| /// are not. |
| /// |
| /// # Example |
| /// |
| /// Returns only the key-value pairs in the range given. |
| /// |
| /// ```rust |
| /// use tantivy_fst::{IntoStreamer, Streamer, Map}; |
| /// |
| /// let map = Map::from_iter(vec![ |
| /// ("a", 1), ("b", 2), ("c", 3), ("d", 4), ("e", 5), |
| /// ]).unwrap(); |
| /// let mut stream = map.range().ge("b").lt("e").into_stream(); |
| /// |
| /// let mut kvs = vec![]; |
| /// while let Some((k, v)) = stream.next() { |
| /// kvs.push((k.to_vec(), v)); |
| /// } |
| /// assert_eq!(kvs, vec![ |
| /// (b"b".to_vec(), 2), |
| /// (b"c".to_vec(), 3), |
| /// (b"d".to_vec(), 4), |
| /// ]); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>range(<span class="kw-2">&</span><span class="self">self</span>) -> StreamBuilder { |
| StreamBuilder(<span class="self">self</span>.<span class="number">0</span>.range()) |
| } |
| |
| <span class="doccomment">/// Executes an automaton on the keys of this map. |
| /// |
| /// Note that this returns a `StreamBuilder`, which can be used to |
| /// add a range query to the search (see the `range` method). |
| /// |
| /// Memory requirements are the same as described on `Map::stream`. |
| /// |
| /// # Example |
| /// |
| /// An implementation of regular expressions for `Automaton` is available |
| /// in the `fst-regex` crate, which can be used to search maps. |
| /// |
| /// ```rust |
| /// |
| /// use std::error::Error; |
| /// |
| /// use tantivy_fst::{IntoStreamer, Streamer, Map}; |
| /// use tantivy_fst::Regex; |
| /// |
| /// fn example() -> Result<(), Box<Error>> { |
| /// let map = Map::from_iter(vec![ |
| /// ("foo", 1), ("foo1", 2), ("foo2", 3), ("foo3", 4), ("foobar", 5), |
| /// ]).unwrap(); |
| /// |
| /// let re = Regex::new("f[a-z]+3?").unwrap(); |
| /// let mut stream = map.search(&re).into_stream(); |
| /// |
| /// let mut kvs = vec![]; |
| /// while let Some((k, v)) = stream.next() { |
| /// kvs.push((k.to_vec(), v)); |
| /// } |
| /// assert_eq!(kvs, vec![ |
| /// (b"foo".to_vec(), 1), |
| /// (b"foo3".to_vec(), 4), |
| /// (b"foobar".to_vec(), 5), |
| /// ]); |
| /// |
| /// Ok(()) |
| /// } |
| /// |
| /// # assert!(example().is_ok()); |
| /// ``` |
| </span><span class="kw">pub fn </span>search<A: Automaton>(<span class="kw-2">&</span><span class="self">self</span>, aut: A) -> StreamBuilder<A> { |
| StreamBuilder(<span class="self">self</span>.<span class="number">0</span>.search(aut)) |
| } |
| |
| <span class="doccomment">/// Returns the number of elements in this map. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.<span class="number">0</span>.len() |
| } |
| |
| <span class="doccomment">/// Returns true if and only if this map is empty. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.<span class="number">0</span>.is_empty() |
| } |
| |
| <span class="doccomment">/// Creates a new map operation with this map added to it. |
| /// |
| /// The `OpBuilder` type can be used to add additional map streams |
| /// and perform set operations like union, intersection, difference and |
| /// symmetric difference on the keys of the map. These set operations also |
| /// allow one to specify how conflicting values are merged in the stream. |
| /// |
| /// # Example |
| /// |
| /// This example demonstrates a union on multiple map streams. Notice that |
| /// the stream returned from the union is not a sequence of key-value |
| /// pairs, but rather a sequence of keys associated with one or more |
| /// values. Namely, a key is associated with each value associated with |
| /// that same key in the all of the streams. |
| /// |
| /// ```rust |
| /// use tantivy_fst::{Streamer, Map}; |
| /// use tantivy_fst::{map::IndexedValue}; |
| /// |
| /// let map1 = Map::from_iter(vec![ |
| /// ("a", 1), ("b", 2), ("c", 3), |
| /// ]).unwrap(); |
| /// let map2 = Map::from_iter(vec![ |
| /// ("a", 10), ("y", 11), ("z", 12), |
| /// ]).unwrap(); |
| /// |
| /// let mut union = map1.op().add(&map2).union(); |
| /// |
| /// let mut kvs = vec![]; |
| /// while let Some((k, vs)) = union.next() { |
| /// kvs.push((k.to_vec(), vs.to_vec())); |
| /// } |
| /// assert_eq!(kvs, vec![ |
| /// (b"a".to_vec(), vec![ |
| /// IndexedValue { index: 0, value: 1 }, |
| /// IndexedValue { index: 1, value: 10 }, |
| /// ]), |
| /// (b"b".to_vec(), vec![IndexedValue { index: 0, value: 2 }]), |
| /// (b"c".to_vec(), vec![IndexedValue { index: 0, value: 3 }]), |
| /// (b"y".to_vec(), vec![IndexedValue { index: 1, value: 11 }]), |
| /// (b"z".to_vec(), vec![IndexedValue { index: 1, value: 12 }]), |
| /// ]); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>op(<span class="kw-2">&</span><span class="self">self</span>) -> OpBuilder { |
| OpBuilder::new().add(<span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Returns a reference to the underlying raw finite state transducer. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>as_fst(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>raw::Fst<Data> { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">impl</span><Data: Deref<Target = [u8]>> fmt::Debug <span class="kw">for </span>Map<Data> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="macro">write!</span>(f, <span class="string">"Map(["</span>)<span class="question-mark">?</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>stream = <span class="self">self</span>.stream(); |
| <span class="kw">let </span><span class="kw-2">mut </span>first = <span class="bool-val">true</span>; |
| <span class="kw">while let </span><span class="prelude-val">Some</span>((k, v)) = stream.next() { |
| <span class="kw">if </span>!first { |
| <span class="macro">write!</span>(f, <span class="string">", "</span>)<span class="question-mark">?</span>; |
| } |
| first = <span class="bool-val">false</span>; |
| <span class="macro">write!</span>(f, <span class="string">"({}, {})"</span>, String::from_utf8_lossy(k), v)<span class="question-mark">?</span>; |
| } |
| <span class="macro">write!</span>(f, <span class="string">"])"</span>) |
| } |
| } |
| |
| <span class="comment">// Construct a map from an Fst object. |
| </span><span class="kw">impl</span><Data> From<raw::Fst<Data>> <span class="kw">for </span>Map<Data> { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>from(fst: raw::Fst<Data>) -> <span class="self">Self </span>{ |
| Map(fst) |
| } |
| } |
| |
| <span class="doccomment">/// Returns the underlying finite state transducer. |
| </span><span class="kw">impl</span><Data> AsRef<raw::Fst<Data>> <span class="kw">for </span>Map<Data> { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>raw::Fst<Data> { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'m</span>, <span class="lifetime">'a</span>, Data: Deref<Target = [u8]>> IntoStreamer<<span class="lifetime">'a</span>> <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'m </span>Map<Data> { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64); |
| <span class="kw">type </span>Into = Stream<<span class="lifetime">'m</span>>; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>into_stream(<span class="self">self</span>) -> <span class="self">Self</span>::Into { |
| Stream(<span class="self">self</span>.<span class="number">0</span>.stream()) |
| } |
| } |
| |
| <span class="doccomment">/// A builder for creating a map. |
| /// |
| /// This is not your average everyday builder. It has two important qualities |
| /// that make it a bit unique from what you might expect: |
| /// |
| /// 1. All keys must be added in lexicographic order. Adding a key out of order |
| /// will result in an error. Additionally, adding a duplicate key will also |
| /// result in an error. That is, once a key is associated with a value, |
| /// that association can never be modified or deleted. |
| /// 2. The representation of a map is streamed to *any* `io::Write` as it is |
| /// built. For an in memory representation, this can be a `Vec<u8>`. |
| /// |
| /// Point (2) is especially important because it means that a map can be |
| /// constructed *without storing the entire map in memory*. Namely, since it |
| /// works with any `io::Write`, it can be streamed directly to a file. |
| /// |
| /// With that said, the builder does use memory, but **memory usage is bounded |
| /// to a constant size**. The amount of memory used trades off with the |
| /// compression ratio. Currently, the implementation hard codes this trade off |
| /// which can result in about 5-20MB of heap usage during construction. (N.B. |
| /// Guaranteeing a maximal compression ratio requires memory proportional to |
| /// the size of the map, which defeats some of the benefit of streaming |
| /// it to disk. In practice, a small bounded amount of memory achieves |
| /// close-to-minimal compression ratios.) |
| /// |
| /// The algorithmic complexity of map construction is `O(n)` where `n` is the |
| /// number of elements added to the map. |
| /// |
| /// # Example: build in memory |
| /// |
| /// This shows how to use the builder to construct a map in memory. Note that |
| /// `Map::from_iter` provides a convenience function that achieves this same |
| /// goal without needing to explicitly use `MapBuilder`. |
| /// |
| /// ```rust |
| /// use tantivy_fst::{IntoStreamer, Streamer, Map, MapBuilder}; |
| /// |
| /// let mut build = MapBuilder::memory(); |
| /// build.insert("bruce", 1).unwrap(); |
| /// build.insert("clarence", 2).unwrap(); |
| /// build.insert("stevie", 3).unwrap(); |
| /// |
| /// // You could also call `finish()` here, but since we're building the map in |
| /// // memory, there would be no way to get the `Vec<u8>` back. |
| /// let bytes = build.into_inner().unwrap(); |
| /// |
| /// // At this point, the map has been constructed, but here's how to read it. |
| /// let map = Map::from_bytes(bytes).unwrap(); |
| /// let mut stream = map.into_stream(); |
| /// let mut kvs = vec![]; |
| /// while let Some((k, v)) = stream.next() { |
| /// kvs.push((k.to_vec(), v)); |
| /// } |
| /// assert_eq!(kvs, vec![ |
| /// (b"bruce".to_vec(), 1), |
| /// (b"clarence".to_vec(), 2), |
| /// (b"stevie".to_vec(), 3), |
| /// ]); |
| /// ``` |
| </span><span class="kw">pub struct </span>MapBuilder<W>(raw::Builder<W>); |
| |
| <span class="kw">impl </span>MapBuilder<Vec<u8>> { |
| <span class="doccomment">/// Create a builder that builds a map in memory. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>memory() -> <span class="self">Self </span>{ |
| MapBuilder(raw::Builder::memory()) |
| } |
| } |
| |
| <span class="kw">impl</span><W: io::Write> MapBuilder<W> { |
| <span class="doccomment">/// Create a builder that builds a map by writing it to `wtr` in a |
| /// streaming fashion. |
| </span><span class="kw">pub fn </span>new(wtr: W) -> <span class="prelude-ty">Result</span><MapBuilder<W>> { |
| raw::Builder::new_type(wtr, <span class="number">0</span>).map(MapBuilder) |
| } |
| |
| <span class="doccomment">/// Insert a new key-value pair into the map. |
| /// |
| /// Keys must be convertible to byte strings. Values must be a `u64`, which |
| /// is a restriction of the current implementation of finite state |
| /// transducers. (Values may one day be expanded to other types.) |
| /// |
| /// If a key is inserted that is less than or equal to any previous key |
| /// added, then an error is returned. Similarly, if there was a problem |
| /// writing to the underlying writer, an error is returned. |
| </span><span class="kw">pub fn </span>insert<K: AsRef<[u8]>>(<span class="kw-2">&mut </span><span class="self">self</span>, key: K, val: u64) -> <span class="prelude-ty">Result</span><()> { |
| <span class="self">self</span>.<span class="number">0</span>.insert(key, val) |
| } |
| |
| <span class="doccomment">/// Calls insert on each item in the iterator. |
| /// |
| /// If an error occurred while adding an element, processing is stopped |
| /// and the error is returned. |
| /// |
| /// If a key is inserted that is less than or equal to any previous key |
| /// added, then an error is returned. Similarly, if there was a problem |
| /// writing to the underlying writer, an error is returned. |
| </span><span class="kw">pub fn </span>extend_iter<K, I>(<span class="kw-2">&mut </span><span class="self">self</span>, iter: I) -> <span class="prelude-ty">Result</span><()> |
| <span class="kw">where |
| </span>K: AsRef<[u8]>, |
| I: IntoIterator<Item = (K, u64)>, |
| { |
| <span class="self">self</span>.<span class="number">0 |
| </span>.extend_iter(iter.into_iter().map(|(k, v)| (k, raw::Output::new(v)))) |
| } |
| |
| <span class="doccomment">/// Calls insert on each item in the stream. |
| /// |
| /// Note that unlike `extend_iter`, this is not generic on the items in |
| /// the stream. |
| /// |
| /// If a key is inserted that is less than or equal to any previous key |
| /// added, then an error is returned. Similarly, if there was a problem |
| /// writing to the underlying writer, an error is returned. |
| </span><span class="kw">pub fn </span>extend_stream<<span class="lifetime">'f</span>, I, S>(<span class="kw-2">&mut </span><span class="self">self</span>, stream: I) -> <span class="prelude-ty">Result</span><()> |
| <span class="kw">where |
| </span>I: <span class="kw">for</span><<span class="lifetime">'a</span>> IntoStreamer<<span class="lifetime">'a</span>, Into = S, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| S: <span class="lifetime">'f </span>+ <span class="kw">for</span><<span class="lifetime">'a</span>> Streamer<<span class="lifetime">'a</span>, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| { |
| <span class="self">self</span>.<span class="number">0</span>.extend_stream(StreamOutput(stream.into_stream())) |
| } |
| |
| <span class="doccomment">/// Finishes the construction of the map and flushes the underlying |
| /// writer. After completion, the data written to `W` may be read using |
| /// one of `Map`'s constructor methods. |
| </span><span class="kw">pub fn </span>finish(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><()> { |
| <span class="self">self</span>.<span class="number">0</span>.finish() |
| } |
| |
| <span class="doccomment">/// Just like `finish`, except it returns the underlying writer after |
| /// flushing it. |
| </span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><W> { |
| <span class="self">self</span>.<span class="number">0</span>.into_inner() |
| } |
| |
| <span class="doccomment">/// Gets a reference to the underlying writer. |
| </span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>W { |
| <span class="self">self</span>.<span class="number">0</span>.get_ref() |
| } |
| |
| <span class="doccomment">/// Returns the number of bytes written to the underlying writer |
| </span><span class="kw">pub fn </span>bytes_written(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.<span class="number">0</span>.bytes_written() |
| } |
| } |
| |
| <span class="doccomment">/// A lexicographically ordered stream of key-value pairs from a map. |
| /// |
| /// The `A` type parameter corresponds to an optional automaton to filter |
| /// the stream. By default, no filtering is done. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying map. |
| </span><span class="kw">pub struct </span>Stream<<span class="lifetime">'m</span>, A = AlwaysMatch>(raw::Stream<<span class="lifetime">'m</span>, A>) |
| <span class="kw">where |
| </span>A: Automaton; |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'m</span>, A: Automaton> Streamer<<span class="lifetime">'a</span>> <span class="kw">for </span>Stream<<span class="lifetime">'m</span>, A> { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64); |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="self">self</span>.<span class="number">0</span>.next().map(|(key, out)| (key, out.value())) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'m</span>, A: Automaton> Stream<<span class="lifetime">'m</span>, A> { |
| <span class="doccomment">/// Convert this stream into a vector of byte strings and outputs. |
| /// |
| /// Note that this creates a new allocation for every key in the stream. |
| </span><span class="kw">pub fn </span>into_byte_vec(<span class="self">self</span>) -> Vec<(Vec<u8>, u64)> { |
| <span class="self">self</span>.<span class="number">0</span>.into_byte_vec() |
| } |
| |
| <span class="doccomment">/// Convert this stream into a vector of Unicode strings and outputs. |
| /// |
| /// If any key is not valid UTF-8, then iteration on the stream is stopped |
| /// and a UTF-8 decoding error is returned. |
| /// |
| /// Note that this creates a new allocation for every key in the stream. |
| </span><span class="kw">pub fn </span>into_str_vec(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><Vec<(String, u64)>> { |
| <span class="self">self</span>.<span class="number">0</span>.into_str_vec() |
| } |
| |
| <span class="doccomment">/// Convert this stream into a vector of byte strings. |
| /// |
| /// Note that this creates a new allocation for every key in the stream. |
| </span><span class="kw">pub fn </span>into_byte_keys(<span class="self">self</span>) -> Vec<Vec<u8>> { |
| <span class="self">self</span>.<span class="number">0</span>.into_byte_keys() |
| } |
| |
| <span class="doccomment">/// Convert this stream into a vector of Unicode strings. |
| /// |
| /// If any key is not valid UTF-8, then iteration on the stream is stopped |
| /// and a UTF-8 decoding error is returned. |
| /// |
| /// Note that this creates a new allocation for every key in the stream. |
| </span><span class="kw">pub fn </span>into_str_keys(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><Vec<String>> { |
| <span class="self">self</span>.<span class="number">0</span>.into_str_keys() |
| } |
| |
| <span class="doccomment">/// Convert this stream into a vector of outputs. |
| </span><span class="kw">pub fn </span>into_values(<span class="self">self</span>) -> Vec<u64> { |
| <span class="self">self</span>.<span class="number">0</span>.into_values() |
| } |
| } |
| |
| <span class="doccomment">/// A lexicographically ordered stream of keys from a map. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying map. |
| </span><span class="kw">pub struct </span>Keys<<span class="lifetime">'m</span>>(raw::Stream<<span class="lifetime">'m</span>>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'m</span>> Streamer<<span class="lifetime">'a</span>> <span class="kw">for </span>Keys<<span class="lifetime">'m</span>> { |
| <span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'a </span>[u8]; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>next(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="self">self</span>.<span class="number">0</span>.next().map(|(key, <span class="kw">_</span>)| key) |
| } |
| } |
| |
| <span class="doccomment">/// A stream of values from a map, lexicographically ordered by each value's |
| /// corresponding key. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying map. |
| </span><span class="kw">pub struct </span>Values<<span class="lifetime">'m</span>>(raw::Stream<<span class="lifetime">'m</span>>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'m</span>> Streamer<<span class="lifetime">'a</span>> <span class="kw">for </span>Values<<span class="lifetime">'m</span>> { |
| <span class="kw">type </span>Item = u64; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>next(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="self">self</span>.<span class="number">0</span>.next().map(|(<span class="kw">_</span>, out)| out.value()) |
| } |
| } |
| |
| <span class="doccomment">/// A builder for constructing range queries on streams. |
| /// |
| /// Once all bounds are set, one should call `into_stream` to get a |
| /// `Stream`. |
| /// |
| /// Bounds are not additive. That is, if `ge` is called twice on the same |
| /// builder, then the second setting wins. |
| /// |
| /// The `A` type parameter corresponds to an optional automaton to filter |
| /// the stream. By default, no filtering is done. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying map. |
| </span><span class="kw">pub struct </span>StreamBuilder<<span class="lifetime">'m</span>, A = AlwaysMatch>(raw::StreamBuilder<<span class="lifetime">'m</span>, A>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'m</span>, A: Automaton> StreamBuilder<<span class="lifetime">'m</span>, A> { |
| <span class="doccomment">/// Specify a greater-than-or-equal-to bound. |
| </span><span class="kw">pub fn </span>ge<T: AsRef<[u8]>>(<span class="self">self</span>, bound: T) -> <span class="self">Self </span>{ |
| StreamBuilder(<span class="self">self</span>.<span class="number">0</span>.ge(bound)) |
| } |
| |
| <span class="doccomment">/// Specify a greater-than bound. |
| </span><span class="kw">pub fn </span>gt<T: AsRef<[u8]>>(<span class="self">self</span>, bound: T) -> <span class="self">Self </span>{ |
| StreamBuilder(<span class="self">self</span>.<span class="number">0</span>.gt(bound)) |
| } |
| |
| <span class="doccomment">/// Specify a less-than-or-equal-to bound. |
| </span><span class="kw">pub fn </span>le<T: AsRef<[u8]>>(<span class="self">self</span>, bound: T) -> <span class="self">Self </span>{ |
| StreamBuilder(<span class="self">self</span>.<span class="number">0</span>.le(bound)) |
| } |
| |
| <span class="doccomment">/// Specify a less-than bound. |
| </span><span class="kw">pub fn </span>lt<T: AsRef<[u8]>>(<span class="self">self</span>, bound: T) -> <span class="self">Self </span>{ |
| StreamBuilder(<span class="self">self</span>.<span class="number">0</span>.lt(bound)) |
| } |
| |
| <span class="doccomment">/// Make it iterate backwards. |
| </span><span class="kw">pub fn </span>backward(<span class="self">self</span>) -> <span class="self">Self </span>{ |
| StreamBuilder(<span class="self">self</span>.<span class="number">0</span>.backward()) |
| } |
| |
| <span class="doccomment">/// Return this builder and gives the automaton states |
| /// along with the results. |
| </span><span class="kw">pub fn </span>with_state(<span class="self">self</span>) -> StreamWithStateBuilder<<span class="lifetime">'m</span>, A> { |
| StreamWithStateBuilder(<span class="self">self</span>.<span class="number">0</span>.with_state()) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'m</span>, <span class="lifetime">'a</span>, A: Automaton> IntoStreamer<<span class="lifetime">'a</span>> <span class="kw">for </span>StreamBuilder<<span class="lifetime">'m</span>, A> { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64); |
| <span class="kw">type </span>Into = Stream<<span class="lifetime">'m</span>, A>; |
| |
| <span class="kw">fn </span>into_stream(<span class="self">self</span>) -> <span class="self">Self</span>::Into { |
| Stream(<span class="self">self</span>.<span class="number">0</span>.into_stream()) |
| } |
| } |
| |
| <span class="doccomment">/// A builder for constructing range queries of streams |
| /// that returns results along with automaton states. |
| /// |
| /// Once all bounds are set, one should call `into_stream` to get a |
| /// `StreamWithState`. |
| /// |
| /// Bounds are not additive. That is, if `ge` is called twice on the same |
| /// builder, then the second setting wins. |
| /// |
| /// The `A` type parameter corresponds to an optional automaton to filter |
| /// the stream. By default, no filtering is done. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying map. |
| </span><span class="kw">pub struct </span>StreamWithStateBuilder<<span class="lifetime">'m</span>, A = AlwaysMatch>(raw::StreamWithStateBuilder<<span class="lifetime">'m</span>, A>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'m</span>, <span class="lifetime">'a</span>, A: <span class="lifetime">'a </span>+ Automaton> IntoStreamer<<span class="lifetime">'a</span>> <span class="kw">for </span>StreamWithStateBuilder<<span class="lifetime">'m</span>, A> |
| <span class="kw">where |
| </span>A::State: Clone, |
| { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64, A::State); |
| <span class="kw">type </span>Into = StreamWithState<<span class="lifetime">'m</span>, A>; |
| |
| <span class="kw">fn </span>into_stream(<span class="self">self</span>) -> <span class="self">Self</span>::Into { |
| StreamWithState(<span class="self">self</span>.<span class="number">0</span>.into_stream()) |
| } |
| } |
| |
| <span class="doccomment">/// A builder for collecting map streams on which to perform set operations |
| /// on the keys of maps. |
| /// |
| /// Set operations include intersection, union, difference and symmetric |
| /// difference. The result of each set operation is itself a stream that emits |
| /// pairs of keys and a sequence of each occurrence of that key in the |
| /// participating streams. This information allows one to perform set |
| /// operations on maps and customize how conflicting output values are handled. |
| /// |
| /// All set operations work efficiently on an arbitrary number of |
| /// streams with memory proportional to the number of streams. |
| /// |
| /// The algorithmic complexity of all set operations is `O(n1 + n2 + n3 + ...)` |
| /// where `n1, n2, n3, ...` correspond to the number of elements in each |
| /// stream. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying set. |
| </span><span class="kw">pub struct </span>OpBuilder<<span class="lifetime">'m</span>>(raw::OpBuilder<<span class="lifetime">'m</span>>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'m</span>> OpBuilder<<span class="lifetime">'m</span>> { |
| <span class="doccomment">/// Create a new set operation builder. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>new() -> <span class="self">Self </span>{ |
| OpBuilder(raw::OpBuilder::default()) |
| } |
| |
| <span class="doccomment">/// Add a stream to this set operation. |
| /// |
| /// This is useful for a chaining style pattern, e.g., |
| /// `builder.add(stream1).add(stream2).union()`. |
| /// |
| /// The stream must emit a lexicographically ordered sequence of key-value |
| /// pairs. |
| </span><span class="kw">pub fn </span>add<I, S>(<span class="kw-2">mut </span><span class="self">self</span>, streamable: I) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>I: <span class="kw">for</span><<span class="lifetime">'a</span>> IntoStreamer<<span class="lifetime">'a</span>, Into = S, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| S: <span class="lifetime">'m </span>+ <span class="kw">for</span><<span class="lifetime">'a</span>> Streamer<<span class="lifetime">'a</span>, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| { |
| <span class="self">self</span>.push(streamable); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Add a stream to this set operation. |
| /// |
| /// The stream must emit a lexicographically ordered sequence of key-value |
| /// pairs. |
| </span><span class="kw">pub fn </span>push<I, S>(<span class="kw-2">&mut </span><span class="self">self</span>, streamable: I) |
| <span class="kw">where |
| </span>I: <span class="kw">for</span><<span class="lifetime">'a</span>> IntoStreamer<<span class="lifetime">'a</span>, Into = S, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| S: <span class="lifetime">'m </span>+ <span class="kw">for</span><<span class="lifetime">'a</span>> Streamer<<span class="lifetime">'a</span>, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| { |
| <span class="self">self</span>.<span class="number">0</span>.push(StreamOutput(streamable.into_stream())); |
| } |
| |
| <span class="doccomment">/// Performs a union operation on all streams that have been added. |
| /// |
| /// Note that this returns a stream of `(&[u8], &[IndexedValue])`. The |
| /// first element of the tuple is the byte string key. The second element |
| /// of the tuple is a list of all occurrences of that key in participating |
| /// streams. The `IndexedValue` contains an index and the value associated |
| /// with that key in that stream. The index uniquely identifies each |
| /// stream, which is an integer that is auto-incremented when a stream |
| /// is added to this operation (starting at `0`). |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tantivy_fst::{IntoStreamer, Streamer, Map}; |
| /// use tantivy_fst::map::IndexedValue; |
| /// |
| /// let map1 = Map::from_iter(vec![ |
| /// ("a", 1), ("b", 2), ("c", 3), |
| /// ]).unwrap(); |
| /// let map2 = Map::from_iter(vec![ |
| /// ("a", 11), ("y", 12), ("z", 13), |
| /// ]).unwrap(); |
| /// |
| /// let mut union = map1.op().add(&map2).union(); |
| /// |
| /// let mut kvs = vec![]; |
| /// while let Some((k, vs)) = union.next() { |
| /// kvs.push((k.to_vec(), vs.to_vec())); |
| /// } |
| /// assert_eq!(kvs, vec![ |
| /// (b"a".to_vec(), vec![ |
| /// IndexedValue { index: 0, value: 1 }, |
| /// IndexedValue { index: 1, value: 11 }, |
| /// ]), |
| /// (b"b".to_vec(), vec![IndexedValue { index: 0, value: 2 }]), |
| /// (b"c".to_vec(), vec![IndexedValue { index: 0, value: 3 }]), |
| /// (b"y".to_vec(), vec![IndexedValue { index: 1, value: 12 }]), |
| /// (b"z".to_vec(), vec![IndexedValue { index: 1, value: 13 }]), |
| /// ]); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>union(<span class="self">self</span>) -> Union<<span class="lifetime">'m</span>> { |
| Union(<span class="self">self</span>.<span class="number">0</span>.union()) |
| } |
| |
| <span class="doccomment">/// Chains all streams that have been added in the order they have been added. |
| /// |
| /// Note that this returns a stream of `(&[u8], &[Output])`. The |
| /// first element of the tuple is the byte string key. The second element |
| /// of the tuple is the value associated with that key in the underlying |
| /// streams. This is useful when the streams area already sorted and not |
| /// overlapping. |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tantivy_fst::{IntoStreamer, Streamer, Map}; |
| /// use tantivy_fst::raw::Output; |
| /// use tantivy_fst::map::IndexedValue; |
| /// |
| /// let map1 = Map::from_iter(vec![ |
| /// ("a", 1), ("b", 2), |
| /// ]).unwrap(); |
| /// let map2 = Map::from_iter(vec![ |
| /// ("a", 11), ("y", 12), |
| /// ]).unwrap(); |
| /// |
| /// let mut chain = map1.op().add(&map2).chain(); |
| /// |
| /// let mut kvs = vec![]; |
| /// while let Some((k, v)) = chain.next() { |
| /// kvs.push((k.to_vec(), v)); |
| /// } |
| /// assert_eq!(kvs, vec![ |
| /// (b"a".to_vec(), Output::new(1)), |
| /// (b"b".to_vec(), Output::new(2)), |
| /// (b"a".to_vec(), Output::new(11)), |
| /// (b"y".to_vec(), Output::new(12)), |
| /// ]); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>chain(<span class="self">self</span>) -> Chain<<span class="lifetime">'m</span>> { |
| Chain(<span class="self">self</span>.<span class="number">0</span>.chain()) |
| } |
| <span class="doccomment">/// Performs an intersection operation on all streams that have been added. |
| /// |
| /// Note that this returns a stream of `(&[u8], &[IndexedValue])`. The |
| /// first element of the tuple is the byte string key. The second element |
| /// of the tuple is a list of all occurrences of that key in participating |
| /// streams. The `IndexedValue` contains an index and the value associated |
| /// with that key in that stream. The index uniquely identifies each |
| /// stream, which is an integer that is auto-incremented when a stream |
| /// is added to this operation (starting at `0`). |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tantivy_fst::{IntoStreamer, Streamer, Map}; |
| /// use tantivy_fst::map::IndexedValue; |
| /// |
| /// let map1 = Map::from_iter(vec![ |
| /// ("a", 1), ("b", 2), ("c", 3), |
| /// ]).unwrap(); |
| /// let map2 = Map::from_iter(vec![ |
| /// ("a", 11), ("y", 12), ("z", 13), |
| /// ]).unwrap(); |
| /// |
| /// let mut intersection = map1.op().add(&map2).intersection(); |
| /// |
| /// let mut kvs = vec![]; |
| /// while let Some((k, vs)) = intersection.next() { |
| /// kvs.push((k.to_vec(), vs.to_vec())); |
| /// } |
| /// assert_eq!(kvs, vec![ |
| /// (b"a".to_vec(), vec![ |
| /// IndexedValue { index: 0, value: 1 }, |
| /// IndexedValue { index: 1, value: 11 }, |
| /// ]), |
| /// ]); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>intersection(<span class="self">self</span>) -> Intersection<<span class="lifetime">'m</span>> { |
| Intersection(<span class="self">self</span>.<span class="number">0</span>.intersection()) |
| } |
| |
| <span class="doccomment">/// Performs a difference operation with respect to the first stream added. |
| /// That is, this returns a stream of all elements in the first stream |
| /// that don't exist in any other stream that has been added. |
| /// |
| /// Note that this returns a stream of `(&[u8], &[IndexedValue])`. The |
| /// first element of the tuple is the byte string key. The second element |
| /// of the tuple is a list of all occurrences of that key in participating |
| /// streams. The `IndexedValue` contains an index and the value associated |
| /// with that key in that stream. The index uniquely identifies each |
| /// stream, which is an integer that is auto-incremented when a stream |
| /// is added to this operation (starting at `0`). |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tantivy_fst::{Streamer, Map}; |
| /// use tantivy_fst::map::IndexedValue; |
| /// |
| /// let map1 = Map::from_iter(vec![ |
| /// ("a", 1), ("b", 2), ("c", 3), |
| /// ]).unwrap(); |
| /// let map2 = Map::from_iter(vec![ |
| /// ("a", 11), ("y", 12), ("z", 13), |
| /// ]).unwrap(); |
| /// |
| /// let mut difference = map1.op().add(&map2).difference(); |
| /// |
| /// let mut kvs = vec![]; |
| /// while let Some((k, vs)) = difference.next() { |
| /// kvs.push((k.to_vec(), vs.to_vec())); |
| /// } |
| /// assert_eq!(kvs, vec![ |
| /// (b"b".to_vec(), vec![IndexedValue { index: 0, value: 2 }]), |
| /// (b"c".to_vec(), vec![IndexedValue { index: 0, value: 3 }]), |
| /// ]); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>difference(<span class="self">self</span>) -> Difference<<span class="lifetime">'m</span>> { |
| Difference(<span class="self">self</span>.<span class="number">0</span>.difference()) |
| } |
| |
| <span class="doccomment">/// Performs a symmetric difference operation on all of the streams that |
| /// have been added. |
| /// |
| /// When there are only two streams, then the keys returned correspond to |
| /// keys that are in either stream but *not* in both streams. |
| /// |
| /// More generally, for any number of streams, keys that occur in an odd |
| /// number of streams are returned. |
| /// |
| /// Note that this returns a stream of `(&[u8], &[IndexedValue])`. The |
| /// first element of the tuple is the byte string key. The second element |
| /// of the tuple is a list of all occurrences of that key in participating |
| /// streams. The `IndexedValue` contains an index and the value associated |
| /// with that key in that stream. The index uniquely identifies each |
| /// stream, which is an integer that is auto-incremented when a stream |
| /// is added to this operation (starting at `0`). |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tantivy_fst::{IntoStreamer, Streamer, Map}; |
| /// use tantivy_fst::map::IndexedValue; |
| /// |
| /// let map1 = Map::from_iter(vec![ |
| /// ("a", 1), ("b", 2), ("c", 3), |
| /// ]).unwrap(); |
| /// let map2 = Map::from_iter(vec![ |
| /// ("a", 11), ("y", 12), ("z", 13), |
| /// ]).unwrap(); |
| /// |
| /// let mut sym_difference = map1.op().add(&map2).symmetric_difference(); |
| /// |
| /// let mut kvs = vec![]; |
| /// while let Some((k, vs)) = sym_difference.next() { |
| /// kvs.push((k.to_vec(), vs.to_vec())); |
| /// } |
| /// assert_eq!(kvs, vec![ |
| /// (b"b".to_vec(), vec![IndexedValue { index: 0, value: 2 }]), |
| /// (b"c".to_vec(), vec![IndexedValue { index: 0, value: 3 }]), |
| /// (b"y".to_vec(), vec![IndexedValue { index: 1, value: 12 }]), |
| /// (b"z".to_vec(), vec![IndexedValue { index: 1, value: 13 }]), |
| /// ]); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>symmetric_difference(<span class="self">self</span>) -> SymmetricDifference<<span class="lifetime">'m</span>> { |
| SymmetricDifference(<span class="self">self</span>.<span class="number">0</span>.symmetric_difference()) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'f</span>, I, S> Extend<I> <span class="kw">for </span>OpBuilder<<span class="lifetime">'f</span>> |
| <span class="kw">where |
| </span>I: <span class="kw">for</span><<span class="lifetime">'a</span>> IntoStreamer<<span class="lifetime">'a</span>, Into = S, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| S: <span class="lifetime">'f </span>+ <span class="kw">for</span><<span class="lifetime">'a</span>> Streamer<<span class="lifetime">'a</span>, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| { |
| <span class="kw">fn </span>extend<T>(<span class="kw-2">&mut </span><span class="self">self</span>, it: T) |
| <span class="kw">where |
| </span>T: IntoIterator<Item = I>, |
| { |
| <span class="kw">for </span>stream <span class="kw">in </span>it { |
| <span class="self">self</span>.push(stream); |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'f</span>, I, S> FromIterator<I> <span class="kw">for </span>OpBuilder<<span class="lifetime">'f</span>> |
| <span class="kw">where |
| </span>I: <span class="kw">for</span><<span class="lifetime">'a</span>> IntoStreamer<<span class="lifetime">'a</span>, Into = S, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| S: <span class="lifetime">'f </span>+ <span class="kw">for</span><<span class="lifetime">'a</span>> Streamer<<span class="lifetime">'a</span>, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| { |
| <span class="kw">fn </span>from_iter<T>(it: T) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>T: IntoIterator<Item = I>, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>op = OpBuilder::new(); |
| op.extend(it); |
| op |
| } |
| } |
| |
| <span class="doccomment">/// A stream of set union over multiple map streams in lexicographic order. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying map. |
| </span><span class="kw">pub struct </span>Union<<span class="lifetime">'m</span>>(raw::Union<<span class="lifetime">'m</span>>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'m</span>> Streamer<<span class="lifetime">'a</span>> <span class="kw">for </span>Union<<span class="lifetime">'m</span>> { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], <span class="kw-2">&</span><span class="lifetime">'a </span>[IndexedValue]); |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>next(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="self">self</span>.<span class="number">0</span>.next() |
| } |
| } |
| |
| <span class="doccomment">/// A stream of set union over multiple map streams in lexicographic order. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying map. |
| </span><span class="kw">pub struct </span>Chain<<span class="lifetime">'m</span>>(raw::Chain<<span class="lifetime">'m</span>>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'m</span>> Streamer<<span class="lifetime">'a</span>> <span class="kw">for </span>Chain<<span class="lifetime">'m</span>> { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], Output); |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>next(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="self">self</span>.<span class="number">0</span>.next() |
| } |
| } |
| |
| <span class="doccomment">/// A stream of set intersection over multiple map streams in lexicographic |
| /// order. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying map. |
| </span><span class="kw">pub struct </span>Intersection<<span class="lifetime">'m</span>>(raw::Intersection<<span class="lifetime">'m</span>>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'m</span>> Streamer<<span class="lifetime">'a</span>> <span class="kw">for </span>Intersection<<span class="lifetime">'m</span>> { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], <span class="kw-2">&</span><span class="lifetime">'a </span>[IndexedValue]); |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>next(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="self">self</span>.<span class="number">0</span>.next() |
| } |
| } |
| |
| <span class="doccomment">/// A stream of set difference over multiple map streams in lexicographic |
| /// order. |
| /// |
| /// The difference operation is taken with respect to the first stream and the |
| /// rest of the streams. i.e., All elements in the first stream that do not |
| /// appear in any other streams. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying map. |
| </span><span class="kw">pub struct </span>Difference<<span class="lifetime">'m</span>>(raw::Difference<<span class="lifetime">'m</span>>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'m</span>> Streamer<<span class="lifetime">'a</span>> <span class="kw">for </span>Difference<<span class="lifetime">'m</span>> { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], <span class="kw-2">&</span><span class="lifetime">'a </span>[IndexedValue]); |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>next(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="self">self</span>.<span class="number">0</span>.next() |
| } |
| } |
| |
| <span class="doccomment">/// A stream of set symmetric difference over multiple map streams in |
| /// lexicographic order. |
| /// |
| /// The `'m` lifetime parameter refers to the lifetime of the underlying map. |
| </span><span class="kw">pub struct </span>SymmetricDifference<<span class="lifetime">'m</span>>(raw::SymmetricDifference<<span class="lifetime">'m</span>>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'m</span>> Streamer<<span class="lifetime">'a</span>> <span class="kw">for </span>SymmetricDifference<<span class="lifetime">'m</span>> { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], <span class="kw-2">&</span><span class="lifetime">'a </span>[IndexedValue]); |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>next(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="self">self</span>.<span class="number">0</span>.next() |
| } |
| } |
| |
| <span class="doccomment">/// A specialized stream for mapping map streams (`(&[u8], u64)`) to streams |
| /// used by raw fsts (`(&[u8], Output)`). |
| /// |
| /// If this were iterators, we could use `iter::Map`, but doing this on streams |
| /// requires HKT, so we need to write out the monomorphization ourselves. |
| </span><span class="kw">struct </span>StreamOutput<S>(S); |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, S> Streamer<<span class="lifetime">'a</span>> <span class="kw">for </span>StreamOutput<S> |
| <span class="kw">where |
| </span>S: Streamer<<span class="lifetime">'a</span>, Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64)>, |
| { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], raw::Output); |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="self">self</span>.<span class="number">0</span>.next().map(|(k, v)| (k, raw::Output::new(v))) |
| } |
| } |
| |
| <span class="doccomment">/// A lexicographically ordered stream of key-value from a map |
| /// along with the states of the automaton. |
| /// |
| /// The `Stream` type is based on the `StreamWithState`. |
| </span><span class="kw">pub struct </span>StreamWithState<<span class="lifetime">'m</span>, A = AlwaysMatch>(raw::StreamWithState<<span class="lifetime">'m</span>, A>) |
| <span class="kw">where |
| </span>A: Automaton; |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'m</span>, A: <span class="lifetime">'a </span>+ Automaton> Streamer<<span class="lifetime">'a</span>> <span class="kw">for </span>StreamWithState<<span class="lifetime">'m</span>, A> |
| <span class="kw">where |
| </span>A::State: Clone, |
| { |
| <span class="kw">type </span>Item = (<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], u64, A::State); |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="self">self</span>.<span class="number">0 |
| </span>.next() |
| .map(|(key, out, state)| (key, out.value(), state)) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tantivy_fst" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |