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
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 that intersect a bounding box.
///
/// <https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html>
#[derive(Debug, Clone, PartialEq, Serialize)]
#[serde(remote = "Self")]
pub struct GeoBoundingBoxQuery {
#[serde(skip)]
field: String,
#[serde(skip)]
bounding_box: GeoBoundingBox,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
validation_method: Option<ValidationMethod>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
boost: Option<f32>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
_name: Option<String>,
}
impl Query {
/// Creates an instance of [`GeoBoundingBoxQuery`]
///
/// - `field` - Field you wish to search.
/// - `bounding_box` - A series of vertex coordinates of a geo bounding box
pub fn geo_bounding_box<T, U>(field: T, bounding_box: U) -> GeoBoundingBoxQuery
where
T: ToString,
U: Into<GeoBoundingBox>,
{
GeoBoundingBoxQuery {
field: field.to_string(),
bounding_box: bounding_box.into(),
validation_method: None,
boost: None,
_name: None,
}
}
}
impl GeoBoundingBoxQuery {
/// 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: ValidationMethod) -> Self {
self.validation_method = Some(validation_method);
self
}
add_boost_and_name!();
}
impl ShouldSkip for GeoBoundingBoxQuery {}
serialize_with_root_key_value_pair!("geo_bounding_box": GeoBoundingBoxQuery, field, bounding_box);
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn serialization() {
assert_serialize_query(
Query::geo_bounding_box(
"pin.location",
GeoBoundingBox::WellKnownText {
wkt: "BBOX (-74.1, -71.12, 40.73, 40.01)".into(),
},
),
json!({
"geo_bounding_box": {
"pin.location": {
"wkt": "BBOX (-74.1, -71.12, 40.73, 40.01)"
}
}
}),
);
assert_serialize_query(
Query::geo_bounding_box(
"pin.location",
GeoBoundingBox::MainDiagonal {
top_left: GeoLocation::new(40.73, -74.1),
bottom_right: GeoLocation::new(40.01, -71.12),
},
)
.validation_method(ValidationMethod::Strict)
.name("test_name"),
json!({
"geo_bounding_box": {
"validation_method": "STRICT",
"_name": "test_name",
"pin.location": {
"top_left": [ -74.1, 40.73 ],
"bottom_right": [ -71.12, 40.01 ]
}
}
}),
);
assert_serialize_query(
Query::geo_bounding_box(
"pin.location",
GeoBoundingBox::Vertices {
top: 40.73,
left: -74.1,
bottom: 40.01,
right: -71.12,
},
)
.validation_method(ValidationMethod::Strict)
.name("test_name")
.boost(1),
json!({
"geo_bounding_box": {
"validation_method": "STRICT",
"_name": "test_name",
"boost": 1.0,
"pin.location": {
"top": 40.73,
"left": -74.1,
"bottom": 40.01,
"right": -71.12
}
}
}),
)
}
}