Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / tantivy / aggregation / bucket / mod.rs.html
blob: a537b382f05ddb588dd7463fd71047f53f131b95 [file] [log] [blame]
<!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/bucket/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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>
</pre><pre class="rust"><code><span class="doccomment">//! Module for all bucket aggregations.
//!
//! BucketAggregations create buckets of documents
//! [`BucketAggregation`](super::agg_req::BucketAggregation).
//!
//! Results of final buckets are [`BucketResult`](super::agg_result::BucketResult).
//! Results of intermediate buckets are
//! [`IntermediateBucketResult`](super::intermediate_agg_result::IntermediateBucketResult)
</span><span class="kw">mod </span>histogram;
<span class="kw">mod </span>range;
<span class="kw">mod </span>term_agg;
<span class="kw">use </span>std::collections::HashMap;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>histogram::SegmentHistogramCollector;
<span class="kw">pub use </span>histogram::<span class="kw-2">*</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>range::SegmentRangeCollector;
<span class="kw">pub use </span>range::<span class="kw-2">*</span>;
<span class="kw">use </span>serde::{de, Deserialize, Deserializer, Serialize, Serializer};
<span class="kw">pub use </span>term_agg::<span class="kw-2">*</span>;
<span class="doccomment">/// Order for buckets in a bucket aggregation.
</span><span class="attribute">#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
</span><span class="kw">pub enum </span>Order {
<span class="doccomment">/// Asc order
</span><span class="attribute">#[serde(rename = <span class="string">&quot;asc&quot;</span>)]
</span>Asc,
<span class="doccomment">/// Desc order
</span><span class="attribute">#[serde(rename = <span class="string">&quot;desc&quot;</span>)]
</span>Desc,
}
<span class="kw">impl </span>Default <span class="kw">for </span>Order {
<span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
Order::Desc
}
}
<span class="attribute">#[derive(Clone, Debug, PartialEq)]
</span><span class="doccomment">/// Order property by which to apply the order
</span><span class="kw">pub enum </span>OrderTarget {
<span class="doccomment">/// The key of the bucket
</span>Key,
<span class="doccomment">/// The doc count of the bucket
</span>Count,
<span class="doccomment">/// Order by value of the sub aggregation metric with identified by given `String`.
///
/// Only single value metrics are supported currently
</span>SubAggregation(String),
}
<span class="kw">impl </span>Default <span class="kw">for </span>OrderTarget {
<span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
OrderTarget::Count
}
}
<span class="kw">impl </span>From&lt;<span class="kw-2">&amp;</span>str&gt; <span class="kw">for </span>OrderTarget {
<span class="kw">fn </span>from(val: <span class="kw-2">&amp;</span>str) -&gt; <span class="self">Self </span>{
<span class="kw">match </span>val {
<span class="string">&quot;_key&quot; </span>=&gt; OrderTarget::Key,
<span class="string">&quot;_count&quot; </span>=&gt; OrderTarget::Count,
<span class="kw">_ </span>=&gt; OrderTarget::SubAggregation(val.to_string()),
}
}
}
<span class="kw">impl </span>ToString <span class="kw">for </span>OrderTarget {
<span class="kw">fn </span>to_string(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; String {
<span class="kw">match </span><span class="self">self </span>{
OrderTarget::Key =&gt; <span class="string">&quot;_key&quot;</span>.to_string(),
OrderTarget::Count =&gt; <span class="string">&quot;_count&quot;</span>.to_string(),
OrderTarget::SubAggregation(agg) =&gt; agg.to_string(),
}
}
}
<span class="doccomment">/// Set the order. target is either &quot;_count&quot;, &quot;_key&quot;, or the name of
/// a metric sub_aggregation.
///
/// De/Serializes to elasticsearch compatible JSON.
///
/// Examples in JSON format:
/// { &quot;_count&quot;: &quot;asc&quot; }
/// { &quot;_key&quot;: &quot;asc&quot; }
/// { &quot;average_price&quot;: &quot;asc&quot; }
</span><span class="attribute">#[derive(Clone, Default, Debug, PartialEq)]
</span><span class="kw">pub struct </span>CustomOrder {
<span class="doccomment">/// The target property by which to sort by
</span><span class="kw">pub </span>target: OrderTarget,
<span class="doccomment">/// The order asc or desc
</span><span class="kw">pub </span>order: Order,
}
<span class="kw">impl </span>Serialize <span class="kw">for </span>CustomOrder {
<span class="kw">fn </span>serialize&lt;S&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt;
<span class="kw">where </span>S: Serializer {
<span class="kw">let </span>map: HashMap&lt;String, Order&gt; =
std::iter::once((<span class="self">self</span>.target.to_string(), <span class="self">self</span>.order)).collect();
map.serialize(serializer)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;de</span>&gt; Deserialize&lt;<span class="lifetime">&#39;de</span>&gt; <span class="kw">for </span>CustomOrder {
<span class="kw">fn </span>deserialize&lt;D&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;CustomOrder, D::Error&gt;
<span class="kw">where </span>D: Deserializer&lt;<span class="lifetime">&#39;de</span>&gt; {
HashMap::&lt;String, Order&gt;::deserialize(deserializer).and_then(|map| {
<span class="kw">if let </span><span class="prelude-val">Some</span>((key, value)) = map.into_iter().next() {
<span class="prelude-val">Ok</span>(CustomOrder {
target: key.as_str().into(),
order: value,
})
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(de::Error::custom(
<span class="string">&quot;unexpected empty map in order&quot;</span>.to_string(),
))
}
})
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>custom_order_serde_test() {
<span class="kw">let </span>order = CustomOrder {
target: OrderTarget::Key,
order: Order::Desc,
};
<span class="kw">let </span>order_str = serde_json::to_string(<span class="kw-2">&amp;</span>order).unwrap();
<span class="macro">assert_eq!</span>(order_str, <span class="string">&quot;{\&quot;_key\&quot;:\&quot;desc\&quot;}&quot;</span>);
<span class="kw">let </span>order_deser = serde_json::from_str(<span class="kw-2">&amp;</span>order_str).unwrap();
<span class="macro">assert_eq!</span>(order, order_deser);
<span class="kw">let </span>order_deser: serde_json::Result&lt;CustomOrder&gt; = serde_json::from_str(<span class="string">&quot;{}&quot;</span>);
<span class="macro">assert!</span>(order_deser.is_err());
<span class="kw">let </span>order_deser: serde_json::Result&lt;CustomOrder&gt; = serde_json::from_str(<span class="string">&quot;[]&quot;</span>);
<span class="macro">assert!</span>(order_deser.is_err());
}
</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>