opensearch-dsl 0.3.1

Strongly typed OpenSearch DSL
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! Collapse search results
//!
//! <https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html>

use crate::{util::*, *};

/// Internal representation for collapse
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
pub struct Collapse {
    field: String,

    #[serde(skip_serializing_if = "ShouldSkip::should_skip")]
    inner_hits: Vec<InnerHits>,

    #[serde(skip_serializing_if = "ShouldSkip::should_skip")]
    max_concurrent_group_searches: Option<u64>,
}

impl Collapse {
    /// Creates an instance of [`Collapse`]
    ///
    /// - `field` - Field you wish to collapse on
    pub fn new<T>(field: T) -> Self
    where
        T: ToString,
    {
        Self {
            field: field.to_string(),
            max_concurrent_group_searches: None,
            inner_hits: Default::default(),
        }
    }

    /// Add `inner_hits` to Collapse
    pub fn inner_hits<T>(mut self, inner_hits: T) -> Self
    where
        T: IntoIterator,
        T::Item: Into<InnerHits>,
    {
        self.inner_hits
            .extend(inner_hits.into_iter().map(Into::into));
        self
    }

    /// Add `max_concurrent_group_searches` to Collapse
    pub fn max_concurrent_group_searches(mut self, max_concurrent_group_searches: u64) -> Self {
        self.max_concurrent_group_searches = Some(max_concurrent_group_searches);
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn serialization() {
        assert_serialize(Collapse::new("field"), json!({ "field": "field" }));

        assert_serialize(
            Collapse::new("field")
                .max_concurrent_group_searches(10)
                .inner_hits([InnerHits::new()
                    .name("inner_hits")
                    .size(10)
                    .sort([FieldSort::descending("sort_field")])
                    .collapse("field_inner_collapse")]),
            json!({
                "field": "field",
                "inner_hits": [
                    {
                        "name": "inner_hits",
                        "size": 10,
                        "sort": [{"sort_field": {"order": "desc"}}],
                        "collapse": {
                            "field": "field_inner_collapse"
                        }
                    }
                ],
                "max_concurrent_group_searches": 10
            }),
        );

        assert_serialize(
            Collapse::new("field").inner_hits([
                InnerHits::new()
                    .name("inner_hits_0")
                    .size(10)
                    .sort([FieldSort::descending("sort_field")]),
                InnerHits::new()
                    .name("inner_hits_1")
                    .size(10)
                    .sort([FieldSort::descending("sort_field")]),
            ]),
            json!({
                "field": "field",
                "inner_hits": [
                    {
                        "name": "inner_hits_0",
                        "size": 10,
                        "sort": [{"sort_field": {"order": "desc"}}]
                    },
                    {
                        "name": "inner_hits_1",
                        "size": 10,
                        "sort": [{"sort_field": {"order": "desc"}}]
                    }
                ]
            }),
        );
    }
}