Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / tantivy / store / index / block.rs.html
blob: c3b5255ed15d466ea3b895a1ad024f1c8432a997 [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/store/index/block.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>block.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::io;
<span class="kw">use </span>std::ops::Range;
<span class="kw">use </span>common::{read_u32_vint, VInt};
<span class="kw">use </span><span class="kw">crate</span>::store::index::{Checkpoint, CHECKPOINT_PERIOD};
<span class="kw">use </span><span class="kw">crate</span>::DocId;
<span class="doccomment">/// Represents a block of checkpoints.
///
/// The DocStore index checkpoints are organized into block
/// for code-readability and compression purpose.
///
/// A block can be of any size.
</span><span class="kw">pub struct </span>CheckpointBlock {
<span class="kw">pub </span>checkpoints: Vec&lt;Checkpoint&gt;,
}
<span class="kw">impl </span>Default <span class="kw">for </span>CheckpointBlock {
<span class="kw">fn </span>default() -&gt; CheckpointBlock {
CheckpointBlock {
checkpoints: Vec::with_capacity(<span class="number">2 </span>* CHECKPOINT_PERIOD),
}
}
}
<span class="kw">impl </span>CheckpointBlock {
<span class="doccomment">/// If non-empty returns [start_doc, end_doc)
/// for the overall block.
</span><span class="kw">pub fn </span>doc_interval(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Range&lt;DocId&gt;&gt; {
<span class="kw">let </span>start_doc_opt = <span class="self">self
</span>.checkpoints
.first()
.cloned()
.map(|checkpoint| checkpoint.doc_range.start);
<span class="kw">let </span>end_doc_opt = <span class="self">self
</span>.checkpoints
.last()
.cloned()
.map(|checkpoint| checkpoint.doc_range.end);
<span class="kw">match </span>(start_doc_opt, end_doc_opt) {
(<span class="prelude-val">Some</span>(start_doc), <span class="prelude-val">Some</span>(end_doc)) =&gt; <span class="prelude-val">Some</span>(start_doc..end_doc),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
<span class="doccomment">/// Adding another checkpoint in the block.
</span><span class="kw">pub fn </span>push(<span class="kw-2">&amp;mut </span><span class="self">self</span>, checkpoint: Checkpoint) {
<span class="kw">if let </span><span class="prelude-val">Some</span>(prev_checkpoint) = <span class="self">self</span>.checkpoints.last() {
<span class="macro">assert!</span>(checkpoint.follows(prev_checkpoint));
}
<span class="self">self</span>.checkpoints.push(checkpoint);
}
<span class="doccomment">/// Returns the number of checkpoints in the block.
</span><span class="kw">pub fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.checkpoints.len()
}
<span class="kw">pub fn </span>get(<span class="kw-2">&amp;</span><span class="self">self</span>, idx: usize) -&gt; Checkpoint {
<span class="self">self</span>.checkpoints[idx].clone()
}
<span class="kw">pub fn </span>clear(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.checkpoints.clear();
}
<span class="kw">pub fn </span>serialize(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
VInt(<span class="self">self</span>.checkpoints.len() <span class="kw">as </span>u64).serialize_into_vec(buffer);
<span class="kw">if </span><span class="self">self</span>.checkpoints.is_empty() {
<span class="kw">return</span>;
}
VInt(<span class="self">self</span>.checkpoints[<span class="number">0</span>].doc_range.start <span class="kw">as </span>u64).serialize_into_vec(buffer);
VInt(<span class="self">self</span>.checkpoints[<span class="number">0</span>].byte_range.start <span class="kw">as </span>u64).serialize_into_vec(buffer);
<span class="kw">for </span>checkpoint <span class="kw">in </span><span class="kw-2">&amp;</span><span class="self">self</span>.checkpoints {
<span class="kw">let </span>delta_doc = checkpoint.doc_range.end - checkpoint.doc_range.start;
VInt(delta_doc <span class="kw">as </span>u64).serialize_into_vec(buffer);
VInt((checkpoint.byte_range.end - checkpoint.byte_range.start) <span class="kw">as </span>u64)
.serialize_into_vec(buffer);
}
}
<span class="kw">pub fn </span>deserialize(<span class="kw-2">&amp;mut </span><span class="self">self</span>, data: <span class="kw-2">&amp;mut &amp;</span>[u8]) -&gt; io::Result&lt;()&gt; {
<span class="kw">if </span>data.is_empty() {
<span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::new(io::ErrorKind::UnexpectedEof, <span class="string">&quot;&quot;</span>));
}
<span class="self">self</span>.checkpoints.clear();
<span class="kw">let </span>len = read_u32_vint(data);
<span class="kw">if </span>len == <span class="number">0 </span>{
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
<span class="kw">let </span><span class="kw-2">mut </span>doc = read_u32_vint(data);
<span class="kw">let </span><span class="kw-2">mut </span>start_offset = VInt::deserialize_u64(data)<span class="question-mark">? </span><span class="kw">as </span>usize;
<span class="kw">for _ in </span><span class="number">0</span>..len {
<span class="kw">let </span>num_docs = read_u32_vint(data);
<span class="kw">let </span>block_num_bytes = read_u32_vint(data) <span class="kw">as </span>usize;
<span class="self">self</span>.checkpoints.push(Checkpoint {
doc_range: doc..doc + num_docs,
byte_range: start_offset..start_offset + block_num_bytes,
});
doc += num_docs;
start_offset += block_num_bytes;
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>std::io;
<span class="kw">use </span><span class="kw">crate</span>::store::index::block::CheckpointBlock;
<span class="kw">use </span><span class="kw">crate</span>::store::index::Checkpoint;
<span class="kw">use </span><span class="kw">crate</span>::DocId;
<span class="kw">fn </span>test_aux_ser_deser(checkpoints: <span class="kw-2">&amp;</span>[Checkpoint]) -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>block = CheckpointBlock::default();
<span class="kw">for </span>checkpoint <span class="kw">in </span>checkpoints {
block.push(checkpoint.clone());
}
<span class="kw">let </span><span class="kw-2">mut </span>buffer = Vec::new();
block.serialize(<span class="kw-2">&amp;mut </span>buffer);
<span class="kw">let </span><span class="kw-2">mut </span>block_deser = CheckpointBlock::default();
<span class="kw">let </span>checkpoint = Checkpoint {
doc_range: <span class="number">0</span>..<span class="number">1</span>,
byte_range: <span class="number">2</span>..<span class="number">3</span>,
};
block_deser.push(checkpoint); <span class="comment">// &lt; check that value is erased before deser
</span><span class="kw">let </span><span class="kw-2">mut </span>data = <span class="kw-2">&amp;</span>buffer[..];
block_deser.deserialize(<span class="kw-2">&amp;mut </span>data)<span class="question-mark">?</span>;
<span class="macro">assert!</span>(data.is_empty());
<span class="macro">assert_eq!</span>(checkpoints, <span class="kw-2">&amp;</span>block_deser.checkpoints[..]);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_block_serialize_empty() -&gt; io::Result&lt;()&gt; {
test_aux_ser_deser(<span class="kw-2">&amp;</span>[])
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_block_serialize_simple() -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span>checkpoints = <span class="macro">vec!</span>[Checkpoint {
doc_range: <span class="number">10</span>..<span class="number">12</span>,
byte_range: <span class="number">100</span>..<span class="number">120</span>,
}];
test_aux_ser_deser(<span class="kw-2">&amp;</span>checkpoints)
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_block_serialize_large_byte_range() -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span>checkpoints = <span class="macro">vec!</span>[Checkpoint {
doc_range: <span class="number">10</span>..<span class="number">12</span>,
byte_range: <span class="number">8_000_000_000</span>..<span class="number">9_000_000_000</span>,
}];
test_aux_ser_deser(<span class="kw-2">&amp;</span>checkpoints)
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_block_serialize() -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span>offsets: Vec&lt;usize&gt; = (<span class="number">0</span>..<span class="number">11</span>).map(|i| i * i * i).collect();
<span class="kw">let </span><span class="kw-2">mut </span>checkpoints = <span class="macro">vec!</span>[];
<span class="kw">let </span><span class="kw-2">mut </span>start_doc = <span class="number">0</span>;
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{
<span class="kw">let </span>end_doc = (i * i) <span class="kw">as </span>DocId;
checkpoints.push(Checkpoint {
doc_range: start_doc..end_doc,
byte_range: offsets[i]..offsets[i + <span class="number">1</span>],
});
start_doc = end_doc;
}
test_aux_ser_deser(<span class="kw-2">&amp;</span>checkpoints)
}
}
</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>