Struct stac_api::Items

pub struct Items {
    pub limit: Option<u64>,
    pub bbox: Option<Vec<f64>>,
    pub datetime: Option<String>,
    pub fields: Option<Fields>,
    pub sortby: Option<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.

This is a lot like Search, but without intersects, ids, and collections.

Fields

limit: Option<u64>

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

bbox: Option<Vec<f64>>

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: Option<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 into_search(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.into_search("collection-id");
assert_eq!(search.collections.unwrap(), vec!["collection-id"]);

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 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.