| <!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="Histogram is a bucket aggregation, where buckets are created dynamically for given `interval`. Each document value is rounded down to its bucket."><meta name="keywords" content="rust, rustlang, rust-lang, HistogramAggregation"><title>HistogramAggregation in tantivy::aggregation::bucket - 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="sidebar-items.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 struct"><!--[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="#">HistogramAggregation</a></h2><div class="sidebar-elems"><section><h3><a href="#fields">Fields</a></h3><ul class="block"><li><a href="#structfield.extended_bounds">extended_bounds</a></li><li><a href="#structfield.field">field</a></li><li><a href="#structfield.hard_bounds">hard_bounds</a></li><li><a href="#structfield.interval">interval</a></li><li><a href="#structfield.keyed">keyed</a></li><li><a href="#structfield.min_doc_count">min_doc_count</a></li><li><a href="#structfield.offset">offset</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.min_doc_count">min_doc_count</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-HistogramAggregation">Clone</a></li><li><a href="#impl-Debug-for-HistogramAggregation">Debug</a></li><li><a href="#impl-Default-for-HistogramAggregation">Default</a></li><li><a href="#impl-Deserialize%3C%27de%3E-for-HistogramAggregation">Deserialize<'de></a></li><li><a href="#impl-PartialEq%3CHistogramAggregation%3E-for-HistogramAggregation">PartialEq<HistogramAggregation></a></li><li><a href="#impl-Serialize-for-HistogramAggregation">Serialize</a></li><li><a href="#impl-StructuralPartialEq-for-HistogramAggregation">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-HistogramAggregation">RefUnwindSafe</a></li><li><a href="#impl-Send-for-HistogramAggregation">Send</a></li><li><a href="#impl-Sync-for-HistogramAggregation">Sync</a></li><li><a href="#impl-Unpin-for-HistogramAggregation">Unpin</a></li><li><a href="#impl-UnwindSafe-for-HistogramAggregation">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-HistogramAggregation">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-HistogramAggregation">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-HistogramAggregation">BorrowMut<T></a></li><li><a href="#impl-DeserializeOwned-for-HistogramAggregation">DeserializeOwned</a></li><li><a href="#impl-Downcast-for-HistogramAggregation">Downcast</a></li><li><a href="#impl-DowncastSync-for-HistogramAggregation">DowncastSync</a></li><li><a href="#impl-From%3CT%3E-for-HistogramAggregation">From<T></a></li><li><a href="#impl-Fruit-for-HistogramAggregation">Fruit</a></li><li><a href="#impl-Into%3CU%3E-for-HistogramAggregation">Into<U></a></li><li><a href="#impl-Pointable-for-HistogramAggregation">Pointable</a></li><li><a href="#impl-ToOwned-for-HistogramAggregation">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-HistogramAggregation">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-HistogramAggregation">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-HistogramAggregation">VZip<V></a></li></ul></section><h2><a href="index.html">In tantivy::aggregation::bucket</a></h2></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">Struct <a href="../../index.html">tantivy</a>::<wbr><a href="../index.html">aggregation</a>::<wbr><a href="index.html">bucket</a>::<wbr><a class="struct" href="#">HistogramAggregation</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/bucket/histogram/histogram.rs.html#67-121">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct HistogramAggregation { |
| pub field: String, |
| pub interval: f64, |
| pub offset: Option<f64>, |
| pub min_doc_count: Option<u64>, |
| pub hard_bounds: Option<<a class="struct" href="struct.HistogramBounds.html" title="struct tantivy::aggregation::bucket::HistogramBounds">HistogramBounds</a>>, |
| pub extended_bounds: Option<<a class="struct" href="struct.HistogramBounds.html" title="struct tantivy::aggregation::bucket::HistogramBounds">HistogramBounds</a>>, |
| pub keyed: bool, |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Histogram is a bucket aggregation, where buckets are created dynamically for given <code>interval</code>. |
| Each document value is rounded down to its bucket.</p> |
| <p>E.g. if we have a price 18 and an interval of 5, the document will fall into the bucket with |
| the key 15. The formula used for this is: |
| <code>((val - offset) / interval).floor() * interval + offset</code></p> |
| <p>For this calculation all fastfield values are converted to f64.</p> |
| <h2 id="returned-buckets"><a href="#returned-buckets">Returned Buckets</a></h2> |
| <p>By default buckets are returned between the min and max value of the documents, including empty |
| buckets. |
| Setting min_doc_count to != 0 will filter empty buckets.</p> |
| <p>The value range of the buckets can bet extended via |
| <a href="struct.HistogramAggregation.html#structfield.extended_bounds">extended_bounds</a> or limit the range via |
| <a href="struct.HistogramAggregation.html#structfield.hard_bounds">hard_bounds</a>.</p> |
| <h2 id="result"><a href="#result">Result</a></h2> |
| <p>Result type is <a href="../agg_result/enum.BucketResult.html"><code>BucketResult</code></a> with |
| <a href="../agg_result/struct.BucketEntry.html"><code>BucketEntry</code></a> on the |
| <code>AggregationCollector</code>.</p> |
| <p>Result type is |
| <a href="../intermediate_agg_result/enum.IntermediateBucketResult.html"><code>IntermediateBucketResult</code></a> with |
| <a href="../intermediate_agg_result/struct.IntermediateHistogramBucketEntry.html"><code>IntermediateHistogramBucketEntry</code></a> on the |
| <code>DistributedAggregationCollector</code>.</p> |
| <h2 id="limitationscompatibility"><a href="#limitationscompatibility">Limitations/Compatibility</a></h2><h2 id="json-format"><a href="#json-format">JSON Format</a></h2><div class="example-wrap"><pre class="language-json"><code>{ |
| "prices": { |
| "histogram": { |
| "field": "price", |
| "interval": 10 |
| } |
| } |
| }</code></pre></div> |
| <p>Response |
| See <a href="../agg_result/struct.BucketEntry.html"><code>BucketEntry</code></a></p> |
| </div></details><h2 id="fields" class="fields small-section-header">Fields<a href="#fields" class="anchor"></a></h2><span id="structfield.field" class="structfield small-section-header"><a href="#structfield.field" class="anchor field"></a><code>field: String</code></span><div class="docblock"><p>The field to aggregate on.</p> |
| </div><span id="structfield.interval" class="structfield small-section-header"><a href="#structfield.interval" class="anchor field"></a><code>interval: f64</code></span><div class="docblock"><p>The interval to chunk your data range. Each bucket spans a value range of [0..interval). |
| Must be a positive value.</p> |
| </div><span id="structfield.offset" class="structfield small-section-header"><a href="#structfield.offset" class="anchor field"></a><code>offset: Option<f64></code></span><div class="docblock"><p>Intervals implicitly defines an absolute grid of buckets <code>[interval * k, interval * (k + 1))</code>.</p> |
| <p>Offset makes it possible to shift this grid into |
| <code>[offset + interval * k, offset + interval * (k + 1))</code>. Offset has to be in the range [0, |
| interval).</p> |
| <p>As an example, if there are two documents with value 9 and 12 and interval 10.0, they would |
| fall into the buckets with the key 0 and 10. |
| With offset 5 and interval 10, they would both fall into the bucket with they key 5 and the |
| range [5..15)</p> |
| </div><span id="structfield.min_doc_count" class="structfield small-section-header"><a href="#structfield.min_doc_count" class="anchor field"></a><code>min_doc_count: Option<u64></code></span><div class="docblock"><p>The minimum number of documents in a bucket to be returned. Defaults to 0.</p> |
| </div><span id="structfield.hard_bounds" class="structfield small-section-header"><a href="#structfield.hard_bounds" class="anchor field"></a><code>hard_bounds: Option<<a class="struct" href="struct.HistogramBounds.html" title="struct tantivy::aggregation::bucket::HistogramBounds">HistogramBounds</a>></code></span><div class="docblock"><p>Limits the data range to <code>[min, max]</code> closed interval.</p> |
| <p>This can be used to filter values if they are not in the data range.</p> |
| <p>hard_bounds only limits the buckets, to force a range set both extended_bounds and |
| hard_bounds to the same range.</p> |
| <h4 id="example"><a href="#example">Example</a></h4><div class="example-wrap"><pre class="language-json"><code>{ |
| "prices": { |
| "histogram": { |
| "field": "price", |
| "interval": 10, |
| "hard_bounds": { |
| "min": 0, |
| "max": 100 |
| } |
| } |
| } |
| }</code></pre></div></div><span id="structfield.extended_bounds" class="structfield small-section-header"><a href="#structfield.extended_bounds" class="anchor field"></a><code>extended_bounds: Option<<a class="struct" href="struct.HistogramBounds.html" title="struct tantivy::aggregation::bucket::HistogramBounds">HistogramBounds</a>></code></span><div class="docblock"><p>Can be set to extend your bounds. The range of the buckets is by default defined by the |
| data range of the values of the documents. As the name suggests, this can only be used to |
| extend the value range. If the bounds for min or max are not extending the range, the value |
| has no effect on the returned buckets.</p> |
| <p>Cannot be set in conjunction with min_doc_count > 0, since the empty buckets from extended |
| bounds would not be returned.</p> |
| </div><span id="structfield.keyed" class="structfield small-section-header"><a href="#structfield.keyed" class="anchor field"></a><code>keyed: bool</code></span><div class="docblock"><p>Whether to return the buckets as a hash map</p> |
| </div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#123-155">source</a><a href="#impl-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.min_doc_count" class="method has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#152-154">source</a><h4 class="code-header">pub fn <a href="#method.min_doc_count" class="fnname">min_doc_count</a>(&self) -> u64</h4></section></summary><div class="docblock"><p>Returns the minimum number of documents required for a bucket to be returned.</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#impl-Clone-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&self) -> <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#impl-Debug-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#impl-Default-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl Default for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a class="fnname">default</a>() -> <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Deserialize%3C%27de%3E-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#impl-Deserialize%3C%27de%3E-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<'de> <a class="trait" href="../../../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a><'de> for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deserialize" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#method.deserialize" class="anchor"></a><h4 class="code-header">fn <a href="../../../serde/de/trait.Deserialize.html#tymethod.deserialize" class="fnname">deserialize</a><__D>(__deserializer: __D) -> Result<Self, __D::<a class="associatedtype" href="../../../serde/de/trait.Deserializer.html#associatedtype.Error" title="type serde::de::Deserializer::Error">Error</a>><span class="where fmt-newline">where<br> __D: <a class="trait" href="../../../serde/de/trait.Deserializer.html" title="trait serde::de::Deserializer">Deserializer</a><'de>,</span></h4></section></summary><div class='docblock'>Deserialize this value from the given Serde deserializer. <a href="../../../serde/de/trait.Deserialize.html#tymethod.deserialize">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CHistogramAggregation%3E-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#impl-PartialEq%3CHistogramAggregation%3E-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl PartialEq<<a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a>> for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a class="fnname">eq</a>(&self, other: &<a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a>) -> bool</h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used |
| by <code>==</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.ne" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ne</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always |
| sufficient, and should not be overridden without very good reason. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Serialize-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#impl-Serialize-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.serialize" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#method.serialize" class="anchor"></a><h4 class="code-header">fn <a href="../../../serde/ser/trait.Serialize.html#tymethod.serialize" class="fnname">serialize</a><__S>(&self, __serializer: __S) -> Result<__S::<a class="associatedtype" href="../../../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, __S::<a class="associatedtype" href="../../../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><span class="where fmt-newline">where<br> __S: <a class="trait" href="../../../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</span></h4></section></summary><div class='docblock'>Serialize this value into the given Serde serializer. <a href="../../../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></div></details></div></details><section id="impl-StructuralPartialEq-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/aggregation/bucket/histogram/histogram.rs.html#66">source</a><a href="#impl-StructuralPartialEq-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl StructuralPartialEq for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section><section id="impl-Send-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-Send-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section><section id="impl-Sync-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-Sync-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section><section id="impl-Unpin-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-Unpin-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section><section id="impl-UnwindSafe-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-UnwindSafe-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.HistogramAggregation.html" title="struct tantivy::aggregation::bucket::HistogramAggregation">HistogramAggregation</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-Any-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Downcast-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/downcast_rs/lib.rs.html#190">source</a><a href="#impl-Downcast-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../../downcast_rs/trait.Downcast.html" title="trait downcast_rs::Downcast">Downcast</a> for T<span class="where fmt-newline">where<br> T: Any,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/downcast_rs/lib.rs.html#191">source</a><a href="#method.into_any" class="anchor"></a><h4 class="code-header">fn <a href="../../../downcast_rs/trait.Downcast.html#tymethod.into_any" class="fnname">into_any</a>(self: Box<T, Global>) -> Box<dyn Any + 'static, Global></h4></section></summary><div class='docblock'>Convert <code>Box<dyn Trait></code> (where <code>Trait: Downcast</code>) to <code>Box<dyn Any></code>. <code>Box<dyn Any></code> can |
| then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="../../../downcast_rs/trait.Downcast.html#tymethod.into_any">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any_rc" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/downcast_rs/lib.rs.html#192">source</a><a href="#method.into_any_rc" class="anchor"></a><h4 class="code-header">fn <a href="../../../downcast_rs/trait.Downcast.html#tymethod.into_any_rc" class="fnname">into_any_rc</a>(self: Rc<T>) -> Rc<dyn Any + 'static></h4></section></summary><div class='docblock'>Convert <code>Rc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Rc<Any></code>. <code>Rc<Any></code> can then be |
| further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="../../../downcast_rs/trait.Downcast.html#tymethod.into_any_rc">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_any" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/downcast_rs/lib.rs.html#193">source</a><a href="#method.as_any" class="anchor"></a><h4 class="code-header">fn <a href="../../../downcast_rs/trait.Downcast.html#tymethod.as_any" class="fnname">as_any</a>(&self) -> &(dyn Any + 'static)</h4></section></summary><div class='docblock'>Convert <code>&Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot |
| generate <code>&Any</code>’s vtable from <code>&Trait</code>’s. <a href="../../../downcast_rs/trait.Downcast.html#tymethod.as_any">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_any_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/downcast_rs/lib.rs.html#194">source</a><a href="#method.as_any_mut" class="anchor"></a><h4 class="code-header">fn <a href="../../../downcast_rs/trait.Downcast.html#tymethod.as_any_mut" class="fnname">as_any_mut</a>(&mut self) -> &mut (dyn Any + 'static)</h4></section></summary><div class='docblock'>Convert <code>&mut Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot |
| generate <code>&mut Any</code>’s vtable from <code>&mut Trait</code>’s. <a href="../../../downcast_rs/trait.Downcast.html#tymethod.as_any_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-DowncastSync-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/downcast_rs/lib.rs.html#204">source</a><a href="#impl-DowncastSync-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../../downcast_rs/trait.DowncastSync.html" title="trait downcast_rs::DowncastSync">DowncastSync</a> for T<span class="where fmt-newline">where<br> T: Any + Send + Sync,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any_arc" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/downcast_rs/lib.rs.html#205">source</a><a href="#method.into_any_arc" class="anchor"></a><h4 class="code-header">fn <a href="../../../downcast_rs/trait.DowncastSync.html#tymethod.into_any_arc" class="fnname">into_any_arc</a>(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static></h4></section></summary><div class='docblock'>Convert <code>Arc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Arc<Any></code>. <code>Arc<Any></code> can then be |
| further <code>downcast</code> into <code>Arc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="../../../downcast_rs/trait.DowncastSync.html#tymethod.into_any_arc">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Pointable-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/crossbeam_epoch/atomic.rs.html#194">source</a><a href="#impl-Pointable-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../../crossbeam_epoch/atomic/trait.Pointable.html" title="trait crossbeam_epoch::atomic::Pointable">Pointable</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedconstant.ALIGN" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../../../src/crossbeam_epoch/atomic.rs.html#195">source</a><a href="#associatedconstant.ALIGN" class="anchor"></a><h4 class="code-header">const <a href="../../../crossbeam_epoch/atomic/trait.Pointable.html#associatedconstant.ALIGN" class="constant">ALIGN</a>: usize = mem::align_of::<T>()</h4></section></summary><div class='docblock'>The alignment of pointer.</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.Init" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Init" class="anchor"></a><h4 class="code-header">type <a href="../../../crossbeam_epoch/atomic/trait.Pointable.html#associatedtype.Init" class="associatedtype">Init</a> = T</h4></section></summary><div class='docblock'>The type for initializers.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.init" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/crossbeam_epoch/atomic.rs.html#199">source</a><a href="#method.init" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.init" class="fnname">init</a>(init: <T as <a class="trait" href="../../../crossbeam_epoch/atomic/trait.Pointable.html" title="trait crossbeam_epoch::atomic::Pointable">Pointable</a>>::<a class="associatedtype" href="../../../crossbeam_epoch/atomic/trait.Pointable.html#associatedtype.Init" title="type crossbeam_epoch::atomic::Pointable::Init">Init</a>) -> usize</h4></section></summary><div class='docblock'>Initializes a with the given initializer. <a href="../../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.init">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/crossbeam_epoch/atomic.rs.html#203">source</a><a href="#method.deref" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref" class="fnname">deref</a><'a>(ptr: usize) -> &'a T</h4></section></summary><div class='docblock'>Dereferences the given pointer. <a href="../../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/crossbeam_epoch/atomic.rs.html#207">source</a><a href="#method.deref_mut" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref_mut" class="fnname">deref_mut</a><'a>(ptr: usize) -> &'a mut T</h4></section></summary><div class='docblock'>Mutably dereferences the given pointer. <a href="../../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref_mut">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/crossbeam_epoch/atomic.rs.html#211">source</a><a href="#method.drop" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.drop" class="fnname">drop</a>(ptr: usize)</h4></section></summary><div class='docblock'>Drops the object pointed to by the given pointer. <a href="../../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.drop">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-ToOwned-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&self, target: &mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-HistogramAggregation" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/ppv_lite86/types.rs.html#221">source</a><a href="#impl-VZip%3CV%3E-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<V, T> <a class="trait" href="../../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a><V> for T<span class="where fmt-newline">where<br> V: <a class="trait" href="../../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a><T>,</span></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/ppv_lite86/types.rs.html#226">source</a><a href="#method.vzip" class="anchor"></a><h4 class="code-header">fn <a href="../../../ppv_lite86/types/trait.VZip.html#tymethod.vzip" class="fnname">vzip</a>(self) -> V</h4></section></div></details><section id="impl-DeserializeOwned-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/serde/de/mod.rs.html#604">source</a><a href="#impl-DeserializeOwned-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../../serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a> for T<span class="where fmt-newline">where<br> T: for<'de> <a class="trait" href="../../../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a><'de>,</span></h3></section><section id="impl-Fruit-for-HistogramAggregation" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tantivy/collector/mod.rs.html#122">source</a><a href="#impl-Fruit-for-HistogramAggregation" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../collector/trait.Fruit.html" title="trait tantivy::collector::Fruit">Fruit</a> for T<span class="where fmt-newline">where<br> T: Send + <a class="trait" href="../../../downcast_rs/trait.Downcast.html" title="trait downcast_rs::Downcast">Downcast</a>,</span></h3></section></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> |
