| <!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/collector/filter_collector_wrapper.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>filter_collector_wrapper.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> |
| </pre><pre class="rust"><code><span class="comment">// # Custom collector example |
| // |
| // This example shows how you can implement your own |
| // collector. As an example, we will compute a collector |
| // that computes the standard deviation of a given fast field. |
| // |
| // Of course, you can have a look at the tantivy's built-in collectors |
| // such as the `CountCollector` for more examples. |
| |
| // --- |
| // Importing tantivy... |
| </span><span class="kw">use </span>std::marker::PhantomData; |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">use </span>fastfield_codecs::Column; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::collector::{Collector, SegmentCollector}; |
| <span class="kw">use </span><span class="kw">crate</span>::fastfield::FastValue; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::Field; |
| <span class="kw">use crate</span>::{Score, SegmentReader, TantivyError}; |
| |
| <span class="doccomment">/// The `FilterCollector` filters docs using a fast field value and a predicate. |
| /// Only the documents for which the predicate returned "true" will be passed on to the next |
| /// collector. |
| /// |
| /// ```rust |
| /// use tantivy::collector::{TopDocs, FilterCollector}; |
| /// use tantivy::query::QueryParser; |
| /// use tantivy::schema::{Schema, TEXT, INDEXED, FAST}; |
| /// use tantivy::{doc, DocAddress, Index}; |
| /// |
| /// # fn main() -> tantivy::Result<()> { |
| /// let mut schema_builder = Schema::builder(); |
| /// let title = schema_builder.add_text_field("title", TEXT); |
| /// let price = schema_builder.add_u64_field("price", INDEXED | FAST); |
| /// let schema = schema_builder.build(); |
| /// let index = Index::create_in_ram(schema); |
| /// |
| /// let mut index_writer = index.writer_with_num_threads(1, 10_000_000)?; |
| /// index_writer.add_document(doc!(title => "The Name of the Wind", price => 30_200u64))?; |
| /// index_writer.add_document(doc!(title => "The Diary of Muadib", price => 29_240u64))?; |
| /// index_writer.add_document(doc!(title => "A Dairy Cow", price => 21_240u64))?; |
| /// index_writer.add_document(doc!(title => "The Diary of a Young Girl", price => 20_120u64))?; |
| /// index_writer.commit()?; |
| /// |
| /// let reader = index.reader()?; |
| /// let searcher = reader.searcher(); |
| /// |
| /// let query_parser = QueryParser::for_index(&index, vec![title]); |
| /// let query = query_parser.parse_query("diary")?; |
| /// let no_filter_collector = FilterCollector::new(price, &|value: u64| value > 20_120u64, TopDocs::with_limit(2)); |
| /// let top_docs = searcher.search(&query, &no_filter_collector)?; |
| /// |
| /// assert_eq!(top_docs.len(), 1); |
| /// assert_eq!(top_docs[0].1, DocAddress::new(0, 1)); |
| /// |
| /// let filter_all_collector: FilterCollector<_, _, u64> = FilterCollector::new(price, &|value| value < 5u64, TopDocs::with_limit(2)); |
| /// let filtered_top_docs = searcher.search(&query, &filter_all_collector)?; |
| /// |
| /// assert_eq!(filtered_top_docs.len(), 0); |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub struct </span>FilterCollector<TCollector, TPredicate, TPredicateValue: FastValue> |
| <span class="kw">where </span>TPredicate: <span class="lifetime">'static </span>+ Clone |
| { |
| field: Field, |
| collector: TCollector, |
| predicate: TPredicate, |
| t_predicate_value: PhantomData<TPredicateValue>, |
| } |
| |
| <span class="kw">impl</span><TCollector, TPredicate, TPredicateValue: FastValue> |
| FilterCollector<TCollector, TPredicate, TPredicateValue> |
| <span class="kw">where |
| </span>TCollector: Collector + Send + Sync, |
| TPredicate: Fn(TPredicateValue) -> bool + Send + Sync + Clone, |
| { |
| <span class="doccomment">/// Create a new FilterCollector. |
| </span><span class="kw">pub fn </span>new( |
| field: Field, |
| predicate: TPredicate, |
| collector: TCollector, |
| ) -> FilterCollector<TCollector, TPredicate, TPredicateValue> { |
| FilterCollector { |
| field, |
| predicate, |
| collector, |
| t_predicate_value: PhantomData, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><TCollector, TPredicate, TPredicateValue: FastValue> Collector |
| <span class="kw">for </span>FilterCollector<TCollector, TPredicate, TPredicateValue> |
| <span class="kw">where |
| </span>TCollector: Collector + Send + Sync, |
| TPredicate: <span class="lifetime">'static </span>+ Fn(TPredicateValue) -> bool + Send + Sync + Clone, |
| TPredicateValue: FastValue, |
| { |
| <span class="comment">// That's the type of our result. |
| // Our standard deviation will be a float. |
| </span><span class="kw">type </span>Fruit = TCollector::Fruit; |
| |
| <span class="kw">type </span>Child = FilterSegmentCollector<TCollector::Child, TPredicate, TPredicateValue>; |
| |
| <span class="kw">fn </span>for_segment( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| segment_local_id: u32, |
| segment_reader: <span class="kw-2">&</span>SegmentReader, |
| ) -> <span class="kw">crate</span>::Result<FilterSegmentCollector<TCollector::Child, TPredicate, TPredicateValue>> { |
| <span class="kw">let </span>schema = segment_reader.schema(); |
| <span class="kw">let </span>field_entry = schema.get_field_entry(<span class="self">self</span>.field); |
| <span class="kw">if </span>!field_entry.is_fast() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::SchemaError(<span class="macro">format!</span>( |
| <span class="string">"Field {:?} is not a fast field."</span>, |
| field_entry.name() |
| ))); |
| } |
| <span class="kw">let </span>requested_type = TPredicateValue::to_type(); |
| <span class="kw">let </span>field_schema_type = field_entry.field_type().value_type(); |
| <span class="kw">if </span>requested_type != field_schema_type { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::SchemaError(<span class="macro">format!</span>( |
| <span class="string">"Field {:?} is of type {:?}!={:?}"</span>, |
| field_entry.name(), |
| requested_type, |
| field_schema_type |
| ))); |
| } |
| |
| <span class="kw">let </span>fast_field_reader = segment_reader |
| .fast_fields() |
| .typed_fast_field_reader(<span class="self">self</span>.field)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>segment_collector = <span class="self">self |
| </span>.collector |
| .for_segment(segment_local_id, segment_reader)<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(FilterSegmentCollector { |
| fast_field_reader, |
| segment_collector, |
| predicate: <span class="self">self</span>.predicate.clone(), |
| t_predicate_value: PhantomData, |
| }) |
| } |
| |
| <span class="kw">fn </span>requires_scoring(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.collector.requires_scoring() |
| } |
| |
| <span class="kw">fn </span>merge_fruits( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| segment_fruits: Vec<<TCollector::Child <span class="kw">as </span>SegmentCollector>::Fruit>, |
| ) -> <span class="kw">crate</span>::Result<TCollector::Fruit> { |
| <span class="self">self</span>.collector.merge_fruits(segment_fruits) |
| } |
| } |
| |
| <span class="kw">pub struct </span>FilterSegmentCollector<TSegmentCollector, TPredicate, TPredicateValue> |
| <span class="kw">where |
| </span>TPredicate: <span class="lifetime">'static</span>, |
| TPredicateValue: FastValue, |
| { |
| fast_field_reader: Arc<<span class="kw">dyn </span>Column<TPredicateValue>>, |
| segment_collector: TSegmentCollector, |
| predicate: TPredicate, |
| t_predicate_value: PhantomData<TPredicateValue>, |
| } |
| |
| <span class="kw">impl</span><TSegmentCollector, TPredicate, TPredicateValue> SegmentCollector |
| <span class="kw">for </span>FilterSegmentCollector<TSegmentCollector, TPredicate, TPredicateValue> |
| <span class="kw">where |
| </span>TSegmentCollector: SegmentCollector, |
| TPredicate: <span class="lifetime">'static </span>+ Fn(TPredicateValue) -> bool + Send + Sync, |
| TPredicateValue: FastValue, |
| { |
| <span class="kw">type </span>Fruit = TSegmentCollector::Fruit; |
| |
| <span class="kw">fn </span>collect(<span class="kw-2">&mut </span><span class="self">self</span>, doc: u32, score: Score) { |
| <span class="kw">let </span>value = <span class="self">self</span>.fast_field_reader.get_val(doc); |
| <span class="kw">if </span>(<span class="self">self</span>.predicate)(value) { |
| <span class="self">self</span>.segment_collector.collect(doc, score) |
| } |
| } |
| |
| <span class="kw">fn </span>harvest(<span class="self">self</span>) -> <TSegmentCollector <span class="kw">as </span>SegmentCollector>::Fruit { |
| <span class="self">self</span>.segment_collector.harvest() |
| } |
| } |
| </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> |
