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

use serde::Serialize;

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

/// Matches spans which are near one another. One can specify _slop_, the
/// maximum number of intervening unmatched positions, as well as whether
/// matches are required to be in-order. The span near query maps to Lucene
/// `SpanNearQuery`. <br/> The `clauses` element is a list of one or more other
/// span type queries and the `slop` controls the maximum number of intervening
/// unmatched positions permitted.
///
/// <https://www.elastic.co/guide/en/opensearch/reference/current/query-dsl-span-near-query.html>
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(remote = "Self")]
pub struct SpanNearQuery {
    clauses: Vec<SpanQuery>,

    #[serde(default, skip_serializing_if = "ShouldSkip::should_skip")]
    in_order: Option<bool>,

    #[serde(default, skip_serializing_if = "ShouldSkip::should_skip")]
    slop: Option<i32>,
}

impl ShouldSkip for SpanNearQuery {
    fn should_skip(&self) -> bool {
        self.clauses.should_skip()
    }
}

impl Query {
    /// Creates an instance of [`SpanNearQuery`]
    pub fn span_near<T>(clauses: T) -> SpanNearQuery
    where
        T: IntoIterator,
        T::Item: Into<SpanQuery>,
    {
        SpanNearQuery {
            clauses: clauses.into_iter().map(Into::into).collect(),
            in_order: None,
            slop: None,
        }
    }
}

impl SpanNearQuery {
    /// Controls whether span matches are required to be in-order.
    pub fn in_order(mut self, in_order: bool) -> Self {
        self.in_order = Some(in_order);
        self
    }

    /// The slop parameter allows you to specify the number of positions by which
    /// the terms in the query can be transposed to match a document. A slop
    /// value of 0 (default) means that the terms must appear in the exact order
    /// specified in the query.
    pub fn slop(mut self, slop: i32) -> Self {
        self.slop = Some(slop);
        self
    }
}

serialize_with_root!("span_near": SpanNearQuery);
deserialize_with_root!("span_near": SpanNearQuery);

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

    #[test]
    fn serialization() {
        assert_serialize_query(
            Query::span_near([Query::span_term("test", 1234)]),
            json!({
                "span_near": {
                    "clauses": [
                        {
                            "span_term": {
                                "test": {
                                    "value": 1234
                                }
                            }
                        }
                    ]
                }
            }),
        );

        assert_serialize_query(
            Query::span_near([Query::span_term("test", 1234)])
                .in_order(true)
                .slop(4321),
            json!({
                "span_near": {
                    "clauses": [
                        {
                            "span_term": {
                                "test": {
                                    "value": 1234
                                }
                            }
                        }
                    ],
                    "in_order": true,
                    "slop": 4321
                }
            }),
        );
    }
}