blob: 0efc3936a21ae5abc89448522b2f83f6644a94f1 [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/directory/directory.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>directory.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::io::Write;
<span class="kw">use </span>std::marker::{Send, Sync};
<span class="kw">use </span>std::path::{Path, PathBuf};
<span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span>std::time::Duration;
<span class="kw">use </span>std::{fmt, io, thread};
<span class="kw">use </span><span class="kw">crate</span>::directory::directory_lock::Lock;
<span class="kw">use </span><span class="kw">crate</span>::directory::error::{DeleteError, LockError, OpenReadError, OpenWriteError};
<span class="kw">use </span><span class="kw">crate</span>::directory::{FileHandle, FileSlice, WatchCallback, WatchHandle, WritePtr};
<span class="doccomment">/// Retry the logic of acquiring locks is pretty simple.
/// We just retry `n` times after a given `duratio`, both
/// depending on the type of lock.
</span><span class="kw">struct </span>RetryPolicy {
num_retries: usize,
wait_in_ms: u64,
}
<span class="kw">impl </span>RetryPolicy {
<span class="kw">fn </span>no_retry() -&gt; RetryPolicy {
RetryPolicy {
num_retries: <span class="number">0</span>,
wait_in_ms: <span class="number">0</span>,
}
}
<span class="kw">fn </span>wait_and_retry(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; bool {
<span class="kw">if </span><span class="self">self</span>.num_retries == <span class="number">0 </span>{
<span class="bool-val">false
</span>} <span class="kw">else </span>{
<span class="self">self</span>.num_retries -= <span class="number">1</span>;
<span class="kw">let </span>wait_duration = Duration::from_millis(<span class="self">self</span>.wait_in_ms);
thread::sleep(wait_duration);
<span class="bool-val">true
</span>}
}
}
<span class="doccomment">/// The `DirectoryLock` is an object that represents a file lock.
///
/// It is associated with a lock file, that gets deleted on `Drop.`
</span><span class="kw">pub struct </span>DirectoryLock(Box&lt;<span class="kw">dyn </span>Send + Sync + <span class="lifetime">&#39;static</span>&gt;);
<span class="kw">struct </span>DirectoryLockGuard {
directory: Box&lt;<span class="kw">dyn </span>Directory&gt;,
path: PathBuf,
}
<span class="kw">impl</span>&lt;T: Send + Sync + <span class="lifetime">&#39;static</span>&gt; From&lt;Box&lt;T&gt;&gt; <span class="kw">for </span>DirectoryLock {
<span class="kw">fn </span>from(underlying: Box&lt;T&gt;) -&gt; <span class="self">Self </span>{
DirectoryLock(underlying)
}
}
<span class="kw">impl </span>Drop <span class="kw">for </span>DirectoryLockGuard {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">if let </span><span class="prelude-val">Err</span>(e) = <span class="self">self</span>.directory.delete(<span class="kw-2">&amp;</span><span class="self">self</span>.path) {
<span class="macro">error!</span>(<span class="string">&quot;Failed to remove the lock file. {:?}&quot;</span>, e);
}
}
}
<span class="kw">enum </span>TryAcquireLockError {
FileExists,
IoError(Arc&lt;io::Error&gt;),
}
<span class="kw">impl </span>From&lt;io::Error&gt; <span class="kw">for </span>TryAcquireLockError {
<span class="kw">fn </span>from(io_error: io::Error) -&gt; <span class="self">Self </span>{
<span class="self">Self</span>::IoError(Arc::new(io_error))
}
}
<span class="kw">fn </span>try_acquire_lock(
filepath: <span class="kw-2">&amp;</span>Path,
directory: <span class="kw-2">&amp;mut </span><span class="kw">dyn </span>Directory,
) -&gt; <span class="prelude-ty">Result</span>&lt;DirectoryLock, TryAcquireLockError&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>write = directory.open_write(filepath).map_err(|e| <span class="kw">match </span>e {
OpenWriteError::FileAlreadyExists(<span class="kw">_</span>) =&gt; TryAcquireLockError::FileExists,
OpenWriteError::IoError { io_error, .. } =&gt; TryAcquireLockError::IoError(io_error),
})<span class="question-mark">?</span>;
write.flush().map_err(TryAcquireLockError::from)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(DirectoryLock::from(Box::new(DirectoryLockGuard {
directory: directory.box_clone(),
path: filepath.to_owned(),
})))
}
<span class="kw">fn </span>retry_policy(is_blocking: bool) -&gt; RetryPolicy {
<span class="kw">if </span>is_blocking {
RetryPolicy {
num_retries: <span class="number">100</span>,
wait_in_ms: <span class="number">100</span>,
}
} <span class="kw">else </span>{
RetryPolicy::no_retry()
}
}
<span class="doccomment">/// Write-once read many (WORM) abstraction for where
/// tantivy&#39;s data should be stored.
///
/// There are currently two implementations of `Directory`
///
/// - The [`MMapDirectory`][crate::directory::MmapDirectory], this
/// should be your default choice.
/// - The [`RamDirectory`][crate::directory::RamDirectory], which
/// should be used mostly for tests.
</span><span class="kw">pub trait </span>Directory: DirectoryClone + fmt::Debug + Send + Sync + <span class="lifetime">&#39;static </span>{
<span class="doccomment">/// Opens a file and returns a boxed `FileHandle`.
///
/// Users of `Directory` should typically call `Directory::open_read(...)`,
/// while `Directory` implementor should implement `get_file_handle()`.
</span><span class="kw">fn </span>get_file_handle(<span class="kw-2">&amp;</span><span class="self">self</span>, path: <span class="kw-2">&amp;</span>Path) -&gt; <span class="prelude-ty">Result</span>&lt;Arc&lt;<span class="kw">dyn </span>FileHandle&gt;, OpenReadError&gt;;
<span class="doccomment">/// Once a virtual file is open, its data may not
/// change.
///
/// Specifically, subsequent writes or flushes should
/// have no effect on the returned [`FileSlice`] object.
///
/// You should only use this to read files create with [`Directory::open_write()`].
</span><span class="kw">fn </span>open_read(<span class="kw-2">&amp;</span><span class="self">self</span>, path: <span class="kw-2">&amp;</span>Path) -&gt; <span class="prelude-ty">Result</span>&lt;FileSlice, OpenReadError&gt; {
<span class="kw">let </span>file_handle = <span class="self">self</span>.get_file_handle(path)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(FileSlice::new(file_handle))
}
<span class="doccomment">/// Removes a file
///
/// Removing a file will not affect an eventual
/// existing [`FileSlice`] pointing to it.
///
/// Removing a nonexistent file, returns a
/// [`DeleteError::FileDoesNotExist`].
</span><span class="kw">fn </span>delete(<span class="kw-2">&amp;</span><span class="self">self</span>, path: <span class="kw-2">&amp;</span>Path) -&gt; <span class="prelude-ty">Result</span>&lt;(), DeleteError&gt;;
<span class="doccomment">/// Returns true if and only if the file exists
</span><span class="kw">fn </span>exists(<span class="kw-2">&amp;</span><span class="self">self</span>, path: <span class="kw-2">&amp;</span>Path) -&gt; <span class="prelude-ty">Result</span>&lt;bool, OpenReadError&gt;;
<span class="doccomment">/// Opens a writer for the *virtual file* associated with
/// a [`Path`].
///
/// Right after this call, for the span of the execution of the program
/// the file should be created and any subsequent call to
/// [`Directory::open_read()`] for the same path should return
/// a [`FileSlice`].
///
/// However, depending on the directory implementation,
/// it might be required to call [`Directory::sync_directory()`] to ensure
/// that the file is durably created.
/// (The semantics here are the same when dealing with
/// a POSIX filesystem.)
///
/// Write operations may be aggressively buffered.
/// The client of this trait is responsible for calling flush
/// to ensure that subsequent `read` operations
/// will take into account preceding `write` operations.
///
/// Flush operation should also be persistent.
///
/// The user shall not rely on [`Drop`] triggering `flush`.
/// Note that [`RamDirectory`][crate::directory::RamDirectory] will
/// panic! if `flush` was not called.
///
/// The file may not previously exist.
</span><span class="kw">fn </span>open_write(<span class="kw-2">&amp;</span><span class="self">self</span>, path: <span class="kw-2">&amp;</span>Path) -&gt; <span class="prelude-ty">Result</span>&lt;WritePtr, OpenWriteError&gt;;
<span class="doccomment">/// Reads the full content file that has been written using
/// [`Directory::atomic_write()`].
///
/// This should only be used for small files.
///
/// You should only use this to read files create with [`Directory::atomic_write()`].
</span><span class="kw">fn </span>atomic_read(<span class="kw-2">&amp;</span><span class="self">self</span>, path: <span class="kw-2">&amp;</span>Path) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, OpenReadError&gt;;
<span class="doccomment">/// Atomically replace the content of a file with data.
///
/// This calls ensure that reads can never *observe*
/// a partially written file.
///
/// The file may or may not previously exist.
</span><span class="kw">fn </span>atomic_write(<span class="kw-2">&amp;</span><span class="self">self</span>, path: <span class="kw-2">&amp;</span>Path, data: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;()&gt;;
<span class="doccomment">/// Sync the directory.
///
/// This call is required to ensure that newly created files are
/// effectively stored durably.
</span><span class="kw">fn </span>sync_directory(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;()&gt;;
<span class="doccomment">/// Acquire a lock in the directory given in the [`Lock`].
///
/// The method is blocking or not depending on the [`Lock`] object.
</span><span class="kw">fn </span>acquire_lock(<span class="kw-2">&amp;</span><span class="self">self</span>, lock: <span class="kw-2">&amp;</span>Lock) -&gt; <span class="prelude-ty">Result</span>&lt;DirectoryLock, LockError&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>box_directory = <span class="self">self</span>.box_clone();
<span class="kw">let </span><span class="kw-2">mut </span>retry_policy = retry_policy(lock.is_blocking);
<span class="kw">loop </span>{
<span class="kw">match </span>try_acquire_lock(<span class="kw-2">&amp;</span>lock.filepath, <span class="kw-2">&amp;mut *</span>box_directory) {
<span class="prelude-val">Ok</span>(result) =&gt; {
<span class="kw">return </span><span class="prelude-val">Ok</span>(result);
}
<span class="prelude-val">Err</span>(TryAcquireLockError::FileExists) =&gt; {
<span class="kw">if </span>!retry_policy.wait_and_retry() {
<span class="kw">return </span><span class="prelude-val">Err</span>(LockError::LockBusy);
}
}
<span class="prelude-val">Err</span>(TryAcquireLockError::IoError(io_error)) =&gt; {
<span class="kw">return </span><span class="prelude-val">Err</span>(LockError::IoError(io_error));
}
}
}
}
<span class="doccomment">/// Registers a callback that will be called whenever a change on the `meta.json`
/// using the [`Directory::atomic_write()`] API is detected.
///
/// The behavior when using `.watch()` on a file using [`Directory::open_write()`] is, on the
/// other hand, undefined.
///
/// The file will be watched for the lifetime of the returned `WatchHandle`. The caller is
/// required to keep it.
/// It does not override previous callbacks. When the file is modified, all callback that are
/// registered (and whose [`WatchHandle`] is still alive) are triggered.
///
/// Internally, tantivy only uses this API to detect new commits to implement the
/// `OnCommit` `ReloadPolicy`. Not implementing watch in a `Directory` only prevents the
/// `OnCommit` `ReloadPolicy` to work properly.
</span><span class="kw">fn </span>watch(<span class="kw-2">&amp;</span><span class="self">self</span>, watch_callback: WatchCallback) -&gt; <span class="kw">crate</span>::Result&lt;WatchHandle&gt;;
}
<span class="doccomment">/// DirectoryClone
</span><span class="kw">pub trait </span>DirectoryClone {
<span class="doccomment">/// Clones the directory and boxes the clone
</span><span class="kw">fn </span>box_clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Box&lt;<span class="kw">dyn </span>Directory&gt;;
}
<span class="kw">impl</span>&lt;T&gt; DirectoryClone <span class="kw">for </span>T
<span class="kw">where </span>T: <span class="lifetime">&#39;static </span>+ Directory + Clone
{
<span class="kw">fn </span>box_clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Box&lt;<span class="kw">dyn </span>Directory&gt; {
Box::new(<span class="self">self</span>.clone())
}
}
<span class="kw">impl </span>Clone <span class="kw">for </span>Box&lt;<span class="kw">dyn </span>Directory&gt; {
<span class="kw">fn </span>clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
<span class="self">self</span>.box_clone()
}
}
<span class="kw">impl</span>&lt;T: Directory + <span class="lifetime">&#39;static</span>&gt; From&lt;T&gt; <span class="kw">for </span>Box&lt;<span class="kw">dyn </span>Directory&gt; {
<span class="kw">fn </span>from(t: T) -&gt; <span class="self">Self </span>{
Box::new(t)
}
}
</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>