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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use crate::search::*;
use crate::util::*;
use serde::Serialize;

/// Matches [geo_point](https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-point.html)
/// and [geo_shape](https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html)
/// values within a given distance of a geopoint.
///
/// <https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html>
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct GeoDistanceQuery {
    #[serde(rename = "geo_distance")]
    inner: Inner,
}

#[derive(Debug, Clone, PartialEq, Serialize)]
struct Inner {
    #[serde(flatten)]
    pair: KeyValuePair<String, GeoPoint>,

    distance: Distance,

    #[serde(skip_serializing_if = "ShouldSkip::should_skip")]
    distance_type: Option<DistanceType>,

    #[serde(skip_serializing_if = "ShouldSkip::should_skip")]
    validation_method: Option<ValidationMethod>,

    #[serde(skip_serializing_if = "ShouldSkip::should_skip")]
    boost: Option<Boost>,

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

impl Query {
    /// Creates an instance of [`GeoDistanceQuery`]
    ///
    /// - `field` - Field you wish to search
    /// - `origin` - GeoPoint to measure distance to
    /// - `distance` - Distance threshold
    pub fn geo_distance(
        field: impl Into<String>,
        origin: impl Into<GeoPoint>,
        distance: impl Into<Distance>,
    ) -> GeoDistanceQuery {
        GeoDistanceQuery {
            inner: Inner {
                pair: KeyValuePair::new(field.into(), origin.into()),
                distance: distance.into(),
                distance_type: None,
                validation_method: None,
                boost: None,
                _name: None,
            },
        }
    }
}

impl GeoDistanceQuery {
    /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude, set to
    /// `COERCE` to also try to infer correct latitude or longitude. (default is `STRICT`).
    pub fn validation_method(mut self, validation_method: impl Into<ValidationMethod>) -> Self {
        self.inner.validation_method = Some(validation_method.into());
        self
    }

    /// How to compute the distance. Can either be `Arc` (default),
    /// or `Plane` (faster, but inaccurate on long distances and close to the poles).
    pub fn distance_type(mut self, distance_type: impl Into<DistanceType>) -> Self {
        self.inner.distance_type = Some(distance_type.into());
        self
    }

    add_boost_and_name!();
}

impl ShouldSkip for GeoDistanceQuery {
    fn should_skip(&self) -> bool {
        self.inner.pair.key.should_skip()
    }
}

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

    test_serialization! {
        geo_distance_coordinates(
            Query::geo_distance(
                "pin.location",
                GeoPoint::Coordinates {
                    latitude: 40.12,
                    longitude: -71.34,
                },
                Distance::Kilometers(300)
            ),
            json!({
                "geo_distance": {
                    "distance": "300km",
                    "pin.location": [-71.34, 40.12],
                }
            })
        );

        geo_distance_geohash(
            Query::geo_distance(
                "pin.location",
                GeoPoint::Geohash("drm3btev3e86".into()),
                Distance::Miles(200)
            ),
            json!({
                "geo_distance": {
                    "distance": "200mi",
                    "pin.location": "drm3btev3e86",
                }
            })
        );

        geo_distance_name_and_boost(
            Query::geo_distance(
                "pin.location",
                GeoPoint::Coordinates {
                    latitude: 40.12,
                    longitude: -71.34,
                },
                Distance::Kilometers(300)
            ).distance_type(DistanceType::Plane)
            .validation_method(ValidationMethod::Strict)
            .name("test_name")
            .boost(1),
            json!({
                "geo_distance": {
                    "distance": "300km",
                    "distance_type": "plane",
                    "pin.location": [-71.34, 40.12],
                    "validation_method": "STRICT",
                    "_name": "test_name",
                    "boost": 1,
                }
            })
        );
    }
}