| <!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/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> |
| </pre><pre class="rust"><code><span class="doccomment">//! Definition of Tantivy's errors and results. |
| |
| </span><span class="kw">use </span>std::path::PathBuf; |
| <span class="kw">use </span>std::sync::{Arc, PoisonError}; |
| <span class="kw">use </span>std::{fmt, io}; |
| |
| <span class="kw">use </span>thiserror::Error; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::directory::error::{ |
| Incompatibility, LockError, OpenDirectoryError, OpenReadError, OpenWriteError, |
| }; |
| <span class="kw">use </span><span class="kw">crate</span>::fastfield::FastFieldNotAvailableError; |
| <span class="kw">use crate</span>::{query, schema}; |
| |
| <span class="doccomment">/// Represents a `DataCorruption` error. |
| /// |
| /// When facing data corruption, tantivy actually panics or returns this error. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>DataCorruption { |
| filepath: <span class="prelude-ty">Option</span><PathBuf>, |
| comment: String, |
| } |
| |
| <span class="kw">impl </span>DataCorruption { |
| <span class="doccomment">/// Creates a `DataCorruption` Error. |
| </span><span class="kw">pub fn </span>new(filepath: PathBuf, comment: String) -> DataCorruption { |
| DataCorruption { |
| filepath: <span class="prelude-val">Some</span>(filepath), |
| comment, |
| } |
| } |
| |
| <span class="doccomment">/// Creates a `DataCorruption` Error, when the filepath is irrelevant. |
| </span><span class="kw">pub fn </span>comment_only<TStr: ToString>(comment: TStr) -> DataCorruption { |
| DataCorruption { |
| filepath: <span class="prelude-val">None</span>, |
| comment: comment.to_string(), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>DataCorruption { |
| <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="macro">write!</span>(f, <span class="string">"Data corruption"</span>)<span class="question-mark">?</span>; |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>filepath) = <span class="kw-2">&</span><span class="self">self</span>.filepath { |
| <span class="macro">write!</span>(f, <span class="string">" (in file `{:?}`)"</span>, filepath)<span class="question-mark">?</span>; |
| } |
| <span class="macro">write!</span>(f, <span class="string">": {}."</span>, <span class="self">self</span>.comment)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="doccomment">/// The library's error enum |
| </span><span class="attribute">#[derive(Debug, Clone, Error)] |
| </span><span class="kw">pub enum </span>TantivyError { |
| <span class="doccomment">/// Failed to open the directory. |
| </span><span class="attribute">#[error(<span class="string">"Failed to open the directory: '{0:?}'"</span>)] |
| </span>OpenDirectoryError(<span class="attribute">#[from] </span>OpenDirectoryError), |
| <span class="doccomment">/// Failed to open a file for read. |
| </span><span class="attribute">#[error(<span class="string">"Failed to open file for read: '{0:?}'"</span>)] |
| </span>OpenReadError(<span class="attribute">#[from] </span>OpenReadError), |
| <span class="doccomment">/// Failed to open a file for write. |
| </span><span class="attribute">#[error(<span class="string">"Failed to open file for write: '{0:?}'"</span>)] |
| </span>OpenWriteError(<span class="attribute">#[from] </span>OpenWriteError), |
| <span class="doccomment">/// Index already exists in this directory. |
| </span><span class="attribute">#[error(<span class="string">"Index already exists"</span>)] |
| </span>IndexAlreadyExists, |
| <span class="doccomment">/// Failed to acquire file lock. |
| </span><span class="attribute">#[error(<span class="string">"Failed to acquire Lockfile: {0:?}. {1:?}"</span>)] |
| </span>LockFailure(LockError, <span class="prelude-ty">Option</span><String>), |
| <span class="doccomment">/// IO Error. |
| </span><span class="attribute">#[error(<span class="string">"An IO error occurred: '{0}'"</span>)] |
| </span>IoError(Arc<io::Error>), |
| <span class="doccomment">/// Data corruption. |
| </span><span class="attribute">#[error(<span class="string">"Data corrupted: '{0:?}'"</span>)] |
| </span>DataCorruption(DataCorruption), |
| <span class="doccomment">/// A thread holding the locked panicked and poisoned the lock. |
| </span><span class="attribute">#[error(<span class="string">"A thread holding the locked panicked and poisoned the lock"</span>)] |
| </span>Poisoned, |
| <span class="doccomment">/// The provided field name does not exist. |
| </span><span class="attribute">#[error(<span class="string">"The field does not exist: '{0}'"</span>)] |
| </span>FieldNotFound(String), |
| <span class="doccomment">/// Invalid argument was passed by the user. |
| </span><span class="attribute">#[error(<span class="string">"An invalid argument was passed: '{0}'"</span>)] |
| </span>InvalidArgument(String), |
| <span class="doccomment">/// An Error occurred in one of the threads. |
| </span><span class="attribute">#[error(<span class="string">"An error occurred in a thread: '{0}'"</span>)] |
| </span>ErrorInThread(String), |
| <span class="doccomment">/// An Error occurred related to opening or creating a index. |
| </span><span class="attribute">#[error(<span class="string">"Missing required index builder argument when open/create index: '{0}'"</span>)] |
| </span>IndexBuilderMissingArgument(<span class="kw-2">&</span><span class="lifetime">'static </span>str), |
| <span class="doccomment">/// An Error occurred related to the schema. |
| </span><span class="attribute">#[error(<span class="string">"Schema error: '{0}'"</span>)] |
| </span>SchemaError(String), |
| <span class="doccomment">/// System error. (e.g.: We failed spawning a new thread). |
| </span><span class="attribute">#[error(<span class="string">"System error.'{0}'"</span>)] |
| </span>SystemError(String), |
| <span class="doccomment">/// Index incompatible with current version of Tantivy. |
| </span><span class="attribute">#[error(<span class="string">"{0:?}"</span>)] |
| </span>IncompatibleIndex(Incompatibility), |
| <span class="doccomment">/// An internal error occurred. This is are internal states that should not be reached. |
| /// e.g. a datastructure is incorrectly inititalized. |
| </span><span class="attribute">#[error(<span class="string">"Internal error: '{0}'"</span>)] |
| </span>InternalError(String), |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"quickwit"</span>)] |
| #[derive(Error, Debug)] |
| #[doc(hidden)] |
| </span><span class="kw">pub enum </span>AsyncIoError { |
| <span class="attribute">#[error(<span class="string">"io::Error `{0}`"</span>)] |
| </span>Io(<span class="attribute">#[from] </span>io::Error), |
| <span class="attribute">#[error(<span class="string">"Asynchronous API is unsupported by this directory"</span>)] |
| </span>AsyncUnsupported, |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"quickwit"</span>)] |
| </span><span class="kw">impl </span>From<AsyncIoError> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(async_io_err: AsyncIoError) -> <span class="self">Self </span>{ |
| <span class="kw">match </span>async_io_err { |
| AsyncIoError::Io(io_err) => TantivyError::from(io_err), |
| AsyncIoError::AsyncUnsupported => { |
| TantivyError::SystemError(<span class="macro">format!</span>(<span class="string">"{:?}"</span>, async_io_err)) |
| } |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>From<io::Error> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(io_err: io::Error) -> TantivyError { |
| TantivyError::IoError(Arc::new(io_err)) |
| } |
| } |
| <span class="kw">impl </span>From<DataCorruption> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(data_corruption: DataCorruption) -> TantivyError { |
| TantivyError::DataCorruption(data_corruption) |
| } |
| } |
| <span class="kw">impl </span>From<FastFieldNotAvailableError> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(fastfield_error: FastFieldNotAvailableError) -> TantivyError { |
| TantivyError::SchemaError(<span class="macro">format!</span>(<span class="string">"{}"</span>, fastfield_error)) |
| } |
| } |
| <span class="kw">impl </span>From<LockError> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(lock_error: LockError) -> TantivyError { |
| TantivyError::LockFailure(lock_error, <span class="prelude-val">None</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>From<query::QueryParserError> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(parsing_error: query::QueryParserError) -> TantivyError { |
| TantivyError::InvalidArgument(<span class="macro">format!</span>(<span class="string">"Query is invalid. {:?}"</span>, parsing_error)) |
| } |
| } |
| |
| <span class="kw">impl</span><Guard> From<PoisonError<Guard>> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(<span class="kw">_</span>: PoisonError<Guard>) -> TantivyError { |
| TantivyError::Poisoned |
| } |
| } |
| |
| <span class="kw">impl </span>From<time::error::Format> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(err: time::error::Format) -> TantivyError { |
| TantivyError::InvalidArgument(<span class="macro">format!</span>(<span class="string">"Date formatting error: {err}"</span>)) |
| } |
| } |
| |
| <span class="kw">impl </span>From<time::error::Parse> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(err: time::error::Parse) -> TantivyError { |
| TantivyError::InvalidArgument(<span class="macro">format!</span>(<span class="string">"Date parsing error: {err}"</span>)) |
| } |
| } |
| |
| <span class="kw">impl </span>From<time::error::ComponentRange> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(err: time::error::ComponentRange) -> TantivyError { |
| TantivyError::InvalidArgument(<span class="macro">format!</span>(<span class="string">"Date range error: {err}"</span>)) |
| } |
| } |
| |
| <span class="kw">impl </span>From<schema::DocParsingError> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(error: schema::DocParsingError) -> TantivyError { |
| TantivyError::InvalidArgument(<span class="macro">format!</span>(<span class="string">"Failed to parse document {:?}"</span>, error)) |
| } |
| } |
| |
| <span class="kw">impl </span>From<serde_json::Error> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(error: serde_json::Error) -> TantivyError { |
| TantivyError::IoError(Arc::new(error.into())) |
| } |
| } |
| |
| <span class="kw">impl </span>From<rayon::ThreadPoolBuildError> <span class="kw">for </span>TantivyError { |
| <span class="kw">fn </span>from(error: rayon::ThreadPoolBuildError) -> TantivyError { |
| TantivyError::SystemError(error.to_string()) |
| } |
| } |
| </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> |
