blob: f4b7d742c08487c87773ec82e6d335eb417c3657 [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/indexer/doc_opstamp_mapping.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>doc_opstamp_mapping.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>
</pre><pre class="rust"><code><span class="kw">use crate</span>::{DocId, Opstamp};
<span class="comment">// Doc to opstamp is used to identify which
// document should be deleted.
//
// Since the docset matching the query of a delete operation
// is not computed right when the delete operation is received,
// we need to find a way to evaluate, for each document,
// whether the document was added before or after
// the delete operation. This anteriority is used by comparing
// the docstamp of the document.
//
// The doc to opstamp mapping stores precisely an array
// indexed by doc id and storing the opstamp of the document.
//
// This mapping is NOT necessarily increasing, because
// we might be sorting documents according to a fast field.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub enum </span>DocToOpstampMapping&lt;<span class="lifetime">&#39;a</span>&gt; {
WithMap(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[Opstamp]),
<span class="prelude-val">None</span>,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; DocToOpstampMapping&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// Assess whether a document should be considered deleted given that it contains
/// a deleted term that was deleted at the opstamp: `delete_opstamp`.
///
/// This function returns true if the `DocToOpstamp` mapping is none or if
/// the `doc_opstamp` is anterior to the delete opstamp.
</span><span class="kw">pub fn </span>is_deleted(<span class="kw-2">&amp;</span><span class="self">self</span>, doc_id: DocId, delete_opstamp: Opstamp) -&gt; bool {
<span class="kw">match </span><span class="self">self </span>{
<span class="self">Self</span>::WithMap(doc_opstamps) =&gt; {
<span class="kw">let </span>doc_opstamp = doc_opstamps[doc_id <span class="kw">as </span>usize];
doc_opstamp &lt; delete_opstamp
}
<span class="self">Self</span>::None =&gt; <span class="bool-val">true</span>,
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::DocToOpstampMapping;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_doc_to_opstamp_mapping_none() {
<span class="kw">let </span>doc_to_opstamp_mapping = DocToOpstampMapping::None;
<span class="macro">assert!</span>(doc_to_opstamp_mapping.is_deleted(<span class="number">1u32</span>, <span class="number">0u64</span>));
<span class="macro">assert!</span>(doc_to_opstamp_mapping.is_deleted(<span class="number">1u32</span>, <span class="number">2u64</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_doc_to_opstamp_mapping_with_map() {
<span class="kw">let </span>doc_to_opstamp_mapping = DocToOpstampMapping::WithMap(<span class="kw-2">&amp;</span>[<span class="number">5u64</span>, <span class="number">1u64</span>, <span class="number">0u64</span>, <span class="number">4u64</span>, <span class="number">3u64</span>]);
<span class="macro">assert_eq!</span>(doc_to_opstamp_mapping.is_deleted(<span class="number">0u32</span>, <span class="number">2u64</span>), <span class="bool-val">false</span>);
<span class="macro">assert_eq!</span>(doc_to_opstamp_mapping.is_deleted(<span class="number">1u32</span>, <span class="number">2u64</span>), <span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(doc_to_opstamp_mapping.is_deleted(<span class="number">2u32</span>, <span class="number">2u64</span>), <span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(doc_to_opstamp_mapping.is_deleted(<span class="number">3u32</span>, <span class="number">2u64</span>), <span class="bool-val">false</span>);
<span class="macro">assert_eq!</span>(doc_to_opstamp_mapping.is_deleted(<span class="number">4u32</span>, <span class="number">2u64</span>), <span class="bool-val">false</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>