| <!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/store/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::io; |
| |
| <span class="kw">use </span>common::{BinarySerializable, FixedSize, HasLen}; |
| |
| <span class="kw">use super</span>::{Decompressor, DOC_STORE_VERSION}; |
| <span class="kw">use </span><span class="kw">crate</span>::directory::FileSlice; |
| |
| <span class="attribute">#[derive(Debug, Clone, PartialEq)] |
| </span><span class="kw">pub struct </span>DocStoreFooter { |
| <span class="kw">pub </span>offset: u64, |
| <span class="kw">pub </span>decompressor: Decompressor, |
| } |
| |
| <span class="doccomment">/// Serialises the footer to a byte-array |
| /// - offset : 8 bytes |
| /// - compressor id: 1 byte |
| /// - reserved for future use: 15 bytes |
| </span><span class="kw">impl </span>BinarySerializable <span class="kw">for </span>DocStoreFooter { |
| <span class="kw">fn </span>serialize<W: io::Write>(<span class="kw-2">&</span><span class="self">self</span>, writer: <span class="kw-2">&mut </span>W) -> io::Result<()> { |
| BinarySerializable::serialize(<span class="kw-2">&</span>DOC_STORE_VERSION, writer)<span class="question-mark">?</span>; |
| BinarySerializable::serialize(<span class="kw-2">&</span><span class="self">self</span>.offset, writer)<span class="question-mark">?</span>; |
| BinarySerializable::serialize(<span class="kw-2">&</span><span class="self">self</span>.decompressor.get_id(), writer)<span class="question-mark">?</span>; |
| writer.write_all(<span class="kw-2">&</span>[<span class="number">0</span>; <span class="number">15</span>])<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="kw">fn </span>deserialize<R: io::Read>(reader: <span class="kw-2">&mut </span>R) -> io::Result<<span class="self">Self</span>> { |
| <span class="kw">let </span>doc_store_version = u32::deserialize(reader)<span class="question-mark">?</span>; |
| <span class="kw">if </span>doc_store_version != DOC_STORE_VERSION { |
| <span class="macro">panic!</span>( |
| <span class="string">"actual doc store version: {}, expected: {}"</span>, |
| doc_store_version, DOC_STORE_VERSION |
| ); |
| } |
| <span class="kw">let </span>offset = u64::deserialize(reader)<span class="question-mark">?</span>; |
| <span class="kw">let </span>compressor_id = u8::deserialize(reader)<span class="question-mark">?</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>skip_buf = [<span class="number">0</span>; <span class="number">15</span>]; |
| reader.read_exact(<span class="kw-2">&mut </span>skip_buf)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(DocStoreFooter { |
| offset, |
| decompressor: Decompressor::from_id(compressor_id), |
| }) |
| } |
| } |
| |
| <span class="kw">impl </span>FixedSize <span class="kw">for </span>DocStoreFooter { |
| <span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">28</span>; |
| } |
| |
| <span class="kw">impl </span>DocStoreFooter { |
| <span class="kw">pub fn </span>new(offset: u64, decompressor: Decompressor) -> <span class="self">Self </span>{ |
| DocStoreFooter { |
| offset, |
| decompressor, |
| } |
| } |
| |
| <span class="kw">pub fn </span>extract_footer(file: FileSlice) -> io::Result<(DocStoreFooter, FileSlice)> { |
| <span class="kw">if </span>file.len() < DocStoreFooter::SIZE_IN_BYTES { |
| <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">"File corrupted. The file is smaller than Footer::SIZE_IN_BYTES (len={})."</span>, |
| file.len() |
| ), |
| )); |
| } |
| <span class="kw">let </span>(body, footer_slice) = file.split_from_end(DocStoreFooter::SIZE_IN_BYTES); |
| <span class="kw">let </span><span class="kw-2">mut </span>footer_bytes = footer_slice.read_bytes()<span class="question-mark">?</span>; |
| <span class="kw">let </span>footer = DocStoreFooter::deserialize(<span class="kw-2">&mut </span>footer_bytes)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>((footer, body)) |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>doc_store_footer_test() { |
| <span class="comment">// This test is just to safe guard changes on the footer. |
| // When the doc store footer is updated, make sure to update also the serialize/deserialize |
| // methods |
| </span><span class="macro">assert_eq!</span>(core::mem::size_of::<DocStoreFooter>(), <span class="number">16</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> |
