Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / tantivy / directory / footer.rs.html
blob: 93f9e4643896236ee0efa6982cdaa4f1b837db6b [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/footer.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>footer.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::io;
<span class="kw">use </span>std::io::Write;
<span class="kw">use </span>common::{BinarySerializable, CountingWriter, DeserializeFrom, FixedSize, HasLen};
<span class="kw">use </span>crc32fast::Hasher;
<span class="kw">use </span>serde::{Deserialize, Serialize};
<span class="kw">use </span><span class="kw">crate</span>::directory::error::Incompatibility;
<span class="kw">use </span><span class="kw">crate</span>::directory::{AntiCallToken, FileSlice, TerminatingWrite};
<span class="kw">use crate</span>::{Version, INDEX_FORMAT_VERSION};
<span class="kw">const </span>FOOTER_MAX_LEN: u32 = <span class="number">50_000</span>;
<span class="doccomment">/// The magic byte of the footer to identify corruption
/// or an old version of the footer.
</span><span class="kw">const </span>FOOTER_MAGIC_NUMBER: u32 = <span class="number">1337</span>;
<span class="kw">type </span>CrcHashU32 = u32;
<span class="doccomment">/// A Footer is appended to every file
</span><span class="attribute">#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
</span><span class="kw">pub struct </span>Footer {
<span class="kw">pub </span>version: Version,
<span class="kw">pub </span>crc: CrcHashU32,
}
<span class="kw">impl </span>Footer {
<span class="kw">pub fn </span>new(crc: CrcHashU32) -&gt; <span class="self">Self </span>{
<span class="kw">let </span>version = <span class="kw">crate</span>::VERSION.clone();
Footer { version, crc }
}
<span class="kw">pub fn </span>crc(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; CrcHashU32 {
<span class="self">self</span>.crc
}
<span class="kw">pub fn </span>append_footer&lt;W: io::Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="kw-2">mut </span>write: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>counting_write = CountingWriter::wrap(<span class="kw-2">&amp;mut </span>write);
counting_write.write_all(serde_json::to_string(<span class="kw-2">&amp;</span><span class="self">self</span>)<span class="question-mark">?</span>.as_ref())<span class="question-mark">?</span>;
<span class="kw">let </span>footer_payload_len = counting_write.written_bytes();
BinarySerializable::serialize(<span class="kw-2">&amp;</span>(footer_payload_len <span class="kw">as </span>u32), write)<span class="question-mark">?</span>;
BinarySerializable::serialize(<span class="kw-2">&amp;</span>(FOOTER_MAGIC_NUMBER <span class="kw">as </span>u32), write)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub fn </span>extract_footer(file: FileSlice) -&gt; io::Result&lt;(Footer, FileSlice)&gt; {
<span class="kw">if </span>file.len() &lt; <span class="number">4 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::UnexpectedEof,
<span class="macro">format!</span>(
<span class="string">&quot;File corrupted. The file is smaller than 4 bytes (len={}).&quot;</span>,
file.len()
),
));
}
<span class="kw">let </span>footer_metadata_len = &lt;(u32, u32)&gt;::SIZE_IN_BYTES;
<span class="kw">let </span>(footer_len, footer_magic_byte): (u32, u32) = file
.slice_from_end(footer_metadata_len)
.read_bytes()<span class="question-mark">?
</span>.as_ref()
.deserialize()<span class="question-mark">?</span>;
<span class="kw">if </span>footer_magic_byte != FOOTER_MAGIC_NUMBER {
<span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::InvalidData,
<span class="string">&quot;Footer magic byte mismatch. File corrupted or index was created using old an \
tantivy version which is not supported anymore. Please use tantivy 0.15 or above \
to recreate the index.&quot;</span>,
));
}
<span class="kw">if </span>footer_len &gt; FOOTER_MAX_LEN {
<span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::InvalidData,
<span class="macro">format!</span>(
<span class="string">&quot;Footer seems invalid as it suggests a footer len of {}. File is corrupted, \
or the index was created with a different &amp; old version of tantivy.&quot;</span>,
footer_len
),
));
}
<span class="kw">let </span>total_footer_size = footer_len <span class="kw">as </span>usize + footer_metadata_len;
<span class="kw">if </span>file.len() &lt; total_footer_size {
<span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::UnexpectedEof,
<span class="macro">format!</span>(
<span class="string">&quot;File corrupted. The file is smaller than it&#39;s footer bytes (len={}).&quot;</span>,
total_footer_size
),
));
}
<span class="kw">let </span>footer: Footer = serde_json::from_slice(<span class="kw-2">&amp;</span>file.read_bytes_slice(
file.len() - total_footer_size..file.len() - footer_metadata_len <span class="kw">as </span>usize,
)<span class="question-mark">?</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>body = file.slice_to(file.len() - total_footer_size);
<span class="prelude-val">Ok</span>((footer, body))
}
<span class="doccomment">/// Confirms that the index will be read correctly by this version of tantivy
/// Has to be called after `extract_footer` to make sure it&#39;s not accessing uninitialised memory
</span><span class="kw">pub fn </span>is_compatible(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), Incompatibility&gt; {
<span class="kw">let </span>library_version = <span class="kw">crate</span>::version();
<span class="kw">if </span><span class="self">self</span>.version.index_format_version &lt; <span class="number">4
</span>|| <span class="self">self</span>.version.index_format_version &gt; INDEX_FORMAT_VERSION
{
<span class="kw">return </span><span class="prelude-val">Err</span>(Incompatibility::IndexMismatch {
library_version: library_version.clone(),
index_version: <span class="self">self</span>.version.clone(),
});
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>FooterProxy&lt;W: TerminatingWrite&gt; {
<span class="doccomment">/// always Some except after terminate call
</span>hasher: <span class="prelude-ty">Option</span>&lt;Hasher&gt;,
<span class="doccomment">/// always Some except after terminate call
</span>writer: <span class="prelude-ty">Option</span>&lt;W&gt;,
}
<span class="kw">impl</span>&lt;W: TerminatingWrite&gt; FooterProxy&lt;W&gt; {
<span class="kw">pub fn </span>new(writer: W) -&gt; <span class="self">Self </span>{
FooterProxy {
hasher: <span class="prelude-val">Some</span>(Hasher::new()),
writer: <span class="prelude-val">Some</span>(writer),
}
}
}
<span class="kw">impl</span>&lt;W: TerminatingWrite&gt; Write <span class="kw">for </span>FooterProxy&lt;W&gt; {
<span class="kw">fn </span>write(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<span class="kw">let </span>count = <span class="self">self</span>.writer.as_mut().unwrap().write(buf)<span class="question-mark">?</span>;
<span class="self">self</span>.hasher.as_mut().unwrap().update(<span class="kw-2">&amp;</span>buf[..count]);
<span class="prelude-val">Ok</span>(count)
}
<span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.writer.as_mut().unwrap().flush()
}
}
<span class="kw">impl</span>&lt;W: TerminatingWrite&gt; TerminatingWrite <span class="kw">for </span>FooterProxy&lt;W&gt; {
<span class="kw">fn </span>terminate_ref(<span class="kw-2">&amp;mut </span><span class="self">self</span>, <span class="kw">_</span>: AntiCallToken) -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span>crc32 = <span class="self">self</span>.hasher.take().unwrap().finalize();
<span class="kw">let </span>footer = Footer::new(crc32);
<span class="kw">let </span><span class="kw-2">mut </span>writer = <span class="self">self</span>.writer.take().unwrap();
footer.append_footer(<span class="kw-2">&amp;mut </span>writer)<span class="question-mark">?</span>;
writer.terminate()
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>std::io;
<span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span>common::BinarySerializable;
<span class="kw">use </span><span class="kw">crate</span>::directory::footer::{Footer, FOOTER_MAGIC_NUMBER};
<span class="kw">use </span><span class="kw">crate</span>::directory::{FileSlice, OwnedBytes};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_deserialize_footer() {
<span class="kw">let </span><span class="kw-2">mut </span>buf: Vec&lt;u8&gt; = <span class="macro">vec!</span>[];
<span class="kw">let </span>footer = Footer::new(<span class="number">123</span>);
footer.append_footer(<span class="kw-2">&amp;mut </span>buf).unwrap();
<span class="kw">let </span>owned_bytes = OwnedBytes::new(buf);
<span class="kw">let </span>fileslice = FileSlice::new(Arc::new(owned_bytes));
<span class="kw">let </span>(footer_deser, _body) = Footer::extract_footer(fileslice).unwrap();
<span class="macro">assert_eq!</span>(footer_deser.crc(), footer.crc());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_deserialize_footer_missing_magic_byte() {
<span class="kw">let </span><span class="kw-2">mut </span>buf: Vec&lt;u8&gt; = <span class="macro">vec!</span>[];
BinarySerializable::serialize(<span class="kw-2">&amp;</span><span class="number">0_u32</span>, <span class="kw-2">&amp;mut </span>buf).unwrap();
<span class="kw">let </span>wrong_magic_byte: u32 = <span class="number">5555</span>;
BinarySerializable::serialize(<span class="kw-2">&amp;</span>wrong_magic_byte, <span class="kw-2">&amp;mut </span>buf).unwrap();
<span class="kw">let </span>owned_bytes = OwnedBytes::new(buf);
<span class="kw">let </span>fileslice = FileSlice::new(Arc::new(owned_bytes));
<span class="kw">let </span>err = Footer::extract_footer(fileslice).unwrap_err();
<span class="macro">assert_eq!</span>(
err.to_string(),
<span class="string">&quot;Footer magic byte mismatch. File corrupted or index was created using old an tantivy \
version which is not supported anymore. Please use tantivy 0.15 or above to recreate \
the index.&quot;
</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_deserialize_footer_wrong_filesize() {
<span class="kw">let </span><span class="kw-2">mut </span>buf: Vec&lt;u8&gt; = <span class="macro">vec!</span>[];
BinarySerializable::serialize(<span class="kw-2">&amp;</span><span class="number">100_u32</span>, <span class="kw-2">&amp;mut </span>buf).unwrap();
BinarySerializable::serialize(<span class="kw-2">&amp;</span>FOOTER_MAGIC_NUMBER, <span class="kw-2">&amp;mut </span>buf).unwrap();
<span class="kw">let </span>owned_bytes = OwnedBytes::new(buf);
<span class="kw">let </span>fileslice = FileSlice::new(Arc::new(owned_bytes));
<span class="kw">let </span>err = Footer::extract_footer(fileslice).unwrap_err();
<span class="macro">assert_eq!</span>(err.kind(), io::ErrorKind::UnexpectedEof);
<span class="macro">assert_eq!</span>(
err.to_string(),
<span class="string">&quot;File corrupted. The file is smaller than it\&#39;s footer bytes (len=108).&quot;
</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_deserialize_too_large_footer() {
<span class="kw">let </span><span class="kw-2">mut </span>buf: Vec&lt;u8&gt; = <span class="macro">vec!</span>[];
<span class="kw">let </span>footer_length = <span class="kw">super</span>::FOOTER_MAX_LEN + <span class="number">1</span>;
BinarySerializable::serialize(<span class="kw-2">&amp;</span>footer_length, <span class="kw-2">&amp;mut </span>buf).unwrap();
BinarySerializable::serialize(<span class="kw-2">&amp;</span>FOOTER_MAGIC_NUMBER, <span class="kw-2">&amp;mut </span>buf).unwrap();
<span class="kw">let </span>owned_bytes = OwnedBytes::new(buf);
<span class="kw">let </span>fileslice = FileSlice::new(Arc::new(owned_bytes));
<span class="kw">let </span>err = Footer::extract_footer(fileslice).unwrap_err();
<span class="macro">assert_eq!</span>(err.kind(), io::ErrorKind::InvalidData);
<span class="macro">assert_eq!</span>(
err.to_string(),
<span class="string">&quot;Footer seems invalid as it suggests a footer len of 50001. File is corrupted, or the \
index was created with a different &amp; old version of tantivy.&quot;
</span>);
}
}
</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>