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

use serde::Serialize;

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

/// Returns matches which are enclosed inside another span query. The span
/// within query maps to Lucene `SpanWithinQuery`.
///
/// The `big` and `little` clauses can be any span type query. Matching spans
/// from `little` that are enclosed within `big` are returned.
///
/// <https://www.elastic.co/guide/en/opensearch/reference/current/query-dsl-span-within-query.html>
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(remote = "Self")]
pub struct SpanWithinQuery {
    big: Box<SpanQuery>,
    little: Box<SpanQuery>,
}

impl Query {
    /// Creates an instance of [`SpanWithinQuery`]
    pub fn span_within<T, U>(little: T, big: U) -> SpanWithinQuery
    where
        T: Into<SpanQuery>,
        U: Into<SpanQuery>,
    {
        SpanWithinQuery {
            little: Box::new(little.into()),
            big: Box::new(big.into()),
        }
    }
}

impl ShouldSkip for SpanWithinQuery {}

serialize_with_root!("span_within": SpanWithinQuery);
deserialize_with_root!("span_within": SpanWithinQuery);

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

    #[test]
    fn serialization() {
        assert_serialize_query(
            Query::span_within(
                Query::span_term("little", 1234),
                Query::span_term("big", 4321),
            ),
            json!({
                "span_within": {
                    "little": {
                        "span_term": {
                            "little": {
                                "value": 1234
                            }
                        }
                    },
                    "big": {
                        "span_term": {
                            "big": {
                                "value": 4321
                            }
                        }
                    }
                }
            }),
        );

        assert_serialize_query(
            Query::span_within(
                Query::span_term("little", 1234),
                Query::span_term("big", 4321),
            ),
            json!({
                "span_within": {
                    "little": {
                        "span_term": {
                            "little": {
                                "value": 1234
                            }
                        }
                    },
                    "big": {
                        "span_term": {
                            "big": {
                                "value": 4321
                            }
                        }
                    }
                }
            }),
        );
    }
}