| <!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/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::path::PathBuf; |
| <span class="kw">use </span>std::sync::Arc; |
| <span class="kw">use </span>std::{fmt, io}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::Version; |
| |
| <span class="doccomment">/// Error while trying to acquire a directory [lock](crate::directory::Lock). |
| /// |
| /// This is returned from [`Directory::acquire_lock`](crate::Directory::acquire_lock). |
| </span><span class="attribute">#[derive(Debug, Clone, Error)] |
| </span><span class="kw">pub enum </span>LockError { |
| <span class="doccomment">/// Failed to acquired a lock as it is already held by another |
| /// client. |
| /// - In the context of a blocking lock, this means the lock was not released within some |
| /// `timeout` period. |
| /// - In the context of a non-blocking lock, this means the lock was busy at the moment of the |
| /// call. |
| </span><span class="attribute">#[error(<span class="string">"Could not acquire lock as it is already held, possibly by a different process."</span>)] |
| </span>LockBusy, |
| <span class="doccomment">/// Trying to acquire a lock failed with an `IoError` |
| </span><span class="attribute">#[error(<span class="string">"Failed to acquire the lock due to an io:Error."</span>)] |
| </span>IoError(Arc<io::Error>), |
| } |
| |
| <span class="kw">impl </span>LockError { |
| <span class="doccomment">/// Wraps an io error. |
| </span><span class="kw">pub fn </span>wrap_io_error(io_error: io::Error) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::IoError(Arc::new(io_error)) |
| } |
| } |
| |
| <span class="doccomment">/// Error that may occur when opening a directory |
| </span><span class="attribute">#[derive(Debug, Clone, Error)] |
| </span><span class="kw">pub enum </span>OpenDirectoryError { |
| <span class="doccomment">/// The underlying directory does not exists. |
| </span><span class="attribute">#[error(<span class="string">"Directory does not exist: '{0}'."</span>)] |
| </span>DoesNotExist(PathBuf), |
| <span class="doccomment">/// The path exists but is not a directory. |
| </span><span class="attribute">#[error(<span class="string">"Path exists but is not a directory: '{0}'."</span>)] |
| </span>NotADirectory(PathBuf), |
| <span class="doccomment">/// Failed to create a temp directory. |
| </span><span class="attribute">#[error(<span class="string">"Failed to create a temporary directory: '{0}'."</span>)] |
| </span>FailedToCreateTempDir(Arc<io::Error>), |
| <span class="doccomment">/// IoError |
| </span><span class="attribute">#[error(<span class="string">"IoError '{io_error:?}' while create directory in: '{directory_path:?}'."</span>)] |
| </span>IoError { |
| <span class="doccomment">/// underlying io Error. |
| </span>io_error: Arc<io::Error>, |
| <span class="doccomment">/// directory we tried to open. |
| </span>directory_path: PathBuf, |
| }, |
| } |
| |
| <span class="kw">impl </span>OpenDirectoryError { |
| <span class="doccomment">/// Wraps an io error. |
| </span><span class="kw">pub fn </span>wrap_io_error(io_error: io::Error, directory_path: PathBuf) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::IoError { |
| io_error: Arc::new(io_error), |
| directory_path, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Error that may occur when starting to write in a file |
| </span><span class="attribute">#[derive(Debug, Clone, Error)] |
| </span><span class="kw">pub enum </span>OpenWriteError { |
| <span class="doccomment">/// Our directory is WORM, writing an existing file is forbidden. |
| /// Checkout the `Directory` documentation. |
| </span><span class="attribute">#[error(<span class="string">"File already exists: '{0}'"</span>)] |
| </span>FileAlreadyExists(PathBuf), |
| <span class="doccomment">/// Any kind of IO error that happens when |
| /// writing in the underlying IO device. |
| </span><span class="attribute">#[error(<span class="string">"IoError '{io_error:?}' while opening file for write: '{filepath}'."</span>)] |
| </span>IoError { |
| <span class="doccomment">/// The underlying `io::Error`. |
| </span>io_error: Arc<io::Error>, |
| <span class="doccomment">/// File path of the file that tantivy failed to open for write. |
| </span>filepath: PathBuf, |
| }, |
| } |
| |
| <span class="kw">impl </span>OpenWriteError { |
| <span class="doccomment">/// Wraps an io error. |
| </span><span class="kw">pub fn </span>wrap_io_error(io_error: io::Error, filepath: PathBuf) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::IoError { |
| io_error: Arc::new(io_error), |
| filepath, |
| } |
| } |
| } |
| <span class="doccomment">/// Type of index incompatibility between the library and the index found on disk |
| /// Used to catch and provide a hint to solve this incompatibility issue |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub enum </span>Incompatibility { |
| <span class="doccomment">/// This library cannot decompress the index found on disk |
| </span>CompressionMismatch { |
| <span class="doccomment">/// Compression algorithm used by the current version of tantivy |
| </span>library_compression_format: String, |
| <span class="doccomment">/// Compression algorithm that was used to serialise the index |
| </span>index_compression_format: String, |
| }, |
| <span class="doccomment">/// The index format found on disk isn't supported by this version of the library |
| </span>IndexMismatch { |
| <span class="doccomment">/// Version used by the library |
| </span>library_version: Version, |
| <span class="doccomment">/// Version the index was built with |
| </span>index_version: Version, |
| }, |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Incompatibility { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> <span class="prelude-ty">Result</span><(), fmt::Error> { |
| <span class="kw">match </span><span class="self">self </span>{ |
| Incompatibility::CompressionMismatch { |
| library_compression_format, |
| index_compression_format, |
| } => { |
| <span class="kw">let </span>err = <span class="macro">format!</span>( |
| <span class="string">"Library was compiled with {:?} compression, index was compressed with {:?}"</span>, |
| library_compression_format, index_compression_format |
| ); |
| <span class="kw">let </span>advice = <span class="macro">format!</span>( |
| <span class="string">"Change the feature flag to {:?} and rebuild the library"</span>, |
| index_compression_format |
| ); |
| <span class="macro">write!</span>(f, <span class="string">"{}. {}"</span>, err, advice)<span class="question-mark">?</span>; |
| } |
| Incompatibility::IndexMismatch { |
| library_version, |
| index_version, |
| } => { |
| <span class="kw">let </span>err = <span class="macro">format!</span>( |
| <span class="string">"Library version: {}, index version: {}"</span>, |
| library_version.index_format_version, index_version.index_format_version |
| ); |
| <span class="comment">// TODO make a more useful error message |
| // include the version range that supports this index_format_version |
| </span><span class="kw">let </span>advice = <span class="macro">format!</span>( |
| <span class="string">"Change tantivy to a version compatible with index format {} (e.g. {}.{}.x) \ |
| and rebuild your project."</span>, |
| index_version.index_format_version, index_version.major, index_version.minor |
| ); |
| <span class="macro">write!</span>(f, <span class="string">"{}. {}"</span>, err, advice)<span class="question-mark">?</span>; |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="doccomment">/// Error that may occur when accessing a file read |
| </span><span class="attribute">#[derive(Debug, Clone, Error)] |
| </span><span class="kw">pub enum </span>OpenReadError { |
| <span class="doccomment">/// The file does not exists. |
| </span><span class="attribute">#[error(<span class="string">"Files does not exists: {0:?}"</span>)] |
| </span>FileDoesNotExist(PathBuf), |
| <span class="doccomment">/// Any kind of io::Error. |
| </span><span class="attribute">#[error( |
| <span class="string">"IoError: '{io_error:?}' happened while opening the following file for Read: {filepath}." |
| </span>)] |
| </span>IoError { |
| <span class="doccomment">/// The underlying `io::Error`. |
| </span>io_error: Arc<io::Error>, |
| <span class="doccomment">/// File path of the file that tantivy failed to open for read. |
| </span>filepath: PathBuf, |
| }, |
| <span class="doccomment">/// This library does not support the index version found in file footer. |
| </span><span class="attribute">#[error(<span class="string">"Index version unsupported: {0:?}"</span>)] |
| </span>IncompatibleIndex(Incompatibility), |
| } |
| |
| <span class="kw">impl </span>OpenReadError { |
| <span class="doccomment">/// Wraps an io error. |
| </span><span class="kw">pub fn </span>wrap_io_error(io_error: io::Error, filepath: PathBuf) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::IoError { |
| io_error: Arc::new(io_error), |
| filepath, |
| } |
| } |
| } |
| <span class="doccomment">/// Error that may occur when trying to delete a file |
| </span><span class="attribute">#[derive(Debug, Clone, Error)] |
| </span><span class="kw">pub enum </span>DeleteError { |
| <span class="doccomment">/// The file does not exists. |
| </span><span class="attribute">#[error(<span class="string">"File does not exists: '{0}'."</span>)] |
| </span>FileDoesNotExist(PathBuf), |
| <span class="doccomment">/// Any kind of IO error that happens when |
| /// interacting with the underlying IO device. |
| </span><span class="attribute">#[error(<span class="string">"The following IO error happened while deleting file '{filepath}': '{io_error:?}'."</span>)] |
| </span>IoError { |
| <span class="doccomment">/// The underlying `io::Error`. |
| </span>io_error: Arc<io::Error>, |
| <span class="doccomment">/// File path of the file that tantivy failed to delete. |
| </span>filepath: PathBuf, |
| }, |
| } |
| |
| <span class="kw">impl </span>From<Incompatibility> <span class="kw">for </span>OpenReadError { |
| <span class="kw">fn </span>from(incompatibility: Incompatibility) -> <span class="self">Self </span>{ |
| OpenReadError::IncompatibleIndex(incompatibility) |
| } |
| } |
| </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> |
