api-docs/crates-enclave/src/tantivy/core/index.rs.html - incubator-teaclave-website - Git at Google

 <!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/git/checkouts/tantivy-65d0bbbddbbd5d02/433372d/src/core/index.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>index.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/index.html"><div class="logo-container">
                     <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tantivy/index.html">
                         <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" 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>
 </pre><pre class="rust"><code><span class="kw">use </span>std::collections::HashSet;
 <span class="kw">use </span>std::fmt;
 <span class="attribute">#[cfg(feature = <span class="string">&quot;mmap&quot;</span>)]
 </span><span class="kw">use </span>std::path::Path;
 <span class="kw">use </span>std::path::PathBuf;
 <span class="kw">use </span>std::sync::Arc;

 <span class="kw">use </span><span class="kw">super</span>::segment::Segment;
 <span class="kw">use </span><span class="kw">super</span>::IndexSettings;
 <span class="kw">use </span><span class="kw">crate</span>::core::single_segment_index_writer::SingleSegmentIndexWriter;
 <span class="kw">use </span><span class="kw">crate</span>::core::{
     Executor, IndexMeta, SegmentId, SegmentMeta, SegmentMetaInventory, META_FILEPATH,
 };
 <span class="kw">use </span><span class="kw">crate</span>::directory::error::OpenReadError;
 <span class="attribute">#[cfg(feature = <span class="string">&quot;mmap&quot;</span>)]
 </span><span class="kw">use </span><span class="kw">crate</span>::directory::MmapDirectory;
 <span class="kw">use </span><span class="kw">crate</span>::directory::{Directory, ManagedDirectory, RamDirectory, INDEX_WRITER_LOCK};
 <span class="kw">use </span><span class="kw">crate</span>::error::{DataCorruption, TantivyError};
 <span class="kw">use </span><span class="kw">crate</span>::indexer::index_writer::{MAX_NUM_THREAD, MEMORY_ARENA_NUM_BYTES_MIN};
 <span class="kw">use </span><span class="kw">crate</span>::indexer::segment_updater::save_metas;
 <span class="kw">use </span><span class="kw">crate</span>::reader::{IndexReader, IndexReaderBuilder};
 <span class="kw">use </span><span class="kw">crate</span>::schema::{Cardinality, Field, FieldType, Schema};
 <span class="kw">use </span><span class="kw">crate</span>::tokenizer::{TextAnalyzer, TokenizerManager};
 <span class="kw">use </span><span class="kw">crate</span>::IndexWriter;

 <span class="kw">fn </span>load_metas(
     directory: <span class="kw-2">&amp;</span><span class="kw">dyn </span>Directory,
     inventory: <span class="kw-2">&amp;</span>SegmentMetaInventory,
 ) -&gt; <span class="kw">crate</span>::Result&lt;IndexMeta&gt; {
     <span class="kw">let </span>meta_data = directory.atomic_read(<span class="kw-2">&amp;</span>META_FILEPATH)<span class="question-mark">?</span>;
     <span class="kw">let </span>meta_string = String::from_utf8(meta_data).map_err(|_utf8_err| {
         <span class="macro">error!</span>(<span class="string">&quot;Meta data is not valid utf8.&quot;</span>);
         DataCorruption::new(
             META_FILEPATH.to_path_buf(),
             <span class="string">&quot;Meta file does not contain valid utf8 file.&quot;</span>.to_string(),
         )
     })<span class="question-mark">?</span>;
     IndexMeta::deserialize(<span class="kw-2">&amp;</span>meta_string, inventory)
         .map_err(|e| {
             DataCorruption::new(
                 META_FILEPATH.to_path_buf(),
                 <span class="macro">format!</span>(
                     <span class="string">&quot;Meta file cannot be deserialized. {:?}. Content: {:?}&quot;</span>,
                     e, meta_string
                 ),
             )
         })
         .map_err(From::from)
 }

 <span class="doccomment">/// Save the index meta file.
 /// This operation is atomic :
 /// Either
 ///  - it fails, in which case an error is returned,
 /// and the `meta.json` remains untouched,
 /// - it succeeds, and `meta.json` is written
 /// and flushed.
 ///
 /// This method is not part of tantivy&#39;s public API
 </span><span class="kw">fn </span>save_new_metas(
     schema: Schema,
     index_settings: IndexSettings,
     directory: <span class="kw-2">&amp;</span><span class="kw">dyn </span>Directory,
 ) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
     save_metas(
         <span class="kw-2">&amp;</span>IndexMeta {
             index_settings,
             segments: Vec::new(),
             schema,
             opstamp: <span class="number">0u64</span>,
             payload: <span class="prelude-val">None</span>,
         },
         directory,
     )<span class="question-mark">?</span>;
     directory.sync_directory()<span class="question-mark">?</span>;
     <span class="prelude-val">Ok</span>(())
 }

 <span class="doccomment">/// IndexBuilder can be used to create an index.
 ///
 /// Use in conjunction with [`SchemaBuilder`][crate::schema::SchemaBuilder].
 /// Global index settings can be configured with [`IndexSettings`].
 ///
 /// # Examples
 ///
 /// ```
 /// use tantivy::schema::*;
 /// use tantivy::{Index, IndexSettings, IndexSortByField, Order};
 ///
 /// let mut schema_builder = Schema::builder();
 /// let id_field = schema_builder.add_text_field(&quot;id&quot;, STRING);
 /// let title_field = schema_builder.add_text_field(&quot;title&quot;, TEXT);
 /// let body_field = schema_builder.add_text_field(&quot;body&quot;, TEXT);
 /// let number_field = schema_builder.add_u64_field(
 ///     &quot;number&quot;,
 ///     NumericOptions::default().set_fast(Cardinality::SingleValue),
 /// );
 ///
 /// let schema = schema_builder.build();
 /// let settings = IndexSettings{
 ///     sort_by_field: Some(IndexSortByField{
 ///         field: &quot;number&quot;.to_string(),
 ///         order: Order::Asc
 ///     }),
 ///     ..Default::default()
 /// };
 /// let index = Index::builder().schema(schema).settings(settings).create_in_ram();
 /// ```
 </span><span class="kw">pub struct </span>IndexBuilder {
     schema: <span class="prelude-ty">Option</span>&lt;Schema&gt;,
     index_settings: IndexSettings,
     tokenizer_manager: TokenizerManager,
 }
 <span class="kw">impl </span>Default <span class="kw">for </span>IndexBuilder {
     <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
         IndexBuilder::new()
     }
 }
 <span class="kw">impl </span>IndexBuilder {
     <span class="doccomment">/// Creates a new `IndexBuilder`
     </span><span class="kw">pub fn </span>new() -&gt; <span class="self">Self </span>{
         <span class="self">Self </span>{
             schema: <span class="prelude-val">None</span>,
             index_settings: IndexSettings::default(),
             tokenizer_manager: TokenizerManager::default(),
         }
     }

     <span class="doccomment">/// Set the settings
     </span><span class="attribute">#[must_use]
     </span><span class="kw">pub fn </span>settings(<span class="kw-2">mut </span><span class="self">self</span>, settings: IndexSettings) -&gt; <span class="self">Self </span>{
         <span class="self">self</span>.index_settings = settings;
         <span class="self">self
     </span>}

     <span class="doccomment">/// Set the schema
     </span><span class="attribute">#[must_use]
     </span><span class="kw">pub fn </span>schema(<span class="kw-2">mut </span><span class="self">self</span>, schema: Schema) -&gt; <span class="self">Self </span>{
         <span class="self">self</span>.schema = <span class="prelude-val">Some</span>(schema);
         <span class="self">self
     </span>}

     <span class="doccomment">/// Set the tokenizers .
     </span><span class="kw">pub fn </span>tokenizers(<span class="kw-2">mut </span><span class="self">self</span>, tokenizers: TokenizerManager) -&gt; <span class="self">Self </span>{
         <span class="self">self</span>.tokenizer_manager = tokenizers;
         <span class="self">self
     </span>}

     <span class="doccomment">/// Creates a new index using the [`RamDirectory`].
     ///
     /// The index will be allocated in anonymous memory.
     /// This is useful for indexing small set of documents
     /// for instances like unit test or temporary in memory index.
     </span><span class="kw">pub fn </span>create_in_ram(<span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;Index, TantivyError&gt; {
         <span class="kw">let </span>ram_directory = RamDirectory::create();
         <span class="self">self</span>.create(ram_directory)
     }

     <span class="doccomment">/// Creates a new index in a given filepath.
     /// The index will use the [`MmapDirectory`].
     ///
     /// If a previous index was in this directory, it returns an
     /// [`TantivyError::IndexAlreadyExists`] error.
     </span><span class="attribute">#[cfg(feature = <span class="string">&quot;mmap&quot;</span>)]
     </span><span class="kw">pub fn </span>create_in_dir&lt;P: AsRef&lt;Path&gt;&gt;(<span class="self">self</span>, directory_path: P) -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
         <span class="kw">let </span>mmap_directory: Box&lt;<span class="kw">dyn </span>Directory&gt; = Box::new(MmapDirectory::open(directory_path)<span class="question-mark">?</span>);
         <span class="kw">if </span>Index::exists(<span class="kw-2">&amp;*</span>mmap_directory)<span class="question-mark">? </span>{
             <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::IndexAlreadyExists);
         }
         <span class="self">self</span>.create(mmap_directory)
     }

     <span class="doccomment">/// Dragons ahead!!!
     ///
     /// The point of this API is to let users create a simple index with a single segment
     /// and without starting any thread.
     ///
     /// Do not use this method if you are not sure what you are doing.
     ///
     /// It expects an originally empty directory, and will not run any GC operation.
     </span><span class="attribute">#[doc(hidden)]
     </span><span class="kw">pub fn </span>single_segment_index_writer(
         <span class="self">self</span>,
         dir: <span class="kw">impl </span>Into&lt;Box&lt;<span class="kw">dyn </span>Directory&gt;&gt;,
         mem_budget: usize,
     ) -&gt; <span class="kw">crate</span>::Result&lt;SingleSegmentIndexWriter&gt; {
         <span class="kw">let </span>index = <span class="self">self</span>.create(dir)<span class="question-mark">?</span>;
         <span class="kw">let </span>index_simple_writer = SingleSegmentIndexWriter::new(index, mem_budget)<span class="question-mark">?</span>;
         <span class="prelude-val">Ok</span>(index_simple_writer)
     }

     <span class="doccomment">/// Creates a new index in a temp directory.
     ///
     /// The index will use the [`MmapDirectory`] in a newly created directory.
     /// The temp directory will be destroyed automatically when the [`Index`] object
     /// is destroyed.
     ///
     /// The temp directory is only used for testing the [`MmapDirectory`].
     /// For other unit tests, prefer the [`RamDirectory`], see:
     /// [`IndexBuilder::create_in_ram()`].
     </span><span class="attribute">#[cfg(feature = <span class="string">&quot;mmap&quot;</span>)]
     </span><span class="kw">pub fn </span>create_from_tempdir(<span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
         <span class="kw">let </span>mmap_directory: Box&lt;<span class="kw">dyn </span>Directory&gt; = Box::new(MmapDirectory::create_from_tempdir()<span class="question-mark">?</span>);
         <span class="self">self</span>.create(mmap_directory)
     }

     <span class="kw">fn </span>get_expect_schema(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;Schema&gt; {
         <span class="self">self</span>.schema
             .as_ref()
             .cloned()
             .ok_or(TantivyError::IndexBuilderMissingArgument(<span class="string">&quot;schema&quot;</span>))
     }

     <span class="doccomment">/// Opens or creates a new index in the provided directory
     </span><span class="kw">pub fn </span>open_or_create&lt;T: Into&lt;Box&lt;<span class="kw">dyn </span>Directory&gt;&gt;&gt;(<span class="self">self</span>, dir: T) -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
         <span class="kw">let </span>dir = dir.into();
         <span class="kw">if </span>!Index::exists(<span class="kw-2">&amp;*</span>dir)<span class="question-mark">? </span>{
             <span class="kw">return </span><span class="self">self</span>.create(dir);
         }
         <span class="kw">let </span><span class="kw-2">mut </span>index = Index::open(dir)<span class="question-mark">?</span>;
         index.set_tokenizers(<span class="self">self</span>.tokenizer_manager.clone());
         <span class="kw">if </span>index.schema() == <span class="self">self</span>.get_expect_schema()<span class="question-mark">? </span>{
             <span class="prelude-val">Ok</span>(index)
         } <span class="kw">else </span>{
             <span class="prelude-val">Err</span>(TantivyError::SchemaError(
                 <span class="string">&quot;An index exists but the schema does not match.&quot;</span>.to_string(),
             ))
         }
     }

     <span class="kw">fn </span>validate(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
         <span class="kw">if let </span><span class="prelude-val">Some</span>(schema) = <span class="self">self</span>.schema.as_ref() {
             <span class="kw">if let </span><span class="prelude-val">Some</span>(sort_by_field) = <span class="self">self</span>.index_settings.sort_by_field.as_ref() {
                 <span class="kw">let </span>schema_field = schema.get_field(<span class="kw-2">&amp;</span>sort_by_field.field).ok_or_else(|| {
                     TantivyError::InvalidArgument(<span class="macro">format!</span>(
                         <span class="string">&quot;Field to sort index {} not found in schema&quot;</span>,
                         sort_by_field.field
                     ))
                 })<span class="question-mark">?</span>;
                 <span class="kw">let </span>entry = schema.get_field_entry(schema_field);
                 <span class="kw">if </span>!entry.is_fast() {
                     <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::InvalidArgument(<span class="macro">format!</span>(
                         <span class="string">&quot;Field {} is no fast field. Field needs to be a single value fast field \
                          to be used to sort an index&quot;</span>,
                         sort_by_field.field
                     )));
                 }
                 <span class="kw">if </span>entry.field_type().fastfield_cardinality() != <span class="prelude-val">Some</span>(Cardinality::SingleValue) {
                     <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::InvalidArgument(<span class="macro">format!</span>(
                         <span class="string">&quot;Only single value fast field Cardinality supported for sorting index {}&quot;</span>,
                         sort_by_field.field
                     )));
                 }
             }
             <span class="prelude-val">Ok</span>(())
         } <span class="kw">else </span>{
             <span class="prelude-val">Err</span>(TantivyError::InvalidArgument(
                 <span class="string">&quot;no schema passed&quot;</span>.to_string(),
             ))
         }
     }

     <span class="doccomment">/// Creates a new index given an implementation of the trait `Directory`.
     ///
     /// If a directory previously existed, it will be erased.
     </span><span class="kw">fn </span>create&lt;T: Into&lt;Box&lt;<span class="kw">dyn </span>Directory&gt;&gt;&gt;(<span class="self">self</span>, dir: T) -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
         <span class="self">self</span>.validate()<span class="question-mark">?</span>;
         <span class="kw">let </span>dir = dir.into();
         <span class="kw">let </span>directory = ManagedDirectory::wrap(dir)<span class="question-mark">?</span>;
         save_new_metas(
             <span class="self">self</span>.get_expect_schema()<span class="question-mark">?</span>,
             <span class="self">self</span>.index_settings.clone(),
             <span class="kw-2">&amp;</span>directory,
         )<span class="question-mark">?</span>;
         <span class="kw">let </span><span class="kw-2">mut </span>metas = IndexMeta::with_schema(<span class="self">self</span>.get_expect_schema()<span class="question-mark">?</span>);
         metas.index_settings = <span class="self">self</span>.index_settings;
         <span class="kw">let </span><span class="kw-2">mut </span>index = Index::open_from_metas(directory, <span class="kw-2">&amp;</span>metas, SegmentMetaInventory::default());
         index.set_tokenizers(<span class="self">self</span>.tokenizer_manager);
         <span class="prelude-val">Ok</span>(index)
     }
 }

 <span class="doccomment">/// Search Index
 </span><span class="attribute">#[derive(Clone)]
 </span><span class="kw">pub struct </span>Index {
     directory: ManagedDirectory,
     schema: Schema,
     settings: IndexSettings,
     executor: Arc&lt;Executor&gt;,
     tokenizers: TokenizerManager,
     inventory: SegmentMetaInventory,
 }

 <span class="kw">impl </span>Index {
     <span class="doccomment">/// Creates a new builder.
     </span><span class="kw">pub fn </span>builder() -&gt; IndexBuilder {
         IndexBuilder::new()
     }
     <span class="doccomment">/// Examines the directory to see if it contains an index.
     ///
     /// Effectively, it only checks for the presence of the `meta.json` file.
     </span><span class="kw">pub fn </span>exists(dir: <span class="kw-2">&amp;</span><span class="kw">dyn </span>Directory) -&gt; <span class="prelude-ty">Result</span>&lt;bool, OpenReadError&gt; {
         dir.exists(<span class="kw-2">&amp;</span>META_FILEPATH)
     }

     <span class="doccomment">/// Accessor to the search executor.
     ///
     /// This pool is used by default when calling `searcher.search(...)`
     /// to perform search on the individual segments.
     ///
     /// By default the executor is single thread, and simply runs in the calling thread.
     </span><span class="kw">pub fn </span>search_executor(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Executor {
         <span class="self">self</span>.executor.as_ref()
     }

     <span class="doccomment">/// Replace the default single thread search executor pool
     /// by a thread pool with a given number of threads.
     </span><span class="kw">pub fn </span>set_multithread_executor(<span class="kw-2">&amp;mut </span><span class="self">self</span>, num_threads: usize) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
         <span class="self">self</span>.executor = Arc::new(Executor::multi_thread(num_threads, <span class="string">&quot;tantivy-search-&quot;</span>)<span class="question-mark">?</span>);
         <span class="prelude-val">Ok</span>(())
     }

     <span class="doccomment">/// Replace the default single thread search executor pool
     /// by a thread pool with as many threads as there are CPUs on the system.
     </span><span class="kw">pub fn </span>set_default_multithread_executor(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
         <span class="kw">let </span>default_num_threads = num_cpus::get();
         <span class="self">self</span>.set_multithread_executor(default_num_threads)
     }

     <span class="doccomment">/// Creates a new index using the [`RamDirectory`].
     ///
     /// The index will be allocated in anonymous memory.
     /// This is useful for indexing small set of documents
     /// for instances like unit test or temporary in memory index.
     </span><span class="kw">pub fn </span>create_in_ram(schema: Schema) -&gt; Index {
         IndexBuilder::new().schema(schema).create_in_ram().unwrap()
     }

     <span class="doccomment">/// Creates a new index in a given filepath.
     /// The index will use the [`MmapDirectory`].
     ///
     /// If a previous index was in this directory, then it returns
     /// a [`TantivyError::IndexAlreadyExists`] error.
     </span><span class="attribute">#[cfg(feature = <span class="string">&quot;mmap&quot;</span>)]
     </span><span class="kw">pub fn </span>create_in_dir&lt;P: AsRef&lt;Path&gt;&gt;(
         directory_path: P,
         schema: Schema,
     ) -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
         IndexBuilder::new()
             .schema(schema)
             .create_in_dir(directory_path)
     }

     <span class="doccomment">/// Opens or creates a new index in the provided directory
     </span><span class="kw">pub fn </span>open_or_create&lt;T: Into&lt;Box&lt;<span class="kw">dyn </span>Directory&gt;&gt;&gt;(
         dir: T,
         schema: Schema,
     ) -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
         <span class="kw">let </span>dir = dir.into();
         IndexBuilder::new().schema(schema).open_or_create(dir)
     }

     <span class="doccomment">/// Creates a new index in a temp directory.
     ///
     /// The index will use the [`MmapDirectory`] in a newly created directory.
     /// The temp directory will be destroyed automatically when the [`Index`] object
     /// is destroyed.
     ///
     /// The temp directory is only used for testing the [`MmapDirectory`].
     /// For other unit tests, prefer the [`RamDirectory`],
     /// see: [`IndexBuilder::create_in_ram()`].
     </span><span class="attribute">#[cfg(feature = <span class="string">&quot;mmap&quot;</span>)]
     </span><span class="kw">pub fn </span>create_from_tempdir(schema: Schema) -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
         IndexBuilder::new().schema(schema).create_from_tempdir()
     }

     <span class="doccomment">/// Creates a new index given an implementation of the trait `Directory`.
     ///
     /// If a directory previously existed, it will be erased.
     </span><span class="kw">pub fn </span>create&lt;T: Into&lt;Box&lt;<span class="kw">dyn </span>Directory&gt;&gt;&gt;(
         dir: T,
         schema: Schema,
         settings: IndexSettings,
     ) -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
         <span class="kw">let </span>dir: Box&lt;<span class="kw">dyn </span>Directory&gt; = dir.into();
         <span class="kw">let </span><span class="kw-2">mut </span>builder = IndexBuilder::new().schema(schema);
         builder = builder.settings(settings);
         builder.create(dir)
     }

     <span class="doccomment">/// Creates a new index given a directory and an [`IndexMeta`].
     </span><span class="kw">fn </span>open_from_metas(
         directory: ManagedDirectory,
         metas: <span class="kw-2">&amp;</span>IndexMeta,
         inventory: SegmentMetaInventory,
     ) -&gt; Index {
         <span class="kw">let </span>schema = metas.schema.clone();
         Index {
             settings: metas.index_settings.clone(),
             directory,
             schema,
             tokenizers: TokenizerManager::default(),
             executor: Arc::new(Executor::single_thread()),
             inventory,
         }
     }

     <span class="doccomment">/// Setter for the tokenizer manager.
     </span><span class="kw">pub fn </span>set_tokenizers(<span class="kw-2">&amp;mut </span><span class="self">self</span>, tokenizers: TokenizerManager) {
         <span class="self">self</span>.tokenizers = tokenizers;
     }

     <span class="doccomment">/// Accessor for the tokenizer manager.
     </span><span class="kw">pub fn </span>tokenizers(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>TokenizerManager {
         <span class="kw-2">&amp;</span><span class="self">self</span>.tokenizers
     }

     <span class="doccomment">/// Get the tokenizer associated with a specific field.
     </span><span class="kw">pub fn </span>tokenizer_for_field(<span class="kw-2">&amp;</span><span class="self">self</span>, field: Field) -&gt; <span class="kw">crate</span>::Result&lt;TextAnalyzer&gt; {
         <span class="kw">let </span>field_entry = <span class="self">self</span>.schema.get_field_entry(field);
         <span class="kw">let </span>field_type = field_entry.field_type();
         <span class="kw">let </span>tokenizer_manager: <span class="kw-2">&amp;</span>TokenizerManager = <span class="self">self</span>.tokenizers();
         <span class="kw">let </span>indexing_options_opt = <span class="kw">match </span>field_type {
             FieldType::JsonObject(options) =&gt; options.get_text_indexing_options(),
             FieldType::Str(options) =&gt; options.get_indexing_options(),
             <span class="kw">_ </span>=&gt; {
                 <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::SchemaError(<span class="macro">format!</span>(
                     <span class="string">&quot;{:?} is not a text field.&quot;</span>,
                     field_entry.name()
                 )))
             }
         };
         <span class="kw">let </span>indexing_options = indexing_options_opt.ok_or_else(|| {
             TantivyError::InvalidArgument(<span class="macro">format!</span>(
                 <span class="string">&quot;No indexing options set for field {:?}&quot;</span>,
                 field_entry
             ))
         })<span class="question-mark">?</span>;

         tokenizer_manager
             .get(indexing_options.tokenizer())
             .ok_or_else(|| {
                 TantivyError::InvalidArgument(<span class="macro">format!</span>(
                     <span class="string">&quot;No Tokenizer found for field {:?}&quot;</span>,
                     field_entry
                 ))
             })
     }

     <span class="doccomment">/// Create a default [`IndexReader`] for the given index.
     ///
     /// See [`Index.reader_builder()`].
     </span><span class="kw">pub fn </span>reader(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;IndexReader&gt; {
         <span class="self">self</span>.reader_builder().try_into()
     }

     <span class="doccomment">/// Create a [`IndexReader`] for the given index.
     ///
     /// Most project should create at most one reader for a given index.
     /// This method is typically called only once per `Index` instance.
     </span><span class="kw">pub fn </span>reader_builder(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; IndexReaderBuilder {
         IndexReaderBuilder::new(<span class="self">self</span>.clone())
     }

     <span class="doccomment">/// Opens a new directory from an index path.
     </span><span class="attribute">#[cfg(feature = <span class="string">&quot;mmap&quot;</span>)]
     </span><span class="kw">pub fn </span>open_in_dir&lt;P: AsRef&lt;Path&gt;&gt;(directory_path: P) -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
         <span class="kw">let </span>mmap_directory = MmapDirectory::open(directory_path)<span class="question-mark">?</span>;
         Index::open(mmap_directory)
     }

     <span class="doccomment">/// Returns the list of the segment metas tracked by the index.
     ///
     /// Such segments can of course be part of the index,
     /// but also they could be segments being currently built or in the middle of a merge
     /// operation.
     </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>list_all_segment_metas(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;SegmentMeta&gt; {
         <span class="self">self</span>.inventory.all()
     }

     <span class="doccomment">/// Creates a new segment_meta (Advanced user only).
     ///
     /// As long as the `SegmentMeta` lives, the files associated with the
     /// `SegmentMeta` are guaranteed to not be garbage collected, regardless of
     /// whether the segment is recorded as part of the index or not.
     </span><span class="kw">pub fn </span>new_segment_meta(<span class="kw-2">&amp;</span><span class="self">self</span>, segment_id: SegmentId, max_doc: u32) -&gt; SegmentMeta {
         <span class="self">self</span>.inventory.new_segment_meta(segment_id, max_doc)
     }

     <span class="doccomment">/// Open the index using the provided directory
     </span><span class="kw">pub fn </span>open&lt;T: Into&lt;Box&lt;<span class="kw">dyn </span>Directory&gt;&gt;&gt;(directory: T) -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
         <span class="kw">let </span>directory = directory.into();
         <span class="kw">let </span>directory = ManagedDirectory::wrap(directory)<span class="question-mark">?</span>;
         <span class="kw">let </span>inventory = SegmentMetaInventory::default();
         <span class="kw">let </span>metas = load_metas(<span class="kw-2">&amp;</span>directory, <span class="kw-2">&amp;</span>inventory)<span class="question-mark">?</span>;
         <span class="kw">let </span>index = Index::open_from_metas(directory, <span class="kw-2">&amp;</span>metas, inventory);
         <span class="prelude-val">Ok</span>(index)
     }

     <span class="doccomment">/// Reads the index meta file from the directory.
     </span><span class="kw">pub fn </span>load_metas(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;IndexMeta&gt; {
         load_metas(<span class="self">self</span>.directory(), <span class="kw-2">&amp;</span><span class="self">self</span>.inventory)
     }

     <span class="doccomment">/// Open a new index writer. Attempts to acquire a lockfile.
     ///
     /// The lockfile should be deleted on drop, but it is possible
     /// that due to a panic or other error, a stale lockfile will be
     /// left in the index directory. If you are sure that no other
     /// `IndexWriter` on the system is accessing the index directory,
     /// it is safe to manually delete the lockfile.
     ///
     /// - `num_threads` defines the number of indexing workers that
     /// should work at the same time.
     ///
     /// - `overall_memory_arena_in_bytes` sets the amount of memory
     /// allocated for all indexing thread.
     /// Each thread will receive a budget of  `overall_memory_arena_in_bytes / num_threads`.
     ///
     /// # Errors
     /// If the lockfile already exists, returns `Error::DirectoryLockBusy` or an `Error::IoError`.
     /// If the memory arena per thread is too small or too big, returns
     /// `TantivyError::InvalidArgument`
     </span><span class="kw">pub fn </span>writer_with_num_threads(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
         num_threads: usize,
         overall_memory_arena_in_bytes: usize,
     ) -&gt; <span class="kw">crate</span>::Result&lt;IndexWriter&gt; {
         <span class="kw">let </span>directory_lock = <span class="self">self
             </span>.directory
             .acquire_lock(<span class="kw-2">&amp;</span>INDEX_WRITER_LOCK)
             .map_err(|err| {
                 TantivyError::LockFailure(
                     err,
                     <span class="prelude-val">Some</span>(
                         <span class="string">&quot;Failed to acquire index lock. If you are using a regular directory, this \
                          means there is already an `IndexWriter` working on this `Directory`, in \
                          this process or in a different process.&quot;
                             </span>.to_string(),
                     ),
                 )
             })<span class="question-mark">?</span>;
         <span class="kw">let </span>memory_arena_in_bytes_per_thread = overall_memory_arena_in_bytes / num_threads;
         IndexWriter::new(
             <span class="self">self</span>,
             num_threads,
             memory_arena_in_bytes_per_thread,
             directory_lock,
         )
     }

     <span class="doccomment">/// Helper to create an index writer for tests.
     ///
     /// That index writer only simply has a single thread and a memory arena of 10 MB.
     /// Using a single thread gives us a deterministic allocation of DocId.
     </span><span class="attribute">#[cfg(test)]
     </span><span class="kw">pub fn </span>writer_for_tests(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;IndexWriter&gt; {
         <span class="self">self</span>.writer_with_num_threads(<span class="number">1</span>, <span class="number">10_000_000</span>)
     }

     <span class="doccomment">/// Creates a multithreaded writer
     ///
     /// Tantivy will automatically define the number of threads to use, but
     /// no more than 8 threads.
     /// `overall_memory_arena_in_bytes` is the total target memory usage that will be split
     /// between a given number of threads.
     ///
     /// # Errors
     /// If the lockfile already exists, returns `Error::FileAlreadyExists`.
     /// If the memory arena per thread is too small or too big, returns
     /// `TantivyError::InvalidArgument`
     </span><span class="kw">pub fn </span>writer(<span class="kw-2">&amp;</span><span class="self">self</span>, memory_arena_num_bytes: usize) -&gt; <span class="kw">crate</span>::Result&lt;IndexWriter&gt; {
         <span class="kw">let </span><span class="kw-2">mut </span>num_threads = std::cmp::min(num_cpus::get(), MAX_NUM_THREAD);
         <span class="kw">let </span>memory_arena_num_bytes_per_thread = memory_arena_num_bytes / num_threads;
         <span class="kw">if </span>memory_arena_num_bytes_per_thread &lt; MEMORY_ARENA_NUM_BYTES_MIN {
             num_threads = (memory_arena_num_bytes / MEMORY_ARENA_NUM_BYTES_MIN).max(<span class="number">1</span>);
         }
         <span class="self">self</span>.writer_with_num_threads(num_threads, memory_arena_num_bytes)
     }

     <span class="doccomment">/// Accessor to the index settings
     </span><span class="kw">pub fn </span>settings(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>IndexSettings {
         <span class="kw-2">&amp;</span><span class="self">self</span>.settings
     }

     <span class="doccomment">/// Accessor to the index settings
     </span><span class="kw">pub fn </span>settings_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>IndexSettings {
         <span class="kw-2">&amp;mut </span><span class="self">self</span>.settings
     }

     <span class="doccomment">/// Accessor to the index schema
     ///
     /// The schema is actually cloned.
     </span><span class="kw">pub fn </span>schema(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Schema {
         <span class="self">self</span>.schema.clone()
     }

     <span class="doccomment">/// Returns the list of segments that are searchable
     </span><span class="kw">pub fn </span>searchable_segments(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;Vec&lt;Segment&gt;&gt; {
         <span class="prelude-val">Ok</span>(<span class="self">self
             </span>.searchable_segment_metas()<span class="question-mark">?
             </span>.into_iter()
             .map(|segment_meta| <span class="self">self</span>.segment(segment_meta))
             .collect())
     }

     <span class="attribute">#[doc(hidden)]
     </span><span class="kw">pub fn </span>segment(<span class="kw-2">&amp;</span><span class="self">self</span>, segment_meta: SegmentMeta) -&gt; Segment {
         Segment::for_index(<span class="self">self</span>.clone(), segment_meta)
     }

     <span class="doccomment">/// Creates a new segment.
     </span><span class="kw">pub fn </span>new_segment(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Segment {
         <span class="kw">let </span>segment_meta = <span class="self">self
             </span>.inventory
             .new_segment_meta(SegmentId::generate_random(), <span class="number">0</span>);
         <span class="self">self</span>.segment(segment_meta)
     }

     <span class="doccomment">/// Return a reference to the index directory.
     </span><span class="kw">pub fn </span>directory(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>ManagedDirectory {
         <span class="kw-2">&amp;</span><span class="self">self</span>.directory
     }

     <span class="doccomment">/// Return a mutable reference to the index directory.
     </span><span class="kw">pub fn </span>directory_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>ManagedDirectory {
         <span class="kw-2">&amp;mut </span><span class="self">self</span>.directory
     }

     <span class="doccomment">/// Reads the meta.json and returns the list of
     /// `SegmentMeta` from the last commit.
     </span><span class="kw">pub fn </span>searchable_segment_metas(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;Vec&lt;SegmentMeta&gt;&gt; {
         <span class="prelude-val">Ok</span>(<span class="self">self</span>.load_metas()<span class="question-mark">?</span>.segments)
     }

     <span class="doccomment">/// Returns the list of segment ids that are searchable.
     </span><span class="kw">pub fn </span>searchable_segment_ids(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;Vec&lt;SegmentId&gt;&gt; {
         <span class="prelude-val">Ok</span>(<span class="self">self
             </span>.searchable_segment_metas()<span class="question-mark">?
             </span>.iter()
             .map(SegmentMeta::id)
             .collect())
     }

     <span class="doccomment">/// Returns the set of corrupted files
     </span><span class="kw">pub fn </span>validate_checksum(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;HashSet&lt;PathBuf&gt;&gt; {
         <span class="kw">let </span>managed_files = <span class="self">self</span>.directory.list_managed_files();
         <span class="kw">let </span>active_segments_files: HashSet&lt;PathBuf&gt; = <span class="self">self
             </span>.searchable_segment_metas()<span class="question-mark">?
             </span>.iter()
             .flat_map(|segment_meta| segment_meta.list_files())
             .collect();
         <span class="kw">let </span>active_existing_files: HashSet&lt;<span class="kw-2">&amp;</span>PathBuf&gt; =
             active_segments_files.intersection(<span class="kw-2">&amp;</span>managed_files).collect();

         <span class="kw">let </span><span class="kw-2">mut </span>damaged_files = HashSet::new();
         <span class="kw">for </span>path <span class="kw">in </span>active_existing_files {
             <span class="kw">if </span>!<span class="self">self</span>.directory.validate_checksum(path)<span class="question-mark">? </span>{
                 damaged_files.insert((<span class="kw-2">*</span>path).clone());
             }
         }
         <span class="prelude-val">Ok</span>(damaged_files)
     }
 }

 <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Index {
     <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
         <span class="macro">write!</span>(f, <span class="string">&quot;Index({:?})&quot;</span>, <span class="self">self</span>.directory)
     }
 }

 <span class="attribute">#[cfg(test)]
 </span><span class="kw">mod </span>tests {
     <span class="kw">use </span><span class="kw">crate</span>::collector::Count;
     <span class="kw">use </span><span class="kw">crate</span>::directory::{RamDirectory, WatchCallback};
     <span class="kw">use </span><span class="kw">crate</span>::query::TermQuery;
     <span class="kw">use </span><span class="kw">crate</span>::schema::{Field, IndexRecordOption, Schema, INDEXED, TEXT};
     <span class="kw">use </span><span class="kw">crate</span>::tokenizer::TokenizerManager;
     <span class="kw">use crate</span>::{Directory, Index, IndexBuilder, IndexReader, IndexSettings, ReloadPolicy, Term};

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>test_indexer_for_field() {
         <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
         <span class="kw">let </span>num_likes_field = schema_builder.add_u64_field(<span class="string">&quot;num_likes&quot;</span>, INDEXED);
         <span class="kw">let </span>body_field = schema_builder.add_text_field(<span class="string">&quot;body&quot;</span>, TEXT);
         <span class="kw">let </span>schema = schema_builder.build();
         <span class="kw">let </span>index = Index::create_in_ram(schema);
         <span class="macro">assert!</span>(index.tokenizer_for_field(body_field).is_ok());
         <span class="macro">assert_eq!</span>(
             <span class="macro">format!</span>(<span class="string">&quot;{:?}&quot;</span>, index.tokenizer_for_field(num_likes_field).err()),
             <span class="string">&quot;Some(SchemaError(\&quot;\\\&quot;num_likes\\\&quot; is not a text field.\&quot;))&quot;
         </span>);
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>test_set_tokenizer_manager() {
         <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
         schema_builder.add_u64_field(<span class="string">&quot;num_likes&quot;</span>, INDEXED);
         schema_builder.add_text_field(<span class="string">&quot;body&quot;</span>, TEXT);
         <span class="kw">let </span>schema = schema_builder.build();
         <span class="kw">let </span>index = IndexBuilder::new()
             <span class="comment">// set empty tokenizer manager
             </span>.tokenizers(TokenizerManager::new())
             .schema(schema)
             .create_in_ram()
             .unwrap();
         <span class="macro">assert!</span>(index.tokenizers().get(<span class="string">&quot;raw&quot;</span>).is_none());
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>test_index_exists() {
         <span class="kw">let </span>directory: Box&lt;<span class="kw">dyn </span>Directory&gt; = Box::new(RamDirectory::create());
         <span class="macro">assert!</span>(!Index::exists(directory.as_ref()).unwrap());
         <span class="macro">assert!</span>(Index::create(
             directory.clone(),
             throw_away_schema(),
             IndexSettings::default()
         )
         .is_ok());
         <span class="macro">assert!</span>(Index::exists(directory.as_ref()).unwrap());
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>open_or_create_should_create() {
         <span class="kw">let </span>directory = RamDirectory::create();
         <span class="macro">assert!</span>(!Index::exists(<span class="kw-2">&amp;</span>directory).unwrap());
         <span class="macro">assert!</span>(Index::open_or_create(directory.clone(), throw_away_schema()).is_ok());
         <span class="macro">assert!</span>(Index::exists(<span class="kw-2">&amp;</span>directory).unwrap());
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>open_or_create_should_open() {
         <span class="kw">let </span>directory: Box&lt;<span class="kw">dyn </span>Directory&gt; = Box::new(RamDirectory::create());
         <span class="macro">assert!</span>(Index::create(
             directory.clone(),
             throw_away_schema(),
             IndexSettings::default()
         )
         .is_ok());
         <span class="macro">assert!</span>(Index::exists(directory.as_ref()).unwrap());
         <span class="macro">assert!</span>(Index::open_or_create(directory, throw_away_schema()).is_ok());
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>create_should_wipeoff_existing() {
         <span class="kw">let </span>directory: Box&lt;<span class="kw">dyn </span>Directory&gt; = Box::new(RamDirectory::create());
         <span class="macro">assert!</span>(Index::create(
             directory.clone(),
             throw_away_schema(),
             IndexSettings::default()
         )
         .is_ok());
         <span class="macro">assert!</span>(Index::exists(directory.as_ref()).unwrap());
         <span class="macro">assert!</span>(Index::create(
             directory,
             Schema::builder().build(),
             IndexSettings::default()
         )
         .is_ok());
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>open_or_create_exists_but_schema_does_not_match() {
         <span class="kw">let </span>directory = RamDirectory::create();
         <span class="macro">assert!</span>(Index::create(
             directory.clone(),
             throw_away_schema(),
             IndexSettings::default()
         )
         .is_ok());
         <span class="macro">assert!</span>(Index::exists(<span class="kw-2">&amp;</span>directory).unwrap());
         <span class="macro">assert!</span>(Index::open_or_create(directory.clone(), throw_away_schema()).is_ok());
         <span class="kw">let </span>err = Index::open_or_create(directory, Schema::builder().build());
         <span class="macro">assert_eq!</span>(
             <span class="macro">format!</span>(<span class="string">&quot;{:?}&quot;</span>, err.unwrap_err()),
             <span class="string">&quot;SchemaError(\&quot;An index exists but the schema does not match.\&quot;)&quot;
         </span>);
     }

     <span class="kw">fn </span>throw_away_schema() -&gt; Schema {
         <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
         <span class="kw">let _ </span>= schema_builder.add_u64_field(<span class="string">&quot;num_likes&quot;</span>, INDEXED);
         schema_builder.build()
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>test_index_on_commit_reload_policy() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
         <span class="kw">let </span>schema = throw_away_schema();
         <span class="kw">let </span>field = schema.get_field(<span class="string">&quot;num_likes&quot;</span>).unwrap();
         <span class="kw">let </span>index = Index::create_in_ram(schema);
         <span class="kw">let </span>reader = index
             .reader_builder()
             .reload_policy(ReloadPolicy::OnCommit)
             .try_into()
             .unwrap();
         <span class="macro">assert_eq!</span>(reader.searcher().num_docs(), <span class="number">0</span>);
         test_index_on_commit_reload_policy_aux(field, <span class="kw-2">&amp;</span>index, <span class="kw-2">&amp;</span>reader)
     }

     <span class="attribute">#[cfg(feature = <span class="string">&quot;mmap&quot;</span>)]
     </span><span class="kw">mod </span>mmap_specific {

         <span class="kw">use </span>std::path::PathBuf;

         <span class="kw">use </span>tempfile::TempDir;

         <span class="kw">use super</span>::<span class="kw-2">*</span>;
         <span class="kw">use </span><span class="kw">crate</span>::Directory;

         <span class="attribute">#[test]
         </span><span class="kw">fn </span>test_index_on_commit_reload_policy_mmap() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
             <span class="kw">let </span>schema = throw_away_schema();
             <span class="kw">let </span>field = schema.get_field(<span class="string">&quot;num_likes&quot;</span>).unwrap();
             <span class="kw">let </span>tempdir = TempDir::new().unwrap();
             <span class="kw">let </span>tempdir_path = PathBuf::from(tempdir.path());
             <span class="kw">let </span>index = Index::create_in_dir(<span class="kw-2">&amp;</span>tempdir_path, schema).unwrap();
             <span class="kw">let </span>reader = index
                 .reader_builder()
                 .reload_policy(ReloadPolicy::OnCommit)
                 .try_into()
                 .unwrap();
             <span class="macro">assert_eq!</span>(reader.searcher().num_docs(), <span class="number">0</span>);
             test_index_on_commit_reload_policy_aux(field, <span class="kw-2">&amp;</span>index, <span class="kw-2">&amp;</span>reader)
         }

         <span class="attribute">#[test]
         </span><span class="kw">fn </span>test_index_manual_policy_mmap() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
             <span class="kw">let </span>schema = throw_away_schema();
             <span class="kw">let </span>field = schema.get_field(<span class="string">&quot;num_likes&quot;</span>).unwrap();
             <span class="kw">let </span><span class="kw-2">mut </span>index = Index::create_from_tempdir(schema)<span class="question-mark">?</span>;
             <span class="kw">let </span><span class="kw-2">mut </span>writer = index.writer_for_tests()<span class="question-mark">?</span>;
             writer.commit()<span class="question-mark">?</span>;
             <span class="kw">let </span>reader = index
                 .reader_builder()
                 .reload_policy(ReloadPolicy::Manual)
                 .try_into()<span class="question-mark">?</span>;
             <span class="macro">assert_eq!</span>(reader.searcher().num_docs(), <span class="number">0</span>);
             writer.add_document(<span class="macro">doc!</span>(field=&gt;<span class="number">1u64</span>))<span class="question-mark">?</span>;
             <span class="kw">let </span>(sender, receiver) = crossbeam_channel::unbounded();
             <span class="kw">let </span>_handle = index.directory_mut().watch(WatchCallback::new(<span class="kw">move </span>|| {
                 <span class="kw">let _ </span>= sender.send(());
             }));
             writer.commit()<span class="question-mark">?</span>;
             <span class="macro">assert!</span>(receiver.recv().is_ok());
             <span class="macro">assert_eq!</span>(reader.searcher().num_docs(), <span class="number">0</span>);
             reader.reload()<span class="question-mark">?</span>;
             <span class="macro">assert_eq!</span>(reader.searcher().num_docs(), <span class="number">1</span>);
             <span class="prelude-val">Ok</span>(())
         }

         <span class="attribute">#[test]
         </span><span class="kw">fn </span>test_index_on_commit_reload_policy_different_directories() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
             <span class="kw">let </span>schema = throw_away_schema();
             <span class="kw">let </span>field = schema.get_field(<span class="string">&quot;num_likes&quot;</span>).unwrap();
             <span class="kw">let </span>tempdir = TempDir::new().unwrap();
             <span class="kw">let </span>tempdir_path = PathBuf::from(tempdir.path());
             <span class="kw">let </span>write_index = Index::create_in_dir(<span class="kw-2">&amp;</span>tempdir_path, schema).unwrap();
             <span class="kw">let </span>read_index = Index::open_in_dir(<span class="kw-2">&amp;</span>tempdir_path).unwrap();
             <span class="kw">let </span>reader = read_index
                 .reader_builder()
                 .reload_policy(ReloadPolicy::OnCommit)
                 .try_into()
                 .unwrap();
             <span class="macro">assert_eq!</span>(reader.searcher().num_docs(), <span class="number">0</span>);
             test_index_on_commit_reload_policy_aux(field, <span class="kw-2">&amp;</span>write_index, <span class="kw-2">&amp;</span>reader)
         }
     }
     <span class="kw">fn </span>test_index_on_commit_reload_policy_aux(
         field: Field,
         index: <span class="kw-2">&amp;</span>Index,
         reader: <span class="kw-2">&amp;</span>IndexReader,
     ) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
         <span class="kw">let </span><span class="kw-2">mut </span>reader_index = reader.index();
         <span class="kw">let </span>(sender, receiver) = crossbeam_channel::unbounded();
         <span class="kw">let </span>_watch_handle = reader_index
             .directory_mut()
             .watch(WatchCallback::new(<span class="kw">move </span>|| {
                 <span class="kw">let _ </span>= sender.send(());
             }));
         <span class="kw">let </span><span class="kw-2">mut </span>writer = index.writer_for_tests()<span class="question-mark">?</span>;
         <span class="macro">assert_eq!</span>(reader.searcher().num_docs(), <span class="number">0</span>);
         writer.add_document(<span class="macro">doc!</span>(field=&gt;<span class="number">1u64</span>))<span class="question-mark">?</span>;
         writer.commit().unwrap();
         <span class="comment">// We need a loop here because it is possible for notify to send more than
         // one modify event. It was observed on CI on MacOS.
         </span><span class="kw">loop </span>{
             <span class="macro">assert!</span>(receiver.recv().is_ok());
             <span class="kw">if </span>reader.searcher().num_docs() == <span class="number">1 </span>{
                 <span class="kw">break</span>;
             }
         }
         writer.add_document(<span class="macro">doc!</span>(field=&gt;<span class="number">2u64</span>))<span class="question-mark">?</span>;
         writer.commit().unwrap();
         <span class="comment">// ... Same as above
         </span><span class="kw">loop </span>{
             <span class="macro">assert!</span>(receiver.recv().is_ok());
             <span class="kw">if </span>reader.searcher().num_docs() == <span class="number">2 </span>{
                 <span class="kw">break</span>;
             }
         }
         <span class="prelude-val">Ok</span>(())
     }

     <span class="comment">// This test will not pass on windows, because windows
     // prevent deleting files that are MMapped.
     </span><span class="attribute">#[cfg(not(target_os = <span class="string">&quot;windows&quot;</span>))]
     #[test]
     </span><span class="kw">fn </span>garbage_collect_works_as_intended() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
         <span class="kw">let </span>directory = RamDirectory::create();
         <span class="kw">let </span>schema = throw_away_schema();
         <span class="kw">let </span>field = schema.get_field(<span class="string">&quot;num_likes&quot;</span>).unwrap();
         <span class="kw">let </span>index = Index::create(directory.clone(), schema, IndexSettings::default())<span class="question-mark">?</span>;

         <span class="kw">let </span><span class="kw-2">mut </span>writer = index.writer_with_num_threads(<span class="number">8</span>, <span class="number">24_000_000</span>).unwrap();
         <span class="kw">for </span>i <span class="kw">in </span><span class="number">0u64</span>..<span class="number">8_000u64 </span>{
             writer.add_document(<span class="macro">doc!</span>(field =&gt; i))<span class="question-mark">?</span>;
         }

         writer.commit()<span class="question-mark">?</span>;
         <span class="kw">let </span>mem_right_after_commit = directory.total_mem_usage();

         <span class="kw">let </span>reader = index
             .reader_builder()
             .reload_policy(ReloadPolicy::Manual)
             .try_into()<span class="question-mark">?</span>;
         <span class="macro">assert_eq!</span>(reader.searcher().num_docs(), <span class="number">8_000</span>);
         <span class="macro">assert_eq!</span>(reader.searcher().segment_readers().len(), <span class="number">8</span>);

         writer.wait_merging_threads()<span class="question-mark">?</span>;

         <span class="kw">let </span>mem_right_after_merge_finished = directory.total_mem_usage();

         reader.reload().unwrap();
         <span class="kw">let </span>searcher = reader.searcher();
         <span class="macro">assert_eq!</span>(searcher.segment_readers().len(), <span class="number">1</span>);
         <span class="macro">assert_eq!</span>(searcher.num_docs(), <span class="number">8_000</span>);
         <span class="macro">assert!</span>(
             mem_right_after_merge_finished &lt; mem_right_after_commit,
             <span class="string">&quot;(mem after merge){} is expected &lt; (mem before merge){}&quot;</span>,
             mem_right_after_merge_finished,
             mem_right_after_commit
         );
         <span class="prelude-val">Ok</span>(())
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>test_single_segment_index_writer() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
         <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
         <span class="kw">let </span>text_field = schema_builder.add_text_field(<span class="string">&quot;text&quot;</span>, TEXT);
         <span class="kw">let </span>schema = schema_builder.build();
         <span class="kw">let </span>directory = RamDirectory::default();
         <span class="kw">let </span><span class="kw-2">mut </span>single_segment_index_writer = Index::builder()
             .schema(schema)
             .single_segment_index_writer(directory, <span class="number">10_000_000</span>)<span class="question-mark">?</span>;
         <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10 </span>{
             <span class="kw">let </span>doc = <span class="macro">doc!</span>(text_field=&gt;<span class="string">&quot;hello&quot;</span>);
             single_segment_index_writer.add_document(doc)<span class="question-mark">?</span>;
         }
         <span class="kw">let </span>index = single_segment_index_writer.finalize()<span class="question-mark">?</span>;
         <span class="kw">let </span>searcher = index.reader()<span class="question-mark">?</span>.searcher();
         <span class="kw">let </span>term_query = TermQuery::new(
             Term::from_field_text(text_field, <span class="string">&quot;hello&quot;</span>),
             IndexRecordOption::Basic,
         );
         <span class="kw">let </span>count = searcher.search(<span class="kw-2">&amp;</span>term_query, <span class="kw-2">&amp;</span>Count)<span class="question-mark">?</span>;
         <span class="macro">assert_eq!</span>(count, <span class="number">10</span>);
         <span class="prelude-val">Ok</span>(())
     }
 }
 </code></pre></div>
 </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>