| <!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/docset.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>docset.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::borrow::{Borrow, BorrowMut}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::fastfield::AliveBitSet; |
| <span class="kw">use </span><span class="kw">crate</span>::DocId; |
| |
| <span class="doccomment">/// Sentinel value returned when a [`DocSet`] has been entirely consumed. |
| /// |
| /// This is not `u32::MAX` as one would have expected, due to the lack of SSE2 instructions |
| /// to compare `[u32; 4]`. |
| </span><span class="kw">pub const </span>TERMINATED: DocId = i32::MAX <span class="kw">as </span>u32; |
| |
| <span class="doccomment">/// Represents an iterable set of sorted doc ids. |
| </span><span class="kw">pub trait </span>DocSet: Send { |
| <span class="doccomment">/// Goes to the next element. |
| /// |
| /// The DocId of the next element is returned. |
| /// In other words we should always have : |
| /// ```ignore |
| /// let doc = docset.advance(); |
| /// assert_eq!(doc, docset.doc()); |
| /// ``` |
| /// |
| /// If we reached the end of the `DocSet`, [`TERMINATED`] should be returned. |
| /// |
| /// Calling `.advance()` on a terminated `DocSet` should be supported, and [`TERMINATED`] should |
| /// be returned. |
| </span><span class="kw">fn </span>advance(<span class="kw-2">&mut </span><span class="self">self</span>) -> DocId; |
| |
| <span class="doccomment">/// Advances the `DocSet` forward until reaching the target, or going to the |
| /// lowest [`DocId`] greater than the target. |
| /// |
| /// If the end of the `DocSet` is reached, [`TERMINATED`] is returned. |
| /// |
| /// Calling `.seek(target)` on a terminated `DocSet` is legal. Implementation |
| /// of `DocSet` should support it. |
| /// |
| /// Calling `seek(TERMINATED)` is also legal and is the normal way to consume a `DocSet`. |
| </span><span class="kw">fn </span>seek(<span class="kw-2">&mut </span><span class="self">self</span>, target: DocId) -> DocId { |
| <span class="kw">let </span><span class="kw-2">mut </span>doc = <span class="self">self</span>.doc(); |
| <span class="macro">debug_assert!</span>(doc <= target); |
| <span class="kw">while </span>doc < target { |
| doc = <span class="self">self</span>.advance(); |
| } |
| doc |
| } |
| |
| <span class="doccomment">/// Fills a given mutable buffer with the next doc ids from the |
| /// `DocSet` |
| /// |
| /// If that many `DocId`s are available, the method should |
| /// fill the entire buffer and return the length of the buffer. |
| /// |
| /// If we reach the end of the `DocSet` before filling |
| /// it entirely, then the buffer is filled up to this point, and |
| /// return value is the number of elements that were filled. |
| /// |
| /// # Warning |
| /// |
| /// This method is only here for specific high-performance |
| /// use case where batching. The normal way to |
| /// go through the `DocId`'s is to call `.advance()`. |
| </span><span class="kw">fn </span>fill_buffer(<span class="kw-2">&mut </span><span class="self">self</span>, buffer: <span class="kw-2">&mut </span>[DocId]) -> usize { |
| <span class="kw">if </span><span class="self">self</span>.doc() == TERMINATED { |
| <span class="kw">return </span><span class="number">0</span>; |
| } |
| <span class="kw">for </span>(i, buffer_val) <span class="kw">in </span>buffer.iter_mut().enumerate() { |
| <span class="kw-2">*</span>buffer_val = <span class="self">self</span>.doc(); |
| <span class="kw">if </span><span class="self">self</span>.advance() == TERMINATED { |
| <span class="kw">return </span>i + <span class="number">1</span>; |
| } |
| } |
| buffer.len() |
| } |
| |
| <span class="doccomment">/// Returns the current document |
| /// Right after creating a new `DocSet`, the docset points to the first document. |
| /// |
| /// If the `DocSet` is empty, `.doc()` should return [`TERMINATED`]. |
| </span><span class="kw">fn </span>doc(<span class="kw-2">&</span><span class="self">self</span>) -> DocId; |
| |
| <span class="doccomment">/// Returns a best-effort hint of the |
| /// length of the docset. |
| </span><span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> u32; |
| |
| <span class="doccomment">/// Returns the number documents matching. |
| /// Calling this method consumes the `DocSet`. |
| </span><span class="kw">fn </span>count(<span class="kw-2">&mut </span><span class="self">self</span>, alive_bitset: <span class="kw-2">&</span>AliveBitSet) -> u32 { |
| <span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">0u32</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>doc = <span class="self">self</span>.doc(); |
| <span class="kw">while </span>doc != TERMINATED { |
| <span class="kw">if </span>alive_bitset.is_alive(doc) { |
| count += <span class="number">1u32</span>; |
| } |
| doc = <span class="self">self</span>.advance(); |
| } |
| count |
| } |
| |
| <span class="doccomment">/// Returns the count of documents, deleted or not. |
| /// Calling this method consumes the `DocSet`. |
| /// |
| /// Of course, the result is an upper bound of the result |
| /// given by `count()`. |
| </span><span class="kw">fn </span>count_including_deleted(<span class="kw-2">&mut </span><span class="self">self</span>) -> u32 { |
| <span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">0u32</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>doc = <span class="self">self</span>.doc(); |
| <span class="kw">while </span>doc != TERMINATED { |
| count += <span class="number">1u32</span>; |
| doc = <span class="self">self</span>.advance(); |
| } |
| count |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> DocSet <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="kw">dyn </span>DocSet { |
| <span class="kw">fn </span>advance(<span class="kw-2">&mut </span><span class="self">self</span>) -> u32 { |
| (<span class="kw-2">**</span><span class="self">self</span>).advance() |
| } |
| |
| <span class="kw">fn </span>seek(<span class="kw-2">&mut </span><span class="self">self</span>, target: DocId) -> DocId { |
| (<span class="kw-2">**</span><span class="self">self</span>).seek(target) |
| } |
| |
| <span class="kw">fn </span>doc(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| (<span class="kw-2">**</span><span class="self">self</span>).doc() |
| } |
| |
| <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| (<span class="kw-2">**</span><span class="self">self</span>).size_hint() |
| } |
| |
| <span class="kw">fn </span>count(<span class="kw-2">&mut </span><span class="self">self</span>, alive_bitset: <span class="kw-2">&</span>AliveBitSet) -> u32 { |
| (<span class="kw-2">**</span><span class="self">self</span>).count(alive_bitset) |
| } |
| |
| <span class="kw">fn </span>count_including_deleted(<span class="kw-2">&mut </span><span class="self">self</span>) -> u32 { |
| (<span class="kw-2">**</span><span class="self">self</span>).count_including_deleted() |
| } |
| } |
| |
| <span class="kw">impl</span><TDocSet: DocSet + <span class="question-mark">?</span>Sized> DocSet <span class="kw">for </span>Box<TDocSet> { |
| <span class="kw">fn </span>advance(<span class="kw-2">&mut </span><span class="self">self</span>) -> DocId { |
| <span class="kw">let </span>unboxed: <span class="kw-2">&mut </span>TDocSet = <span class="self">self</span>.borrow_mut(); |
| unboxed.advance() |
| } |
| |
| <span class="kw">fn </span>seek(<span class="kw-2">&mut </span><span class="self">self</span>, target: DocId) -> DocId { |
| <span class="kw">let </span>unboxed: <span class="kw-2">&mut </span>TDocSet = <span class="self">self</span>.borrow_mut(); |
| unboxed.seek(target) |
| } |
| |
| <span class="kw">fn </span>doc(<span class="kw-2">&</span><span class="self">self</span>) -> DocId { |
| <span class="kw">let </span>unboxed: <span class="kw-2">&</span>TDocSet = <span class="self">self</span>.borrow(); |
| unboxed.doc() |
| } |
| |
| <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| <span class="kw">let </span>unboxed: <span class="kw-2">&</span>TDocSet = <span class="self">self</span>.borrow(); |
| unboxed.size_hint() |
| } |
| |
| <span class="kw">fn </span>count(<span class="kw-2">&mut </span><span class="self">self</span>, alive_bitset: <span class="kw-2">&</span>AliveBitSet) -> u32 { |
| <span class="kw">let </span>unboxed: <span class="kw-2">&mut </span>TDocSet = <span class="self">self</span>.borrow_mut(); |
| unboxed.count(alive_bitset) |
| } |
| |
| <span class="kw">fn </span>count_including_deleted(<span class="kw-2">&mut </span><span class="self">self</span>) -> u32 { |
| <span class="kw">let </span>unboxed: <span class="kw-2">&mut </span>TDocSet = <span class="self">self</span>.borrow_mut(); |
| unboxed.count_including_deleted() |
| } |
| } |
| </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> |
