| <!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="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."><meta name="keywords" content="rust, rustlang, rust-lang, agg_result"><title>tantivy::aggregation::agg_result - Rust</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="../../../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 mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><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><h2></h2></nav><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><h2 class="location"><a href="#">Module agg_result</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Module <a href="../../index.html">tantivy</a>::<wbr><a href="../index.html">aggregation</a>::<wbr><a class="mod" href="#">agg_result</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../../src/tantivy/aggregation/agg_result.rs.html#1-254">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Contains the final aggregation tree. |
| This tree can be converted via the <code>into()</code> method from <code>IntermediateAggregationResults</code>. |
| 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.</p> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AggregationResults.html" title="tantivy::aggregation::agg_result::AggregationResults struct">AggregationResults</a></div><div class="item-right docblock-short">The final aggegation result.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BucketEntry.html" title="tantivy::aggregation::agg_result::BucketEntry struct">BucketEntry</a></div><div class="item-right docblock-short">This is the default entry for a bucket, which contains a key, count, and optionally |
| sub_aggregations.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RangeBucketEntry.html" title="tantivy::aggregation::agg_result::RangeBucketEntry struct">RangeBucketEntry</a></div><div class="item-right docblock-short">This is the range entry for a bucket, which contains a key, count, and optionally |
| sub_aggregations.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AggregationResult.html" title="tantivy::aggregation::agg_result::AggregationResult enum">AggregationResult</a></div><div class="item-right docblock-short">An aggregation is either a bucket or a metric.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.BucketEntries.html" title="tantivy::aggregation::agg_result::BucketEntries enum">BucketEntries</a></div><div class="item-right docblock-short">This is the wrapper of buckets entries, which can be vector or hashmap |
| depending on if it’s keyed or not.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.BucketResult.html" title="tantivy::aggregation::agg_result::BucketResult enum">BucketResult</a></div><div class="item-right docblock-short">BucketEntry holds bucket aggregation result types.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.MetricResult.html" title="tantivy::aggregation::agg_result::MetricResult enum">MetricResult</a></div><div class="item-right docblock-short">MetricResult</div></div></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> |
