| <!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/aggregation/agg_req_with_accessor.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>agg_req_with_accessor.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> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! This will enhance the request tree with access to the fastfield and metadata. |
| |
| </span><span class="kw">use </span>std::rc::Rc; |
| <span class="kw">use </span>std::sync::atomic::AtomicU32; |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">use </span>fastfield_codecs::Column; |
| |
| <span class="kw">use </span><span class="kw">super</span>::agg_req::{Aggregation, Aggregations, BucketAggregationType, MetricAggregation}; |
| <span class="kw">use </span><span class="kw">super</span>::bucket::{HistogramAggregation, RangeAggregation, TermsAggregation}; |
| <span class="kw">use </span><span class="kw">super</span>::metric::{AverageAggregation, StatsAggregation}; |
| <span class="kw">use </span><span class="kw">super</span>::segment_agg_result::BucketCount; |
| <span class="kw">use </span><span class="kw">super</span>::VecWithNames; |
| <span class="kw">use </span><span class="kw">crate</span>::fastfield::{type_and_cardinality, MultiValuedFastFieldReader}; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::{Cardinality, Type}; |
| <span class="kw">use crate</span>::{InvertedIndexReader, SegmentReader, TantivyError}; |
| |
| <span class="attribute">#[derive(Clone, Default)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>AggregationsWithAccessor { |
| <span class="kw">pub </span>metrics: VecWithNames<MetricAggregationWithAccessor>, |
| <span class="kw">pub </span>buckets: VecWithNames<BucketAggregationWithAccessor>, |
| } |
| |
| <span class="kw">impl </span>AggregationsWithAccessor { |
| <span class="kw">fn </span>from_data( |
| metrics: VecWithNames<MetricAggregationWithAccessor>, |
| buckets: VecWithNames<BucketAggregationWithAccessor>, |
| ) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ metrics, buckets } |
| } |
| |
| <span class="kw">pub fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.metrics.is_empty() && <span class="self">self</span>.buckets.is_empty() |
| } |
| } |
| |
| <span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>FastFieldAccessor { |
| Multi(MultiValuedFastFieldReader<u64>), |
| Single(Arc<<span class="kw">dyn </span>Column<u64>>), |
| } |
| <span class="kw">impl </span>FastFieldAccessor { |
| <span class="kw">pub fn </span>as_single(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="kw">dyn </span>Column<u64>> { |
| <span class="kw">match </span><span class="self">self </span>{ |
| FastFieldAccessor::Multi(<span class="kw">_</span>) => <span class="prelude-val">None</span>, |
| FastFieldAccessor::Single(reader) => <span class="prelude-val">Some</span>(<span class="kw-2">&**</span>reader), |
| } |
| } |
| <span class="kw">pub fn </span>into_single(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><Arc<<span class="kw">dyn </span>Column<u64>>> { |
| <span class="kw">match </span><span class="self">self </span>{ |
| FastFieldAccessor::Multi(<span class="kw">_</span>) => <span class="prelude-val">None</span>, |
| FastFieldAccessor::Single(reader) => <span class="prelude-val">Some</span>(reader), |
| } |
| } |
| <span class="kw">pub fn </span>as_multi(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>MultiValuedFastFieldReader<u64>> { |
| <span class="kw">match </span><span class="self">self </span>{ |
| FastFieldAccessor::Multi(reader) => <span class="prelude-val">Some</span>(reader), |
| FastFieldAccessor::Single(<span class="kw">_</span>) => <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>BucketAggregationWithAccessor { |
| <span class="doccomment">/// In general there can be buckets without fast field access, e.g. buckets that are created |
| /// based on search terms. So eventually this needs to be Option or moved. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) accessor: FastFieldAccessor, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) inverted_index: <span class="prelude-ty">Option</span><Arc<InvertedIndexReader>>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) field_type: Type, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) bucket_agg: BucketAggregationType, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) sub_aggregation: AggregationsWithAccessor, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) bucket_count: BucketCount, |
| } |
| |
| <span class="kw">impl </span>BucketAggregationWithAccessor { |
| <span class="kw">fn </span>try_from_bucket( |
| bucket: <span class="kw-2">&</span>BucketAggregationType, |
| sub_aggregation: <span class="kw-2">&</span>Aggregations, |
| reader: <span class="kw-2">&</span>SegmentReader, |
| bucket_count: Rc<AtomicU32>, |
| max_bucket_count: u32, |
| ) -> <span class="kw">crate</span>::Result<BucketAggregationWithAccessor> { |
| <span class="kw">let </span><span class="kw-2">mut </span>inverted_index = <span class="prelude-val">None</span>; |
| <span class="kw">let </span>(accessor, field_type) = <span class="kw">match </span><span class="kw-2">&</span>bucket { |
| BucketAggregationType::Range(RangeAggregation { |
| field: field_name, .. |
| }) => get_ff_reader_and_validate(reader, field_name, Cardinality::SingleValue)<span class="question-mark">?</span>, |
| BucketAggregationType::Histogram(HistogramAggregation { |
| field: field_name, .. |
| }) => get_ff_reader_and_validate(reader, field_name, Cardinality::SingleValue)<span class="question-mark">?</span>, |
| BucketAggregationType::Terms(TermsAggregation { |
| field: field_name, .. |
| }) => { |
| <span class="kw">let </span>field = reader |
| .schema() |
| .get_field(field_name) |
| .ok_or_else(|| TantivyError::FieldNotFound(field_name.to_string()))<span class="question-mark">?</span>; |
| inverted_index = <span class="prelude-val">Some</span>(reader.inverted_index(field)<span class="question-mark">?</span>); |
| get_ff_reader_and_validate(reader, field_name, Cardinality::MultiValues)<span class="question-mark">? |
| </span>} |
| }; |
| <span class="kw">let </span>sub_aggregation = sub_aggregation.clone(); |
| <span class="prelude-val">Ok</span>(BucketAggregationWithAccessor { |
| accessor, |
| field_type, |
| sub_aggregation: get_aggs_with_accessor_and_validate( |
| <span class="kw-2">&</span>sub_aggregation, |
| reader, |
| bucket_count.clone(), |
| max_bucket_count, |
| )<span class="question-mark">?</span>, |
| bucket_agg: bucket.clone(), |
| inverted_index, |
| bucket_count: BucketCount { |
| bucket_count, |
| max_bucket_count, |
| }, |
| }) |
| } |
| } |
| |
| <span class="doccomment">/// Contains the metric request and the fast field accessor. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>MetricAggregationWithAccessor { |
| <span class="kw">pub </span>metric: MetricAggregation, |
| <span class="kw">pub </span>field_type: Type, |
| <span class="kw">pub </span>accessor: Arc<<span class="kw">dyn </span>Column>, |
| } |
| |
| <span class="kw">impl </span>MetricAggregationWithAccessor { |
| <span class="kw">fn </span>try_from_metric( |
| metric: <span class="kw-2">&</span>MetricAggregation, |
| reader: <span class="kw-2">&</span>SegmentReader, |
| ) -> <span class="kw">crate</span>::Result<MetricAggregationWithAccessor> { |
| <span class="kw">match </span><span class="kw-2">&</span>metric { |
| MetricAggregation::Average(AverageAggregation { field: field_name }) |
| | MetricAggregation::Stats(StatsAggregation { field: field_name }) => { |
| <span class="kw">let </span>(accessor, field_type) = |
| get_ff_reader_and_validate(reader, field_name, Cardinality::SingleValue)<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(MetricAggregationWithAccessor { |
| accessor: accessor |
| .into_single() |
| .expect(<span class="string">"unexpected fast field cardinality"</span>), |
| field_type, |
| metric: metric.clone(), |
| }) |
| } |
| } |
| } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_aggs_with_accessor_and_validate( |
| aggs: <span class="kw-2">&</span>Aggregations, |
| reader: <span class="kw-2">&</span>SegmentReader, |
| bucket_count: Rc<AtomicU32>, |
| max_bucket_count: u32, |
| ) -> <span class="kw">crate</span>::Result<AggregationsWithAccessor> { |
| <span class="kw">let </span><span class="kw-2">mut </span>metrics = <span class="macro">vec!</span>[]; |
| <span class="kw">let </span><span class="kw-2">mut </span>buckets = <span class="macro">vec!</span>[]; |
| <span class="kw">for </span>(key, agg) <span class="kw">in </span>aggs.iter() { |
| <span class="kw">match </span>agg { |
| Aggregation::Bucket(bucket) => buckets.push(( |
| key.to_string(), |
| BucketAggregationWithAccessor::try_from_bucket( |
| <span class="kw-2">&</span>bucket.bucket_agg, |
| <span class="kw-2">&</span>bucket.sub_aggregation, |
| reader, |
| Rc::clone(<span class="kw-2">&</span>bucket_count), |
| max_bucket_count, |
| )<span class="question-mark">?</span>, |
| )), |
| Aggregation::Metric(metric) => metrics.push(( |
| key.to_string(), |
| MetricAggregationWithAccessor::try_from_metric(metric, reader)<span class="question-mark">?</span>, |
| )), |
| } |
| } |
| <span class="prelude-val">Ok</span>(AggregationsWithAccessor::from_data( |
| VecWithNames::from_entries(metrics), |
| VecWithNames::from_entries(buckets), |
| )) |
| } |
| |
| <span class="doccomment">/// Get fast field reader with given cardinatility. |
| </span><span class="kw">fn </span>get_ff_reader_and_validate( |
| reader: <span class="kw-2">&</span>SegmentReader, |
| field_name: <span class="kw-2">&</span>str, |
| cardinality: Cardinality, |
| ) -> <span class="kw">crate</span>::Result<(FastFieldAccessor, Type)> { |
| <span class="kw">let </span>field = reader |
| .schema() |
| .get_field(field_name) |
| .ok_or_else(|| TantivyError::FieldNotFound(field_name.to_string()))<span class="question-mark">?</span>; |
| <span class="kw">let </span>field_type = reader.schema().get_field_entry(field).field_type(); |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>((_ff_type, field_cardinality)) = type_and_cardinality(field_type) { |
| <span class="kw">if </span>cardinality != field_cardinality { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::InvalidArgument(<span class="macro">format!</span>( |
| <span class="string">"Invalid field cardinality on field {} expected {:?}, but got {:?}"</span>, |
| field_name, cardinality, field_cardinality |
| ))); |
| } |
| } <span class="kw">else </span>{ |
| <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::InvalidArgument(<span class="macro">format!</span>( |
| <span class="string">"Only fast fields of type f64, u64, i64 are supported, but got {:?} "</span>, |
| field_type.value_type() |
| ))); |
| }; |
| |
| <span class="kw">let </span>ff_fields = reader.fast_fields(); |
| <span class="kw">match </span>cardinality { |
| Cardinality::SingleValue => ff_fields |
| .u64_lenient(field) |
| .map(|field| (FastFieldAccessor::Single(field), field_type.value_type())), |
| Cardinality::MultiValues => ff_fields |
| .u64s_lenient(field) |
| .map(|field| (FastFieldAccessor::Multi(field), field_type.value_type())), |
| } |
| } |
| </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> |
