Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / tantivy / reader / mod.rs.html
blob: eb6baab4ef31197e4730ba1ce2e9645f12313e39 [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/reader/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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>
</pre><pre class="rust"><code><span class="kw">mod </span>warming;
<span class="kw">use </span>std::convert::TryInto;
<span class="kw">use </span>std::sync::atomic::AtomicU64;
<span class="kw">use </span>std::sync::{atomic, Arc, Weak};
<span class="kw">use </span>arc_swap::ArcSwap;
<span class="kw">pub use </span>warming::Warmer;
<span class="kw">use </span><span class="self">self</span>::warming::WarmingState;
<span class="kw">use </span><span class="kw">crate</span>::core::searcher::{SearcherGeneration, SearcherInner};
<span class="kw">use </span><span class="kw">crate</span>::directory::{Directory, WatchCallback, WatchHandle, META_LOCK};
<span class="kw">use </span><span class="kw">crate</span>::store::DOCSTORE_CACHE_CAPACITY;
<span class="kw">use crate</span>::{Index, Inventory, Searcher, SegmentReader, TrackedObject};
<span class="doccomment">/// Defines when a new version of the index should be reloaded.
///
/// Regardless of whether you search and index in the same process, tantivy does not necessarily
/// reflects the change that are committed to your index. `ReloadPolicy` precisely helps you define
/// when you want your index to be reloaded.
</span><span class="attribute">#[derive(Clone, Copy)]
</span><span class="kw">pub enum </span>ReloadPolicy {
<span class="doccomment">/// The index is entirely reloaded manually.
/// All updates of the index should be manual.
///
/// No change is reflected automatically. You are required to call [`IndexReader::reload()`]
/// manually.
</span>Manual,
<span class="doccomment">/// The index is reloaded within milliseconds after a new commit is available.
/// This is made possible by watching changes in the `meta.json` file.
</span>OnCommit, <span class="comment">// TODO add NEAR_REAL_TIME(target_ms)
</span>}
<span class="doccomment">/// [`IndexReader`] builder
///
/// It makes it possible to configure:
/// - [`ReloadPolicy`] defining when new index versions are detected
/// - [`Warmer`] implementations
/// - number of warming threads, for parallelizing warming work
/// - The cache size of the underlying doc store readers.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>IndexReaderBuilder {
reload_policy: ReloadPolicy,
index: Index,
warmers: Vec&lt;Weak&lt;<span class="kw">dyn </span>Warmer&gt;&gt;,
num_warming_threads: usize,
doc_store_cache_size: usize,
}
<span class="kw">impl </span>IndexReaderBuilder {
<span class="attribute">#[must_use]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(index: Index) -&gt; IndexReaderBuilder {
IndexReaderBuilder {
reload_policy: ReloadPolicy::OnCommit,
index,
warmers: Vec::new(),
num_warming_threads: <span class="number">1</span>,
doc_store_cache_size: DOCSTORE_CACHE_CAPACITY,
}
}
<span class="doccomment">/// Builds the reader.
///
/// Building the reader is a non-trivial operation that requires
/// to open different segment readers. It may take hundreds of milliseconds
/// of time and it may return an error.
</span><span class="kw">pub fn </span>try_into(<span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;IndexReader&gt; {
<span class="kw">let </span>searcher_generation_inventory = Inventory::default();
<span class="kw">let </span>warming_state = WarmingState::new(
<span class="self">self</span>.num_warming_threads,
<span class="self">self</span>.warmers,
searcher_generation_inventory.clone(),
)<span class="question-mark">?</span>;
<span class="kw">let </span>inner_reader = InnerIndexReader::new(
<span class="self">self</span>.doc_store_cache_size,
<span class="self">self</span>.index,
warming_state,
searcher_generation_inventory,
)<span class="question-mark">?</span>;
<span class="kw">let </span>inner_reader_arc = Arc::new(inner_reader);
<span class="kw">let </span>watch_handle_opt: <span class="prelude-ty">Option</span>&lt;WatchHandle&gt; = <span class="kw">match </span><span class="self">self</span>.reload_policy {
ReloadPolicy::Manual =&gt; {
<span class="comment">// No need to set anything...
</span><span class="prelude-val">None
</span>}
ReloadPolicy::OnCommit =&gt; {
<span class="kw">let </span>inner_reader_arc_clone = inner_reader_arc.clone();
<span class="kw">let </span>callback = <span class="kw">move </span>|| {
<span class="kw">if let </span><span class="prelude-val">Err</span>(err) = inner_reader_arc_clone.reload() {
<span class="macro">error!</span>(
<span class="string">&quot;Error while loading searcher after commit was detected. {:?}&quot;</span>,
err
);
}
};
<span class="kw">let </span>watch_handle = inner_reader_arc
.index
.directory()
.watch(WatchCallback::new(callback))<span class="question-mark">?</span>;
<span class="prelude-val">Some</span>(watch_handle)
}
};
<span class="prelude-val">Ok</span>(IndexReader {
inner: inner_reader_arc,
_watch_handle_opt: watch_handle_opt,
})
}
<span class="doccomment">/// Sets the reload_policy.
///
/// See [`ReloadPolicy`] for more details.
</span><span class="attribute">#[must_use]
</span><span class="kw">pub fn </span>reload_policy(<span class="kw-2">mut </span><span class="self">self</span>, reload_policy: ReloadPolicy) -&gt; IndexReaderBuilder {
<span class="self">self</span>.reload_policy = reload_policy;
<span class="self">self
</span>}
<span class="doccomment">/// Sets the cache size of the doc store readers.
///
/// The doc store readers cache by default DOCSTORE_CACHE_CAPACITY(100) decompressed blocks.
</span><span class="attribute">#[must_use]
</span><span class="kw">pub fn </span>doc_store_cache_size(<span class="kw-2">mut </span><span class="self">self</span>, doc_store_cache_size: usize) -&gt; IndexReaderBuilder {
<span class="self">self</span>.doc_store_cache_size = doc_store_cache_size;
<span class="self">self
</span>}
<span class="doccomment">/// Set the [`Warmer`]s that are invoked when reloading searchable segments.
</span><span class="attribute">#[must_use]
</span><span class="kw">pub fn </span>warmers(<span class="kw-2">mut </span><span class="self">self</span>, warmers: Vec&lt;Weak&lt;<span class="kw">dyn </span>Warmer&gt;&gt;) -&gt; IndexReaderBuilder {
<span class="self">self</span>.warmers = warmers;
<span class="self">self
</span>}
<span class="doccomment">/// Sets the number of warming threads.
///
/// This allows parallelizing warming work when there are multiple [`Warmer`] registered with
/// the [`IndexReader`].
</span><span class="attribute">#[must_use]
</span><span class="kw">pub fn </span>num_warming_threads(<span class="kw-2">mut </span><span class="self">self</span>, num_warming_threads: usize) -&gt; IndexReaderBuilder {
<span class="self">self</span>.num_warming_threads = num_warming_threads;
<span class="self">self
</span>}
}
<span class="kw">impl </span>TryInto&lt;IndexReader&gt; <span class="kw">for </span>IndexReaderBuilder {
<span class="kw">type </span>Error = <span class="kw">crate</span>::TantivyError;
<span class="kw">fn </span>try_into(<span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;IndexReader&gt; {
IndexReaderBuilder::try_into(<span class="self">self</span>)
}
}
<span class="kw">struct </span>InnerIndexReader {
doc_store_cache_size: usize,
index: Index,
warming_state: WarmingState,
searcher: arc_swap::ArcSwap&lt;SearcherInner&gt;,
searcher_generation_counter: Arc&lt;AtomicU64&gt;,
searcher_generation_inventory: Inventory&lt;SearcherGeneration&gt;,
}
<span class="kw">impl </span>InnerIndexReader {
<span class="kw">fn </span>new(
doc_store_cache_size: usize,
index: Index,
warming_state: WarmingState,
<span class="comment">// The searcher_generation_inventory is not used as source, but as target to track the
// loaded segments.
</span>searcher_generation_inventory: Inventory&lt;SearcherGeneration&gt;,
) -&gt; <span class="kw">crate</span>::Result&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>searcher_generation_counter: Arc&lt;AtomicU64&gt; = Default::default();
<span class="kw">let </span>searcher = <span class="self">Self</span>::create_searcher(
<span class="kw-2">&amp;</span>index,
doc_store_cache_size,
<span class="kw-2">&amp;</span>warming_state,
<span class="kw-2">&amp;</span>searcher_generation_counter,
<span class="kw-2">&amp;</span>searcher_generation_inventory,
)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(InnerIndexReader {
doc_store_cache_size,
index,
warming_state,
searcher: ArcSwap::from(searcher),
searcher_generation_counter,
searcher_generation_inventory,
})
}
<span class="doccomment">/// Opens the freshest segments [`SegmentReader`].
///
/// This function acquires a lot to prevent GC from removing files
/// as we are opening our index.
</span><span class="kw">fn </span>open_segment_readers(index: <span class="kw-2">&amp;</span>Index) -&gt; <span class="kw">crate</span>::Result&lt;Vec&lt;SegmentReader&gt;&gt; {
<span class="comment">// Prevents segment files from getting deleted while we are in the process of opening them
</span><span class="kw">let </span>_meta_lock = index.directory().acquire_lock(<span class="kw-2">&amp;</span>META_LOCK)<span class="question-mark">?</span>;
<span class="kw">let </span>searchable_segments = index.searchable_segments()<span class="question-mark">?</span>;
<span class="kw">let </span>segment_readers = searchable_segments
.iter()
.map(SegmentReader::open)
.collect::&lt;<span class="kw">crate</span>::Result&lt;<span class="kw">_</span>&gt;&gt;()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(segment_readers)
}
<span class="kw">fn </span>track_segment_readers_in_inventory(
segment_readers: <span class="kw-2">&amp;</span>[SegmentReader],
searcher_generation_counter: <span class="kw-2">&amp;</span>Arc&lt;AtomicU64&gt;,
searcher_generation_inventory: <span class="kw-2">&amp;</span>Inventory&lt;SearcherGeneration&gt;,
) -&gt; TrackedObject&lt;SearcherGeneration&gt; {
<span class="kw">let </span>generation_id = searcher_generation_counter.fetch_add(<span class="number">1</span>, atomic::Ordering::AcqRel);
<span class="kw">let </span>searcher_generation =
SearcherGeneration::from_segment_readers(segment_readers, generation_id);
searcher_generation_inventory.track(searcher_generation)
}
<span class="kw">fn </span>create_searcher(
index: <span class="kw-2">&amp;</span>Index,
doc_store_cache_size: usize,
warming_state: <span class="kw-2">&amp;</span>WarmingState,
searcher_generation_counter: <span class="kw-2">&amp;</span>Arc&lt;AtomicU64&gt;,
searcher_generation_inventory: <span class="kw-2">&amp;</span>Inventory&lt;SearcherGeneration&gt;,
) -&gt; <span class="kw">crate</span>::Result&lt;Arc&lt;SearcherInner&gt;&gt; {
<span class="kw">let </span>segment_readers = <span class="self">Self</span>::open_segment_readers(index)<span class="question-mark">?</span>;
<span class="kw">let </span>searcher_generation = <span class="self">Self</span>::track_segment_readers_in_inventory(
<span class="kw-2">&amp;</span>segment_readers,
searcher_generation_counter,
searcher_generation_inventory,
);
<span class="kw">let </span>schema = index.schema();
<span class="kw">let </span>searcher = Arc::new(SearcherInner::new(
schema,
index.clone(),
segment_readers,
searcher_generation,
doc_store_cache_size,
)<span class="question-mark">?</span>);
warming_state.warm_new_searcher_generation(<span class="kw-2">&amp;</span>searcher.clone().into())<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(searcher)
}
<span class="kw">fn </span>reload(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span>searcher = <span class="self">Self</span>::create_searcher(
<span class="kw-2">&amp;</span><span class="self">self</span>.index,
<span class="self">self</span>.doc_store_cache_size,
<span class="kw-2">&amp;</span><span class="self">self</span>.warming_state,
<span class="kw-2">&amp;</span><span class="self">self</span>.searcher_generation_counter,
<span class="kw-2">&amp;</span><span class="self">self</span>.searcher_generation_inventory,
)<span class="question-mark">?</span>;
<span class="self">self</span>.searcher.store(searcher);
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>searcher(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Searcher {
<span class="self">self</span>.searcher.load().clone().into()
}
}
<span class="doccomment">/// `IndexReader` is your entry point to read and search the index.
///
/// It controls when a new version of the index should be loaded and lends
/// you instances of `Searcher` for the last loaded version.
///
/// `IndexReader` just wraps an `Arc`.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>IndexReader {
inner: Arc&lt;InnerIndexReader&gt;,
_watch_handle_opt: <span class="prelude-ty">Option</span>&lt;WatchHandle&gt;,
}
<span class="kw">impl </span>IndexReader {
<span class="attribute">#[cfg(test)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>index(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Index {
<span class="self">self</span>.inner.index.clone()
}
<span class="doccomment">/// Update searchers so that they reflect the state of the last
/// `.commit()`.
///
/// If you set up the [`ReloadPolicy::OnCommit`] (which is the default)
/// every commit should be rapidly reflected on your `IndexReader` and you should
/// not need to call `reload()` at all.
///
/// This automatic reload can take 10s of milliseconds to kick in however, and in unit tests
/// it can be nice to deterministically force the reload of searchers.
</span><span class="kw">pub fn </span>reload(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="self">self</span>.inner.reload()
}
<span class="doccomment">/// Returns a searcher
///
/// This method should be called every single time a search
/// query is performed.
///
/// The same searcher must be used for a given query, as it ensures
/// the use of a consistent segment set.
</span><span class="kw">pub fn </span>searcher(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Searcher {
<span class="self">self</span>.inner.searcher()
}
}
</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>