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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
use std::ops::{Deref, DerefMut};
use crate::{Error, GetItems, Items, Result};
use geojson::Geometry;
use serde::{Deserialize, Serialize};
use serde_json::{Map, Value};
use stac::Item;
/// The core parameters for STAC search are defined by OAFeat, and STAC adds a few parameters for convenience.
#[derive(Clone, Default, Debug, Serialize, Deserialize)]
pub struct Search {
/// Many fields are shared with [Items], so we re-use that structure.
#[serde(flatten)]
pub items: Items,
/// Searches items by performing intersection between their geometry and provided GeoJSON geometry.
///
/// All GeoJSON geometry types must be supported.
#[serde(skip_serializing_if = "Option::is_none")]
pub intersects: Option<Geometry>,
/// Array of Item ids to return.
#[serde(skip_serializing_if = "Option::is_none")]
pub ids: Option<Vec<String>>,
/// Array of one or more Collection IDs that each matching Item must be in.
#[serde(skip_serializing_if = "Option::is_none")]
pub collections: Option<Vec<String>>,
}
/// GET parameters for the item search endpoint.
#[derive(Clone, Default, Debug, Serialize, Deserialize)]
pub struct GetSearch {
/// Many fields are shared with [Items], so we re-use that structure.
#[serde(flatten)]
pub items: GetItems,
/// Searches items by performing intersection between their geometry and provided GeoJSON geometry.
///
/// All GeoJSON geometry types must be supported.
#[serde(skip_serializing_if = "Option::is_none")]
pub intersects: Option<String>,
/// Comma-delimited list of Item ids to return.
#[serde(skip_serializing_if = "Option::is_none")]
pub ids: Option<String>,
/// Comma-delimited list of one or more Collection IDs that each matching Item must be in.
#[serde(skip_serializing_if = "Option::is_none")]
pub collections: Option<String>,
}
impl Search {
/// Creates a new, empty search.
///
/// # Examples
///
/// ```
/// use stac_api::Search;
///
/// let search = Search::new();
/// ```
pub fn new() -> Search {
Search::default()
}
/// Sets the ids field of this search.
///
/// # Examples
///
/// ```
/// use stac_api::Search;
/// let search = Search::new().ids(vec!["an-id".to_string()]);
/// ```
pub fn ids(mut self, ids: impl Into<Option<Vec<String>>>) -> Search {
self.ids = ids.into();
self
}
/// Returns an error if this search is invalid, e.g. if both bbox and intersects are specified.
///
/// Returns the search unchanged if it is valid.
///
/// # Examples
///
/// ```
/// use stac_api::Search;
/// use geojson::{Geometry, Value};
///
/// let mut search = Search::default();
/// search.items.bbox = Some(vec![-180.0, -90.0, 180.0, 80.0].try_into().unwrap());
/// search = search.valid().unwrap();
/// search.intersects = Some(Geometry::new(Value::Point(vec![0.0, 0.0])));
/// search.valid().unwrap_err();
/// ```
pub fn valid(mut self) -> Result<Search> {
self.items = self.items.valid()?;
if self.items.bbox.is_some() & self.intersects.is_some() {
Err(Error::SearchHasBboxAndIntersects(self.clone()))
} else {
Ok(self)
}
}
/// Returns true if this item matches this search.
///
/// # Examples
///
/// ```
/// use stac::Item;
/// use stac_api::Search;
///
/// let item = Item::new("an-id");
/// assert!(Search::new().matches(&item).unwrap());
/// assert!(!Search::new().ids(vec!["not-the-id".to_string()]).matches(&item).unwrap());
/// ```
pub fn matches(&self, item: &Item) -> Result<bool> {
Ok(self.collection_matches(item)
& self.id_matches(item)
& self.intersects_matches(item)?
& self.items.matches(item)?)
}
/// Returns true if this item's collection matches this search.
///
/// # Examples
///
/// ```
/// use stac_api::Search;
/// use stac::Item;
///
/// let mut search = Search::new();
/// let mut item = Item::new("item-id");
/// assert!(search.collection_matches(&item));
/// search.collections = Some(vec!["collection-id".to_string()]);
/// assert!(!search.collection_matches(&item));
/// item.collection = Some("collection-id".to_string());
/// assert!(search.collection_matches(&item));
/// item.collection = Some("another-collection-id".to_string());
/// assert!(!search.collection_matches(&item));
/// ```
pub fn collection_matches(&self, item: &Item) -> bool {
if let Some(collections) = self.collections.as_ref() {
if let Some(collection) = item.collection.as_ref() {
collections.contains(collection)
} else {
false
}
} else {
true
}
}
/// Returns true if this item's id matches this search.
///
/// # Examples
///
/// ```
/// use stac_api::Search;
/// use stac::Item;
///
/// let mut search = Search::new();
/// let mut item = Item::new("item-id");
/// assert!(search.id_matches(&item));
/// search.ids = Some(vec!["item-id".to_string()]);
/// assert!(search.id_matches(&item));
/// search.ids = Some(vec!["another-id".to_string()]);
/// assert!(!search.id_matches(&item));
/// ```
pub fn id_matches(&self, item: &Item) -> bool {
if let Some(ids) = self.ids.as_ref() {
ids.contains(&item.id)
} else {
true
}
}
/// Returns true if this item's geometry matches this search's intersects.
///
/// # Examples
///
/// ```
/// # #[cfg(feature = "geo")]
/// # {
/// use stac_api::Search;
/// use stac::Item;
/// use geojson::{Geometry, Value};
///
/// let mut search = Search::new();
/// let mut item = Item::new("item-id");
/// assert!(search.intersects_matches(&item).unwrap());
/// search.intersects = Some(Geometry::new(Value::Point(vec![-105.1, 41.1])));
/// assert!(!search.intersects_matches(&item).unwrap());
/// item.set_geometry(Geometry::new(Value::Point(vec![-105.1, 41.1])));
/// assert!(search.intersects_matches(&item).unwrap());
/// # }
/// ```
#[allow(unused_variables)]
pub fn intersects_matches(&self, item: &Item) -> Result<bool> {
if let Some(intersects) = self.intersects.clone() {
#[cfg(feature = "geo")]
{
let intersects: geo::Geometry = intersects.try_into()?;
item.intersects(&intersects).map_err(Error::from)
}
#[cfg(not(feature = "geo"))]
{
Err(Error::FeatureNotEnabled("geo"))
}
} else {
Ok(true)
}
}
}
impl TryFrom<Search> for GetSearch {
type Error = Error;
fn try_from(search: Search) -> Result<GetSearch> {
let get_items: GetItems = search.items.try_into()?;
let intersects = search
.intersects
.map(|intersects| serde_json::to_string(&intersects))
.transpose()?;
let collections = search.collections.map(|collections| collections.join(","));
let ids = search.ids.map(|ids| ids.join(","));
Ok(GetSearch {
items: get_items,
intersects,
ids,
collections,
})
}
}
impl TryFrom<GetSearch> for Search {
type Error = Error;
fn try_from(get_search: GetSearch) -> Result<Search> {
let items: Items = get_search.items.try_into()?;
let intersects = get_search
.intersects
.map(|intersects| serde_json::from_str(&intersects))
.transpose()?;
let collections = get_search
.collections
.map(|collections| collections.split(',').map(|s| s.to_string()).collect());
let ids = get_search
.ids
.map(|ids| ids.split(',').map(|s| s.to_string()).collect());
Ok(Search {
items,
intersects,
ids,
collections,
})
}
}
impl From<Items> for Search {
fn from(items: Items) -> Self {
Search {
items,
..Default::default()
}
}
}
impl stac::Fields for Search {
fn fields(&self) -> &Map<String, Value> {
&self.items.additional_fields
}
fn fields_mut(&mut self) -> &mut Map<String, Value> {
&mut self.items.additional_fields
}
}
impl Deref for Search {
type Target = Items;
fn deref(&self) -> &Self::Target {
&self.items
}
}
impl DerefMut for Search {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.items
}
}