api-docs/crates-enclave/src/tantivy/aggregation/agg_result.rs.html - incubator-teaclave-website - Git at Google

 <!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_result.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>agg_result.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>
 <span id="221">221</span>
 <span id="222">222</span>
 <span id="223">223</span>
 <span id="224">224</span>
 <span id="225">225</span>
 <span id="226">226</span>
 <span id="227">227</span>
 <span id="228">228</span>
 <span id="229">229</span>
 <span id="230">230</span>
 <span id="231">231</span>
 <span id="232">232</span>
 <span id="233">233</span>
 <span id="234">234</span>
 <span id="235">235</span>
 <span id="236">236</span>
 <span id="237">237</span>
 <span id="238">238</span>
 <span id="239">239</span>
 <span id="240">240</span>
 <span id="241">241</span>
 <span id="242">242</span>
 <span id="243">243</span>
 <span id="244">244</span>
 <span id="245">245</span>
 <span id="246">246</span>
 <span id="247">247</span>
 <span id="248">248</span>
 <span id="249">249</span>
 <span id="250">250</span>
 <span id="251">251</span>
 <span id="252">252</span>
 <span id="253">253</span>
 <span id="254">254</span>
 </pre><pre class="rust"><code><span class="doccomment">//! Contains the final aggregation tree.
 //! This tree can be converted via the `into()` method from `IntermediateAggregationResults`.
 //! This conversion computes the final result. For example: The intermediate result contains
 //! intermediate average results, which is the sum and the number of values. The actual average is
 //! calculated on the step from intermediate to final aggregation result tree.

 </span><span class="kw">use </span>rustc_hash::FxHashMap;
 <span class="kw">use </span>serde::{Deserialize, Serialize};

 <span class="kw">use </span><span class="kw">super</span>::agg_req::BucketAggregationInternal;
 <span class="kw">use </span><span class="kw">super</span>::bucket::GetDocCount;
 <span class="kw">use </span><span class="kw">super</span>::intermediate_agg_result::{IntermediateBucketResult, IntermediateMetricResult};
 <span class="kw">use </span><span class="kw">super</span>::metric::{SingleMetricResult, Stats};
 <span class="kw">use </span><span class="kw">super</span>::Key;
 <span class="kw">use </span><span class="kw">crate</span>::schema::Schema;
 <span class="kw">use </span><span class="kw">crate</span>::TantivyError;

 <span class="attribute">#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
 </span><span class="doccomment">/// The final aggegation result.
 </span><span class="kw">pub struct </span>AggregationResults(<span class="kw">pub </span>FxHashMap&lt;String, AggregationResult&gt;);

 <span class="kw">impl </span>AggregationResults {
     <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_value_from_aggregation(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
         name: <span class="kw-2">&amp;</span>str,
         agg_property: <span class="kw-2">&amp;</span>str,
     ) -&gt; <span class="kw">crate</span>::Result&lt;<span class="prelude-ty">Option</span>&lt;f64&gt;&gt; {
         <span class="kw">if let </span><span class="prelude-val">Some</span>(agg) = <span class="self">self</span>.<span class="number">0</span>.get(name) {
             agg.get_value_from_aggregation(name, agg_property)
         } <span class="kw">else </span>{
             <span class="comment">// Validation is be done during request parsing, so we can&#39;t reach this state.
             </span><span class="prelude-val">Err</span>(TantivyError::InternalError(<span class="macro">format!</span>(
                 <span class="string">&quot;Can&#39;t find aggregation {:?} in sub_aggregations&quot;</span>,
                 name
             )))
         }
     }
 }

 <span class="attribute">#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 #[serde(untagged)]
 </span><span class="doccomment">/// An aggregation is either a bucket or a metric.
 </span><span class="kw">pub enum </span>AggregationResult {
     <span class="doccomment">/// Bucket result variant.
     </span>BucketResult(BucketResult),
     <span class="doccomment">/// Metric result variant.
     </span>MetricResult(MetricResult),
 }

 <span class="kw">impl </span>AggregationResult {
     <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_value_from_aggregation(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
         _name: <span class="kw-2">&amp;</span>str,
         agg_property: <span class="kw-2">&amp;</span>str,
     ) -&gt; <span class="kw">crate</span>::Result&lt;<span class="prelude-ty">Option</span>&lt;f64&gt;&gt; {
         <span class="kw">match </span><span class="self">self </span>{
             AggregationResult::BucketResult(_bucket) =&gt; <span class="prelude-val">Err</span>(TantivyError::InternalError(
                 <span class="string">&quot;Tried to retrieve value from bucket aggregation. This is not supported and \
                  should not happen during collection phase, but should be caught during validation&quot;
                     </span>.to_string(),
             )),
             AggregationResult::MetricResult(metric) =&gt; metric.get_value(agg_property),
         }
     }
 }

 <span class="attribute">#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 #[serde(untagged)]
 </span><span class="doccomment">/// MetricResult
 </span><span class="kw">pub enum </span>MetricResult {
     <span class="doccomment">/// Average metric result.
     </span>Average(SingleMetricResult),
     <span class="doccomment">/// Stats metric result.
     </span>Stats(Stats),
 }

 <span class="kw">impl </span>MetricResult {
     <span class="kw">fn </span>get_value(<span class="kw-2">&amp;</span><span class="self">self</span>, agg_property: <span class="kw-2">&amp;</span>str) -&gt; <span class="kw">crate</span>::Result&lt;<span class="prelude-ty">Option</span>&lt;f64&gt;&gt; {
         <span class="kw">match </span><span class="self">self </span>{
             MetricResult::Average(avg) =&gt; <span class="prelude-val">Ok</span>(avg.value),
             MetricResult::Stats(stats) =&gt; stats.get_value(agg_property),
         }
     }
 }
 <span class="kw">impl </span>From&lt;IntermediateMetricResult&gt; <span class="kw">for </span>MetricResult {
     <span class="kw">fn </span>from(metric: IntermediateMetricResult) -&gt; <span class="self">Self </span>{
         <span class="kw">match </span>metric {
             IntermediateMetricResult::Average(avg_data) =&gt; {
                 MetricResult::Average(avg_data.finalize().into())
             }
             IntermediateMetricResult::Stats(intermediate_stats) =&gt; {
                 MetricResult::Stats(intermediate_stats.finalize())
             }
         }
     }
 }

 <span class="doccomment">/// BucketEntry holds bucket aggregation result types.
 </span><span class="attribute">#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 #[serde(untagged)]
 </span><span class="kw">pub enum </span>BucketResult {
     <span class="doccomment">/// This is the range entry for a bucket, which contains a key, count, from, to, and optionally
     /// sub_aggregations.
     </span>Range {
         <span class="doccomment">/// The range buckets sorted by range.
         </span>buckets: BucketEntries&lt;RangeBucketEntry&gt;,
     },
     <span class="doccomment">/// This is the histogram entry for a bucket, which contains a key, count, and optionally
     /// sub_aggregations.
     </span>Histogram {
         <span class="doccomment">/// The buckets.
         ///
         /// If there are holes depends on the request, if min_doc_count is 0, then there are no
         /// holes between the first and last bucket.
         /// See [`HistogramAggregation`](super::bucket::HistogramAggregation)
         </span>buckets: BucketEntries&lt;BucketEntry&gt;,
     },
     <span class="doccomment">/// This is the term result
     </span>Terms {
         <span class="doccomment">/// The buckets.
         ///
         /// See [`TermsAggregation`](super::bucket::TermsAggregation)
         </span>buckets: Vec&lt;BucketEntry&gt;,
         <span class="doccomment">/// The number of documents that didn’t make it into to TOP N due to shard_size or size
         </span>sum_other_doc_count: u64,
         <span class="attribute">#[serde(skip_serializing_if = <span class="string">&quot;Option::is_none&quot;</span>)]
         </span><span class="doccomment">/// The upper bound error for the doc count of each term.
         </span>doc_count_error_upper_bound: <span class="prelude-ty">Option</span>&lt;u64&gt;,
     },
 }

 <span class="kw">impl </span>BucketResult {
     <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>empty_from_req(
         req: <span class="kw-2">&amp;</span>BucketAggregationInternal,
         schema: <span class="kw-2">&amp;</span>Schema,
     ) -&gt; <span class="kw">crate</span>::Result&lt;<span class="self">Self</span>&gt; {
         <span class="kw">let </span>empty_bucket = IntermediateBucketResult::empty_from_req(<span class="kw-2">&amp;</span>req.bucket_agg);
         empty_bucket.into_final_bucket_result(req, schema)
     }
 }

 <span class="doccomment">/// This is the wrapper of buckets entries, which can be vector or hashmap
 /// depending on if it&#39;s keyed or not.
 </span><span class="attribute">#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 #[serde(untagged)]
 </span><span class="kw">pub enum </span>BucketEntries&lt;T&gt; {
     <span class="doccomment">/// Vector format bucket entries
     </span>Vec(Vec&lt;T&gt;),
     <span class="doccomment">/// HashMap format bucket entries
     </span>HashMap(FxHashMap&lt;String, T&gt;),
 }

 <span class="doccomment">/// This is the default entry for a bucket, which contains a key, count, and optionally
 /// sub_aggregations.
 ///
 /// # JSON Format
 /// ```json
 /// {
 ///   ...
 ///     &quot;my_histogram&quot;: {
 ///       &quot;buckets&quot;: [
 ///         {
 ///           &quot;key&quot;: &quot;2.0&quot;,
 ///           &quot;doc_count&quot;: 5
 ///         },
 ///         {
 ///           &quot;key&quot;: &quot;4.0&quot;,
 ///           &quot;doc_count&quot;: 2
 ///         },
 ///         {
 ///           &quot;key&quot;: &quot;6.0&quot;,
 ///           &quot;doc_count&quot;: 3
 ///         }
 ///       ]
 ///    }
 ///    ...
 /// }
 /// ```
 </span><span class="attribute">#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 </span><span class="kw">pub struct </span>BucketEntry {
     <span class="attribute">#[serde(skip_serializing_if = <span class="string">&quot;Option::is_none&quot;</span>)]
     </span><span class="doccomment">/// The string representation of the bucket.
     </span><span class="kw">pub </span>key_as_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
     <span class="doccomment">/// The identifier of the bucket.
     </span><span class="kw">pub </span>key: Key,
     <span class="doccomment">/// Number of documents in the bucket.
     </span><span class="kw">pub </span>doc_count: u64,
     <span class="attribute">#[serde(flatten)]
     </span><span class="doccomment">/// Sub-aggregations in this bucket.
     </span><span class="kw">pub </span>sub_aggregation: AggregationResults,
 }
 <span class="kw">impl </span>GetDocCount <span class="kw">for </span><span class="kw-2">&amp;</span>BucketEntry {
     <span class="kw">fn </span>doc_count(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 {
         <span class="self">self</span>.doc_count
     }
 }
 <span class="kw">impl </span>GetDocCount <span class="kw">for </span>BucketEntry {
     <span class="kw">fn </span>doc_count(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 {
         <span class="self">self</span>.doc_count
     }
 }

 <span class="doccomment">/// This is the range entry for a bucket, which contains a key, count, and optionally
 /// sub_aggregations.
 ///
 /// # JSON Format
 /// ```json
 /// {
 ///   ...
 ///     &quot;my_ranges&quot;: {
 ///       &quot;buckets&quot;: [
 ///         {
 ///           &quot;key&quot;: &quot;*-10&quot;,
 ///           &quot;to&quot;: 10,
 ///           &quot;doc_count&quot;: 5
 ///         },
 ///         {
 ///           &quot;key&quot;: &quot;10-20&quot;,
 ///           &quot;from&quot;: 10,
 ///           &quot;to&quot;: 20,
 ///           &quot;doc_count&quot;: 2
 ///         },
 ///         {
 ///           &quot;key&quot;: &quot;20-*&quot;,
 ///           &quot;from&quot;: 20,
 ///           &quot;doc_count&quot;: 3
 ///         }
 ///       ]
 ///    }
 ///    ...
 /// }
 /// ```
 </span><span class="attribute">#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 </span><span class="kw">pub struct </span>RangeBucketEntry {
     <span class="doccomment">/// The identifier of the bucket.
     </span><span class="kw">pub </span>key: Key,
     <span class="doccomment">/// Number of documents in the bucket.
     </span><span class="kw">pub </span>doc_count: u64,
     <span class="attribute">#[serde(flatten)]
     </span><span class="doccomment">/// sub-aggregations in this bucket.
     </span><span class="kw">pub </span>sub_aggregation: AggregationResults,
     <span class="doccomment">/// The from range of the bucket. Equals `f64::MIN` when `None`.
     </span><span class="attribute">#[serde(skip_serializing_if = <span class="string">&quot;Option::is_none&quot;</span>)]
     </span><span class="kw">pub </span>from: <span class="prelude-ty">Option</span>&lt;f64&gt;,
     <span class="doccomment">/// The to range of the bucket. Equals `f64::MAX` when `None`.
     </span><span class="attribute">#[serde(skip_serializing_if = <span class="string">&quot;Option::is_none&quot;</span>)]
     </span><span class="kw">pub </span>to: <span class="prelude-ty">Option</span>&lt;f64&gt;,
     <span class="doccomment">/// The optional string representation for the `from` range.
     </span><span class="attribute">#[serde(skip_serializing_if = <span class="string">&quot;Option::is_none&quot;</span>)]
     </span><span class="kw">pub </span>from_as_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
     <span class="doccomment">/// The optional string representation for the `to` range.
     </span><span class="attribute">#[serde(skip_serializing_if = <span class="string">&quot;Option::is_none&quot;</span>)]
     </span><span class="kw">pub </span>to_as_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
 }
 </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>