Struct Items

pub struct Items {
    pub limit: Option<u64>,
    pub bbox: Option<Bbox>,
    pub datetime: Option<String>,
    pub fields: Option<Fields>,
    pub sortby: Vec<Sortby>,
    pub filter_crs: Option<String>,
    pub filter: Option<Filter>,
    pub query: Option<Map<String, Value>>,
    pub additional_fields: Map<String, Value>,
}

Parameters for the items endpoint from STAC API - Features.

Fields

limit: Option<u64>

The maximum number of results to return (page size).

bbox: Option<Bbox>

Requested bounding box.

datetime: Option<String>

Single date+time, or a range (‘/’ separator), formatted to RFC 3339, section 5.6.

Use double dots .. for open date ranges.

fields: Option<Fields>

Include/exclude fields from item collections.

sortby: Vec<Sortby>

Fields by which to sort results.

filter_crs: Option<String>

Recommended to not be passed, but server must only accept http://www.opengis.net/def/crs/OGC/1.3/CRS84 as a valid value, may reject any others

filter: Option<Filter>

CQL2 filter expression.

query: Option<Map<String, Value>>

Additional filtering based on properties.

It is recommended to use the filter extension instead.

additional_fields: Map<String, Value>

Additional fields.

Implementations

impl Items

pub fn valid(self) -> Result<Items>

Runs a set of validity checks on this query and returns an error if it is invalid.

Returns the items, unchanged, if it is valid.

Examples

use stac_api::Items;

let items = Items::default().valid().unwrap();

pub fn matches(&self, item: &Item) -> Result<bool>

Returns true if this items structure matches the given item.

Examples

use stac_api::Items;
use stac::Item;

assert!(Items::default().matches(&Item::new("an-id")).unwrap());

pub fn bbox_matches(&self, item: &Item) -> Result<bool>

Returns true if this item’s geometry matches this search’s bbox.

If stac-api is not built with the geo feature, this will return an error.

Examples

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.bbox_matches(&item).unwrap());
search.bbox = Some(vec![-110.0, 40.0, -100.0, 50.0].try_into().unwrap());
assert!(!search.bbox_matches(&item).unwrap());
item.set_geometry(Geometry::new(Value::Point(vec![-105.1, 41.1])));
assert!(search.bbox_matches(&item).unwrap());

pub fn datetime_matches(&self, item: &Item) -> Result<bool>

Returns true if this item’s datetime matches this items structure.

Examples

use stac_api::Search;
use stac::Item;

let mut search = Search::new();
let mut item = Item::new("item-id");  // default datetime is now
assert!(search.datetime_matches(&item).unwrap());
search.datetime = Some("../2023-10-09T00:00:00Z".to_string());
assert!(!search.datetime_matches(&item).unwrap());
item.properties.datetime = Some("2023-10-08T00:00:00Z".parse().unwrap());
assert!(search.datetime_matches(&item).unwrap());

pub fn query_matches(&self, _: &Item) -> Result<bool>

Returns true if this item’s matches this search query.

Currently unsupported, always raises an error if query is set.

Examples

use stac_api::Search;
use stac::Item;

let mut search = Search::new();
let mut item = Item::new("item-id");
assert!(search.query_matches(&item).unwrap());
search.query = Some(Default::default());
assert!(search.query_matches(&item).is_err());

pub fn filter_matches(&self, _: &Item) -> Result<bool>

Returns true if this item matches this search’s filter.

Currently unsupported, always raises an error if filter is set.

Examples

use stac_api::Search;
use stac::Item;

let mut search = Search::new();
let mut item = Item::new("item-id");
assert!(search.filter_matches(&item).unwrap());
search.filter = Some(Default::default());
assert!(search.filter_matches(&item).is_err());

pub fn search_collection(self, collection_id: impl ToString) -> Search

Converts this items object to a search in the given collection.

Examples

use stac_api::Items;
let items = Items {
    datetime: Some("2023".to_string()),
    ..Default::default()
};
let search = items.search_collection("collection-id");
assert_eq!(search.collections, vec!["collection-id"]);

pub fn into_cql2_json(self) -> Result<Items>

Converts the filter to cql2-json, if it is set.

Trait Implementations

impl Clone for Items

fn clone(&self) -> Items

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Items

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Items

fn default() -> Items

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Items

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Fields for Items

fn fields(&self) -> &Map<String, Value>

Gets the fields value.

fn fields_mut(&mut self) -> &mut Map<String, Value>

Gets a mutable reference to the fields value.

fn field(&self, key: &str) -> Option<&Value>

Gets the value of a field.

fn set_field<S>( &mut self, key: impl ToString, value: S, ) -> Result<Option<Value>, Error>

where S: Serialize,

Sets the value of a field.

fn fields_with_prefix<D>(&self, prefix: &str) -> Result<D, Error>

where D: DeserializeOwned,

Gets values with a prefix.

fn set_fields_with_prefix<S>( &mut self, prefix: &str, value: S, ) -> Result<(), Error>

where S: Serialize,

Sets values with a prefix.

fn remove_fields_with_prefix(&mut self, prefix: &str)

Removes values with a prefix.

impl From<Items> for Search

fn from(items: Items) -> Self

Converts to this type from the input type.

impl Serialize for Items

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<GetItems> for Items

type Error = Error

The type returned in the event of a conversion error.

fn try_from(get_items: GetItems) -> Result<Items>

Performs the conversion.

impl TryFrom<Items> for GetItems

type Error = Error

The type returned in the event of a conversion error.

fn try_from(items: Items) -> Result<GetItems>

Performs the conversion.