Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / tantivy / core / index_meta.rs.html
blob: 7008a5a2cf058d6c3fc49c3f24d24ee528f23ee8 [file] [log] [blame]
<!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_meta.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>index_meta.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::collections::HashSet;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::path::PathBuf;
<span class="kw">use </span>std::sync::atomic::AtomicBool;
<span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span>serde::{Deserialize, Serialize};
<span class="kw">use </span><span class="kw">super</span>::SegmentComponent;
<span class="kw">use </span><span class="kw">crate</span>::core::SegmentId;
<span class="kw">use </span><span class="kw">crate</span>::schema::Schema;
<span class="kw">use </span><span class="kw">crate</span>::store::Compressor;
<span class="kw">use crate</span>::{Inventory, Opstamp, TrackedObject};
<span class="attribute">#[derive(Clone, Debug, Serialize, Deserialize)]
</span><span class="kw">struct </span>DeleteMeta {
num_deleted_docs: u32,
opstamp: Opstamp,
}
<span class="attribute">#[derive(Clone, Default)]
</span><span class="kw">pub struct </span>SegmentMetaInventory {
inventory: Inventory&lt;InnerSegmentMeta&gt;,
}
<span class="kw">impl </span>SegmentMetaInventory {
<span class="doccomment">/// Lists all living `SegmentMeta` object at the time of the call.
</span><span class="kw">pub fn </span>all(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;SegmentMeta&gt; {
<span class="self">self</span>.inventory
.list()
.into_iter()
.map(SegmentMeta::from)
.collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;()
}
<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="kw">let </span>inner = InnerSegmentMeta {
segment_id,
max_doc,
include_temp_doc_store: Arc::new(AtomicBool::new(<span class="bool-val">true</span>)),
deletes: <span class="prelude-val">None</span>,
};
SegmentMeta::from(<span class="self">self</span>.inventory.track(inner))
}
}
<span class="doccomment">/// `SegmentMeta` contains simple meta information about a segment.
///
/// For instance the number of docs it contains,
/// how many are deleted, etc.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>SegmentMeta {
tracked: TrackedObject&lt;InnerSegmentMeta&gt;,
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>SegmentMeta {
<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; <span class="prelude-ty">Result</span>&lt;(), fmt::Error&gt; {
<span class="self">self</span>.tracked.fmt(f)
}
}
<span class="kw">impl </span>serde::Serialize <span class="kw">for </span>SegmentMeta {
<span class="kw">fn </span>serialize&lt;S&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
serializer: S,
) -&gt; <span class="prelude-ty">Result</span>&lt;&lt;S <span class="kw">as </span>serde::Serializer&gt;::Ok, &lt;S <span class="kw">as </span>serde::Serializer&gt;::Error&gt;
<span class="kw">where
</span>S: serde::Serializer,
{
<span class="self">self</span>.tracked.serialize(serializer)
}
}
<span class="kw">impl </span>From&lt;TrackedObject&lt;InnerSegmentMeta&gt;&gt; <span class="kw">for </span>SegmentMeta {
<span class="kw">fn </span>from(tracked: TrackedObject&lt;InnerSegmentMeta&gt;) -&gt; SegmentMeta {
SegmentMeta { tracked }
}
}
<span class="kw">impl </span>SegmentMeta {
<span class="comment">// Creates a new `SegmentMeta` object.
</span><span class="doccomment">/// Returns the segment id.
</span><span class="kw">pub fn </span>id(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; SegmentId {
<span class="self">self</span>.tracked.segment_id
}
<span class="doccomment">/// Removes the Component::TempStore from the alive list and
/// therefore marks the temp docstore file to be deleted by
/// the garbage collection.
</span><span class="kw">pub fn </span>untrack_temp_docstore(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="self">self</span>.tracked
.include_temp_doc_store
.store(<span class="bool-val">false</span>, std::sync::atomic::Ordering::Relaxed);
}
<span class="doccomment">/// Returns the number of deleted documents.
</span><span class="kw">pub fn </span>num_deleted_docs(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u32 {
<span class="self">self</span>.tracked
.deletes
.as_ref()
.map(|delete_meta| delete_meta.num_deleted_docs)
.unwrap_or(<span class="number">0u32</span>)
}
<span class="doccomment">/// Returns the list of files that
/// are required for the segment meta.
/// Note: Some of the returned files may not exist depending on the state of the segment.
///
/// This is useful as the way tantivy removes files
/// is by removing all files that have been created by tantivy
/// and are not used by any segment anymore.
</span><span class="kw">pub fn </span>list_files(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; HashSet&lt;PathBuf&gt; {
<span class="kw">if </span><span class="self">self
</span>.tracked
.include_temp_doc_store
.load(std::sync::atomic::Ordering::Relaxed)
{
SegmentComponent::iterator()
.map(|component| <span class="self">self</span>.relative_path(<span class="kw-2">*</span>component))
.collect::&lt;HashSet&lt;PathBuf&gt;&gt;()
} <span class="kw">else </span>{
SegmentComponent::iterator()
.filter(|comp| <span class="kw-2">*</span>comp != <span class="kw-2">&amp;</span>SegmentComponent::TempStore)
.map(|component| <span class="self">self</span>.relative_path(<span class="kw-2">*</span>component))
.collect::&lt;HashSet&lt;PathBuf&gt;&gt;()
}
}
<span class="doccomment">/// Returns the relative path of a component of our segment.
///
/// It just joins the segment id with the extension
/// associated with a segment component.
</span><span class="kw">pub fn </span>relative_path(<span class="kw-2">&amp;</span><span class="self">self</span>, component: SegmentComponent) -&gt; PathBuf {
<span class="kw">let </span><span class="kw-2">mut </span>path = <span class="self">self</span>.id().uuid_string();
path.push_str(<span class="kw-2">&amp;</span><span class="kw">match </span>component {
SegmentComponent::Postings =&gt; <span class="string">&quot;.idx&quot;</span>.to_string(),
SegmentComponent::Positions =&gt; <span class="string">&quot;.pos&quot;</span>.to_string(),
SegmentComponent::Terms =&gt; <span class="string">&quot;.term&quot;</span>.to_string(),
SegmentComponent::Store =&gt; <span class="string">&quot;.store&quot;</span>.to_string(),
SegmentComponent::TempStore =&gt; <span class="string">&quot;.store.temp&quot;</span>.to_string(),
SegmentComponent::FastFields =&gt; <span class="string">&quot;.fast&quot;</span>.to_string(),
SegmentComponent::FieldNorms =&gt; <span class="string">&quot;.fieldnorm&quot;</span>.to_string(),
SegmentComponent::Delete =&gt; <span class="macro">format!</span>(<span class="string">&quot;.{}.del&quot;</span>, <span class="self">self</span>.delete_opstamp().unwrap_or(<span class="number">0</span>)),
});
PathBuf::from(path)
}
<span class="doccomment">/// Return the highest doc id + 1
///
/// If there are no deletes, then num_docs = max_docs
/// and all the doc ids contains in this segment
/// are exactly (0..max_doc).
</span><span class="kw">pub fn </span>max_doc(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u32 {
<span class="self">self</span>.tracked.max_doc
}
<span class="doccomment">/// Return the number of documents in the segment.
</span><span class="kw">pub fn </span>num_docs(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u32 {
<span class="self">self</span>.max_doc() - <span class="self">self</span>.num_deleted_docs()
}
<span class="doccomment">/// Returns the `Opstamp` of the last delete operation
/// taken in account in this segment.
</span><span class="kw">pub fn </span>delete_opstamp(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Opstamp&gt; {
<span class="self">self</span>.tracked
.deletes
.as_ref()
.map(|delete_meta| delete_meta.opstamp)
}
<span class="doccomment">/// Returns true iff the segment meta contains
/// delete information.
</span><span class="kw">pub fn </span>has_deletes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.num_deleted_docs() &gt; <span class="number">0
</span>}
<span class="doccomment">/// Updates the max_doc value from the `SegmentMeta`.
///
/// This method is only used when updating `max_doc` from 0
/// as we finalize a fresh new segment.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>with_max_doc(<span class="self">self</span>, max_doc: u32) -&gt; SegmentMeta {
<span class="macro">assert_eq!</span>(<span class="self">self</span>.tracked.max_doc, <span class="number">0</span>);
<span class="macro">assert!</span>(<span class="self">self</span>.tracked.deletes.is_none());
<span class="kw">let </span>tracked = <span class="self">self</span>.tracked.map(<span class="kw">move </span>|inner_meta| InnerSegmentMeta {
segment_id: inner_meta.segment_id,
max_doc,
deletes: <span class="prelude-val">None</span>,
include_temp_doc_store: Arc::new(AtomicBool::new(<span class="bool-val">true</span>)),
});
SegmentMeta { tracked }
}
<span class="attribute">#[doc(hidden)]
#[must_use]
</span><span class="kw">pub fn </span>with_delete_meta(<span class="self">self</span>, num_deleted_docs: u32, opstamp: Opstamp) -&gt; SegmentMeta {
<span class="macro">assert!</span>(
num_deleted_docs &lt;= <span class="self">self</span>.max_doc(),
<span class="string">&quot;There cannot be more deleted docs than there are docs.&quot;
</span>);
<span class="kw">let </span>delete_meta = DeleteMeta {
num_deleted_docs,
opstamp,
};
<span class="kw">let </span>tracked = <span class="self">self</span>.tracked.map(<span class="kw">move </span>|inner_meta| InnerSegmentMeta {
segment_id: inner_meta.segment_id,
max_doc: inner_meta.max_doc,
include_temp_doc_store: Arc::new(AtomicBool::new(<span class="bool-val">true</span>)),
deletes: <span class="prelude-val">Some</span>(delete_meta),
});
SegmentMeta { tracked }
}
}
<span class="attribute">#[derive(Debug, Clone, Serialize, Deserialize)]
</span><span class="kw">struct </span>InnerSegmentMeta {
segment_id: SegmentId,
max_doc: u32,
deletes: <span class="prelude-ty">Option</span>&lt;DeleteMeta&gt;,
<span class="doccomment">/// If you want to avoid the SegmentComponent::TempStore file to be covered by
/// garbage collection and deleted, set this to true. This is used during merge.
</span><span class="attribute">#[serde(skip)]
#[serde(default = <span class="string">&quot;default_temp_store&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) include_temp_doc_store: Arc&lt;AtomicBool&gt;,
}
<span class="kw">fn </span>default_temp_store() -&gt; Arc&lt;AtomicBool&gt; {
Arc::new(AtomicBool::new(<span class="bool-val">false</span>))
}
<span class="kw">impl </span>InnerSegmentMeta {
<span class="kw">pub fn </span>track(<span class="self">self</span>, inventory: <span class="kw-2">&amp;</span>SegmentMetaInventory) -&gt; SegmentMeta {
SegmentMeta {
tracked: inventory.inventory.track(<span class="self">self</span>),
}
}
}
<span class="kw">fn </span>return_true() -&gt; bool {
<span class="bool-val">true
</span>}
<span class="kw">fn </span>is_true(val: <span class="kw-2">&amp;</span>bool) -&gt; bool {
<span class="kw-2">*</span>val
}
<span class="doccomment">/// Search Index Settings.
///
/// Contains settings which are applied on the whole
/// index, like presort documents.
</span><span class="attribute">#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
</span><span class="kw">pub struct </span>IndexSettings {
<span class="doccomment">/// Sorts the documents by information
/// provided in `IndexSortByField`
</span><span class="attribute">#[serde(skip_serializing_if = <span class="string">&quot;Option::is_none&quot;</span>)]
</span><span class="kw">pub </span>sort_by_field: <span class="prelude-ty">Option</span>&lt;IndexSortByField&gt;,
<span class="doccomment">/// The `Compressor` used to compress the doc store.
</span><span class="attribute">#[serde(default)]
</span><span class="kw">pub </span>docstore_compression: Compressor,
<span class="doccomment">/// If set to true, docstore compression will happen on a dedicated thread.
/// (defaults: true)
</span><span class="attribute">#[doc(hidden)]
#[serde(default = <span class="string">&quot;return_true&quot;</span>)]
#[serde(skip_serializing_if = <span class="string">&quot;is_true&quot;</span>)]
</span><span class="kw">pub </span>docstore_compress_dedicated_thread: bool,
<span class="attribute">#[serde(default = <span class="string">&quot;default_docstore_blocksize&quot;</span>)]
</span><span class="doccomment">/// The size of each block that will be compressed and written to disk
</span><span class="kw">pub </span>docstore_blocksize: usize,
}
<span class="doccomment">/// Must be a function to be compatible with serde defaults
</span><span class="kw">fn </span>default_docstore_blocksize() -&gt; usize {
<span class="number">16_384
</span>}
<span class="kw">impl </span>Default <span class="kw">for </span>IndexSettings {
<span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
sort_by_field: <span class="prelude-val">None</span>,
docstore_compression: Compressor::default(),
docstore_blocksize: default_docstore_blocksize(),
docstore_compress_dedicated_thread: <span class="bool-val">true</span>,
}
}
}
<span class="doccomment">/// Settings to presort the documents in an index
///
/// Presorting documents can greatly improve performance
/// in some scenarios, by applying top n
/// optimizations.
</span><span class="attribute">#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
</span><span class="kw">pub struct </span>IndexSortByField {
<span class="doccomment">/// The field to sort the documents by
</span><span class="kw">pub </span>field: String,
<span class="doccomment">/// The order to sort the documents by
</span><span class="kw">pub </span>order: Order,
}
<span class="doccomment">/// The order to sort by
</span><span class="attribute">#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
</span><span class="kw">pub enum </span>Order {
<span class="doccomment">/// Ascending Order
</span>Asc,
<span class="doccomment">/// Descending Order
</span>Desc,
}
<span class="kw">impl </span>Order {
<span class="doccomment">/// return if the Order is ascending
</span><span class="kw">pub fn </span>is_asc(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self </span>== <span class="kw-2">&amp;</span>Order::Asc
}
<span class="doccomment">/// return if the Order is descending
</span><span class="kw">pub fn </span>is_desc(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self </span>== <span class="kw-2">&amp;</span>Order::Desc
}
}
<span class="doccomment">/// Meta information about the `Index`.
///
/// This object is serialized on disk in the `meta.json` file.
/// It keeps information about
/// * the searchable segments,
/// * the index `docstamp`
/// * the schema
</span><span class="attribute">#[derive(Clone, Serialize)]
</span><span class="kw">pub struct </span>IndexMeta {
<span class="doccomment">/// `IndexSettings` to configure index options.
</span><span class="attribute">#[serde(default)]
</span><span class="kw">pub </span>index_settings: IndexSettings,
<span class="doccomment">/// List of `SegmentMeta` information associated with each finalized segment of the index.
</span><span class="kw">pub </span>segments: Vec&lt;SegmentMeta&gt;,
<span class="doccomment">/// Index `Schema`
</span><span class="kw">pub </span>schema: Schema,
<span class="doccomment">/// Opstamp associated with the last `commit` operation.
</span><span class="kw">pub </span>opstamp: Opstamp,
<span class="doccomment">/// Payload associated with the last commit.
///
/// Upon commit, clients can optionally add a small `String` payload to their commit
/// to help identify this commit.
/// This payload is entirely unused by tantivy.
</span><span class="attribute">#[serde(skip_serializing_if = <span class="string">&quot;Option::is_none&quot;</span>)]
</span><span class="kw">pub </span>payload: <span class="prelude-ty">Option</span>&lt;String&gt;,
}
<span class="attribute">#[derive(Deserialize, Debug)]
</span><span class="kw">struct </span>UntrackedIndexMeta {
<span class="kw">pub </span>segments: Vec&lt;InnerSegmentMeta&gt;,
<span class="attribute">#[serde(default)]
</span><span class="kw">pub </span>index_settings: IndexSettings,
<span class="kw">pub </span>schema: Schema,
<span class="kw">pub </span>opstamp: Opstamp,
<span class="attribute">#[serde(skip_serializing_if = <span class="string">&quot;Option::is_none&quot;</span>)]
</span><span class="kw">pub </span>payload: <span class="prelude-ty">Option</span>&lt;String&gt;,
}
<span class="kw">impl </span>UntrackedIndexMeta {
<span class="kw">pub fn </span>track(<span class="self">self</span>, inventory: <span class="kw-2">&amp;</span>SegmentMetaInventory) -&gt; IndexMeta {
IndexMeta {
index_settings: <span class="self">self</span>.index_settings,
segments: <span class="self">self
</span>.segments
.into_iter()
.map(|inner_seg_meta| inner_seg_meta.track(inventory))
.collect::&lt;Vec&lt;SegmentMeta&gt;&gt;(),
schema: <span class="self">self</span>.schema,
opstamp: <span class="self">self</span>.opstamp,
payload: <span class="self">self</span>.payload,
}
}
}
<span class="kw">impl </span>IndexMeta {
<span class="doccomment">/// Create an `IndexMeta` object representing a brand new `Index`
/// with the given index.
///
/// This new index does not contains any segments.
/// Opstamp will the value `0u64`.
</span><span class="kw">pub fn </span>with_schema(schema: Schema) -&gt; IndexMeta {
IndexMeta {
index_settings: IndexSettings::default(),
segments: <span class="macro">vec!</span>[],
schema,
opstamp: <span class="number">0u64</span>,
payload: <span class="prelude-val">None</span>,
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>deserialize(
meta_json: <span class="kw-2">&amp;</span>str,
inventory: <span class="kw-2">&amp;</span>SegmentMetaInventory,
) -&gt; serde_json::Result&lt;IndexMeta&gt; {
<span class="kw">let </span>untracked_meta_json: UntrackedIndexMeta = serde_json::from_str(meta_json)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(untracked_meta_json.track(inventory))
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>IndexMeta {
<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;{}&quot;</span>,
serde_json::ser::to_string(<span class="self">self</span>)
.expect(<span class="string">&quot;JSON serialization for IndexMeta should never fail.&quot;</span>)
)
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::IndexMeta;
<span class="kw">use </span><span class="kw">crate</span>::core::index_meta::UntrackedIndexMeta;
<span class="kw">use </span><span class="kw">crate</span>::schema::{Schema, TEXT};
<span class="kw">use </span><span class="kw">crate</span>::store::{Compressor, ZstdCompressor};
<span class="kw">use crate</span>::{IndexSettings, IndexSortByField, Order};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_metas() {
<span class="kw">let </span>schema = {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
schema_builder.add_text_field(<span class="string">&quot;text&quot;</span>, TEXT);
schema_builder.build()
};
<span class="kw">let </span>index_metas = IndexMeta {
index_settings: IndexSettings {
sort_by_field: <span class="prelude-val">Some</span>(IndexSortByField {
field: <span class="string">&quot;text&quot;</span>.to_string(),
order: Order::Asc,
}),
..Default::default()
},
segments: Vec::new(),
schema,
opstamp: <span class="number">0u64</span>,
payload: <span class="prelude-val">None</span>,
};
<span class="kw">let </span>json = serde_json::ser::to_string(<span class="kw-2">&amp;</span>index_metas).expect(<span class="string">&quot;serialization failed&quot;</span>);
<span class="macro">assert_eq!</span>(
json,
<span class="string">r#&quot;{&quot;index_settings&quot;:{&quot;sort_by_field&quot;:{&quot;field&quot;:&quot;text&quot;,&quot;order&quot;:&quot;Asc&quot;},&quot;docstore_compression&quot;:&quot;lz4&quot;,&quot;docstore_blocksize&quot;:16384},&quot;segments&quot;:[],&quot;schema&quot;:[{&quot;name&quot;:&quot;text&quot;,&quot;type&quot;:&quot;text&quot;,&quot;options&quot;:{&quot;indexing&quot;:{&quot;record&quot;:&quot;position&quot;,&quot;fieldnorms&quot;:true,&quot;tokenizer&quot;:&quot;default&quot;},&quot;stored&quot;:false,&quot;fast&quot;:false}}],&quot;opstamp&quot;:0}&quot;#
</span>);
<span class="kw">let </span>deser_meta: UntrackedIndexMeta = serde_json::from_str(<span class="kw-2">&amp;</span>json).unwrap();
<span class="macro">assert_eq!</span>(index_metas.index_settings, deser_meta.index_settings);
<span class="macro">assert_eq!</span>(index_metas.schema, deser_meta.schema);
<span class="macro">assert_eq!</span>(index_metas.opstamp, deser_meta.opstamp);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_metas_zstd_compressor() {
<span class="kw">let </span>schema = {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
schema_builder.add_text_field(<span class="string">&quot;text&quot;</span>, TEXT);
schema_builder.build()
};
<span class="kw">let </span>index_metas = IndexMeta {
index_settings: IndexSettings {
sort_by_field: <span class="prelude-val">Some</span>(IndexSortByField {
field: <span class="string">&quot;text&quot;</span>.to_string(),
order: Order::Asc,
}),
docstore_compression: <span class="kw">crate</span>::store::Compressor::Zstd(ZstdCompressor {
compression_level: <span class="prelude-val">Some</span>(<span class="number">4</span>),
}),
docstore_blocksize: <span class="number">1_000_000</span>,
docstore_compress_dedicated_thread: <span class="bool-val">true</span>,
},
segments: Vec::new(),
schema,
opstamp: <span class="number">0u64</span>,
payload: <span class="prelude-val">None</span>,
};
<span class="kw">let </span>json = serde_json::ser::to_string(<span class="kw-2">&amp;</span>index_metas).expect(<span class="string">&quot;serialization failed&quot;</span>);
<span class="macro">assert_eq!</span>(
json,
<span class="string">r#&quot;{&quot;index_settings&quot;:{&quot;sort_by_field&quot;:{&quot;field&quot;:&quot;text&quot;,&quot;order&quot;:&quot;Asc&quot;},&quot;docstore_compression&quot;:&quot;zstd(compression_level=4)&quot;,&quot;docstore_blocksize&quot;:1000000},&quot;segments&quot;:[],&quot;schema&quot;:[{&quot;name&quot;:&quot;text&quot;,&quot;type&quot;:&quot;text&quot;,&quot;options&quot;:{&quot;indexing&quot;:{&quot;record&quot;:&quot;position&quot;,&quot;fieldnorms&quot;:true,&quot;tokenizer&quot;:&quot;default&quot;},&quot;stored&quot;:false,&quot;fast&quot;:false}}],&quot;opstamp&quot;:0}&quot;#
</span>);
<span class="kw">let </span>deser_meta: UntrackedIndexMeta = serde_json::from_str(<span class="kw-2">&amp;</span>json).unwrap();
<span class="macro">assert_eq!</span>(index_metas.index_settings, deser_meta.index_settings);
<span class="macro">assert_eq!</span>(index_metas.schema, deser_meta.schema);
<span class="macro">assert_eq!</span>(index_metas.opstamp, deser_meta.opstamp);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_metas_invalid_comp() {
<span class="kw">let </span>json = <span class="string">r#&quot;{&quot;index_settings&quot;:{&quot;sort_by_field&quot;:{&quot;field&quot;:&quot;text&quot;,&quot;order&quot;:&quot;Asc&quot;},&quot;docstore_compression&quot;:&quot;zsstd&quot;,&quot;docstore_blocksize&quot;:1000000},&quot;segments&quot;:[],&quot;schema&quot;:[{&quot;name&quot;:&quot;text&quot;,&quot;type&quot;:&quot;text&quot;,&quot;options&quot;:{&quot;indexing&quot;:{&quot;record&quot;:&quot;position&quot;,&quot;fieldnorms&quot;:true,&quot;tokenizer&quot;:&quot;default&quot;},&quot;stored&quot;:false,&quot;fast&quot;:false}}],&quot;opstamp&quot;:0}&quot;#</span>;
<span class="kw">let </span>err = serde_json::from_str::&lt;UntrackedIndexMeta&gt;(json).unwrap_err();
<span class="macro">assert_eq!</span>(
err.to_string(),
<span class="string">&quot;unknown variant `zsstd`, expected one of `none`, `lz4`, `brotli`, `snappy`, `zstd`, \
`zstd(compression_level=5)` at line 1 column 96&quot;
</span>.to_string()
);
<span class="kw">let </span>json = <span class="string">r#&quot;{&quot;index_settings&quot;:{&quot;sort_by_field&quot;:{&quot;field&quot;:&quot;text&quot;,&quot;order&quot;:&quot;Asc&quot;},&quot;docstore_compression&quot;:&quot;zstd(bla=10)&quot;,&quot;docstore_blocksize&quot;:1000000},&quot;segments&quot;:[],&quot;schema&quot;:[{&quot;name&quot;:&quot;text&quot;,&quot;type&quot;:&quot;text&quot;,&quot;options&quot;:{&quot;indexing&quot;:{&quot;record&quot;:&quot;position&quot;,&quot;fieldnorms&quot;:true,&quot;tokenizer&quot;:&quot;default&quot;},&quot;stored&quot;:false,&quot;fast&quot;:false}}],&quot;opstamp&quot;:0}&quot;#</span>;
<span class="kw">let </span>err = serde_json::from_str::&lt;UntrackedIndexMeta&gt;(json).unwrap_err();
<span class="macro">assert_eq!</span>(
err.to_string(),
<span class="string">&quot;unknown zstd option \&quot;bla\&quot; at line 1 column 103&quot;</span>.to_string()
);
}
<span class="attribute">#[test]
#[cfg(feature = <span class="string">&quot;lz4-compression&quot;</span>)]
</span><span class="kw">fn </span>test_index_settings_default() {
<span class="kw">let </span><span class="kw-2">mut </span>index_settings = IndexSettings::default();
<span class="macro">assert_eq!</span>(
index_settings,
IndexSettings {
sort_by_field: <span class="prelude-val">None</span>,
docstore_compression: Compressor::default(),
docstore_compress_dedicated_thread: <span class="bool-val">true</span>,
docstore_blocksize: <span class="number">16_384
</span>}
);
{
<span class="kw">let </span>index_settings_json = serde_json::to_value(<span class="kw-2">&amp;</span>index_settings).unwrap();
<span class="macro">assert_eq!</span>(
index_settings_json,
<span class="macro">serde_json::json!</span>({
<span class="string">&quot;docstore_compression&quot;</span>: <span class="string">&quot;lz4&quot;</span>,
<span class="string">&quot;docstore_blocksize&quot;</span>: <span class="number">16384
</span>})
);
<span class="kw">let </span>index_settings_deser: IndexSettings =
serde_json::from_value(index_settings_json).unwrap();
<span class="macro">assert_eq!</span>(index_settings_deser, index_settings);
}
{
index_settings.docstore_compress_dedicated_thread = <span class="bool-val">false</span>;
<span class="kw">let </span>index_settings_json = serde_json::to_value(<span class="kw-2">&amp;</span>index_settings).unwrap();
<span class="macro">assert_eq!</span>(
index_settings_json,
<span class="macro">serde_json::json!</span>({
<span class="string">&quot;docstore_compression&quot;</span>: <span class="string">&quot;lz4&quot;</span>,
<span class="string">&quot;docstore_blocksize&quot;</span>: <span class="number">16384</span>,
<span class="string">&quot;docstore_compress_dedicated_thread&quot;</span>: <span class="bool-val">false</span>,
})
);
<span class="kw">let </span>index_settings_deser: IndexSettings =
serde_json::from_value(index_settings_json).unwrap();
<span class="macro">assert_eq!</span>(index_settings_deser, index_settings);
}
}
}
</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>