Struct Item

pub struct Item {
    pub version: Version,
    pub extensions: Vec<String>,
    pub id: String,
    pub geometry: Option<Geometry>,
    pub bbox: Option<Bbox>,
    pub properties: Properties,
    pub links: Vec<Link>,
    pub assets: IndexMap<String, Asset>,
    pub collection: Option<String>,
    pub additional_fields: Map<String, Value>,
    /* private fields */
}

An Item is a GeoJSON Feature augmented with foreign members relevant to a STAC object.

These include fields that identify the time range and assets of the Item. An Item is the core object in a STAC catalog, containing the core metadata that enables any client to search or crawl online catalogs of spatial ‘assets’ (e.g., satellite imagery, derived data, DEMs).

Fields

version: Version

The STAC version the Item implements.

extensions: Vec<String>

A list of extensions the Item implements.

id: String

Provider identifier.

The ID should be unique within the Collection that contains the Item.

geometry: Option<Geometry>

Defines the full footprint of the asset represented by this item, formatted according to RFC 7946, section 3.1.

The footprint should be the default GeoJSON geometry, though additional geometries can be included. Coordinates are specified in Longitude/Latitude or Longitude/Latitude/Elevation based on WGS 84.

bbox: Option<Bbox>

Bounding Box of the asset represented by this Item, formatted according to RFC 7946, section 5.

REQUIRED if geometry is not null.

properties: Properties

A dictionary of additional metadata for the Item.

links: Vec<Link>

List of link objects to resources and related URLs.

assets: IndexMap<String, Asset>

Dictionary of asset objects that can be downloaded, each with a unique key.

collection: Option<String>

The id of the STAC Collection this Item references to.

This field is required if such a relation type is present and is not allowed otherwise. This field provides an easy way for a user to search for any Items that belong in a specified Collection. Must be a non-empty string.

additional_fields: Map<String, Value>

Additional fields not part of the Item specification.

Implementations

impl Item

pub fn new(id: impl ToString) -> Item

Creates a new Item with the given id.

The item properties’ datetime field is set to the object creation time.

Examples

use stac::Item;
let item = Item::new("an-id");
assert_eq!(item.id, "an-id");

pub fn collection(self, id: impl ToString) -> Item

Sets this item’s collection id in the builder pattern.

Examples

use stac::Item;
let item = Item::new("an-id").collection("a-collection");
assert_eq!(item.collection.unwrap(), "a-collection");

pub fn collection_link(&self) -> Option<&Link>

Returns this item’s collection link.

This is the first link with a rel=“collection”.

Examples

use stac::Item;
let item: Item = stac::read("examples/simple-item.json").unwrap();
let link = item.collection_link().unwrap();

pub fn set_geometry( &mut self, geometry: impl Into<Option<Geometry>>, ) -> Result<()>

Available on crate feature geo only.

Sets this item’s geometry.

Also sets this item’s bounding box.

Examples

use stac::Item;
use geojson::{Geometry, Value};

let mut item = Item::new("an-id");
item.set_geometry(Some(Geometry::new(Value::Point(vec![-105.1, 41.1]))));
assert_eq!(item.bbox.unwrap(), vec![-105.1, 41.1, -105.1, 41.1].try_into().unwrap());

pub fn intersects<T>(&self, intersects: &T) -> Result<bool>

where T: Intersects<Geometry>,

Available on crate feature geo only.

Returns true if this item’s geometry intersects the provided geojson geometry.

Examples

use stac::Item;
use geojson::{Geometry, Value};
use geo::{Rect, coord};

let mut item = Item::new("an-id");
item.set_geometry(Some(Geometry::new(Value::Point(vec![-105.1, 41.1]))));
let intersects = Rect::new(
    coord! { x: -106.0, y: 40.0 },
    coord! { x: -105.0, y: 42.0 },
);
assert!(item.intersects(&intersects).unwrap());

pub fn intersects_bbox(&self, bbox: Rect) -> Result<bool>

👎Deprecated since 0.5.2: Use intersects instead

Available on crate feature geo only.

Returns true if this item’s geometry intersects the provided bounding box.

DEPRECATED Use intersects instead.

Examples

use stac::Item;
use geojson::{Geometry, Value};

let mut item = Item::new("an-id");
item.set_geometry(Some(Geometry::new(Value::Point(vec![-105.1, 41.1]))));
let bbox = stac::geo::bbox(&vec![-106.0, 41.0, -105.0, 42.0]).unwrap();
assert!(item.intersects_bbox(bbox).unwrap());

pub fn intersects_datetime_str(&self, datetime: &str) -> Result<bool>

Returns true if this item’s datetime (or start and end datetime) intersects the provided datetime string.

Examples

use stac::Item;
let mut item = Item::new("an-id");
item.properties.datetime = Some("2023-07-11T12:00:00Z".parse().unwrap());
assert!(item.intersects_datetime_str("2023-07-11T00:00:00Z/2023-07-12T00:00:00Z").unwrap());

pub fn intersects_datetimes( &self, start: Option<DateTime<FixedOffset>>, end: Option<DateTime<FixedOffset>>, ) -> Result<bool>

Returns true if this item’s datetime (or start and end datetimes) intersects the provided datetime.

Examples

use stac::Item;
let mut item = Item::new("an-id");
item.properties.datetime = Some("2023-07-11T12:00:00Z".parse().unwrap());
let (start, end) = stac::datetime::parse("2023-07-11T00:00:00Z/2023-07-12T00:00:00Z").unwrap();
assert!(item.intersects_datetimes(start, end).unwrap());

pub fn into_flat_item(self, drop_invalid_attributes: bool) -> Result<FlatItem>

Converts this item into a FlatItem.

If drop_invalid_attributes is True, any properties that conflict with top-level field names will be discarded with a warning. If it is False, and error will be raised. The same is true for any top-level fields that are not part of the spec.

Examples

use stac::Item;

let mut item = Item::new("an-id");
let flat_item = item.into_flat_item(true).unwrap();

Trait Implementations

impl Assets for Item

fn assets(&self) -> &IndexMap<String, Asset>

Returns a reference to this object’s assets.

fn assets_mut(&mut self) -> &mut IndexMap<String, Asset>

Returns a mut reference to this object’s assets.

fn make_assets_absolute(&mut self, base: &str) -> Result<()>

Makes all asset hrefs absolute.

impl Clone for Item

fn clone(&self) -> Item

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Item

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Fields for Item

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: Serialize>( &mut self, key: impl ToString, value: S, ) -> Result<Option<Value>>

Sets the value of a field.

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

Gets values with a prefix.

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

Sets values with a prefix.

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

Removes values with a prefix.

impl From<Item> for Value

fn from(o: Item) -> Value

Converts to this type from the input type.

impl FromGeoparquet for Item

Available on crate feature geoparquet only.

fn from_geoparquet_bytes(_: impl Into<Bytes>) -> Result<Self, Error>

Creates a STAC object from geoparquet bytes.

impl FromIterator<Item> for ItemCollection

fn from_iter<I: IntoIterator<Item = Item>>(iter: I) -> Self

Creates a value from an iterator.

impl FromNdjson for Item

fn from_ndjson_bytes(bytes: impl Into<Bytes>) -> Result<Self>

Creates a STAC object from ndjson bytes.

impl IntoGeoparquet for Item

Available on crate feature geoparquet only.

fn into_geoparquet_writer( self, writer: impl Write + Send, compression: Option<Compression>, ) -> Result<()>

Writes a value to a writer as stac-geoparquet.

fn into_geoparquet_vec( self, compression: Option<Compression>, ) -> Result<Vec<u8>>

Writes a value to a writer as stac-geoparquet to some bytes.

impl Links for Item

fn links(&self) -> &[Link]

Returns a reference to this object’s links.

fn links_mut(&mut self) -> &mut Vec<Link>

Returns a mutable reference to this object’s links.

fn link(&self, rel: &str) -> Option<&Link>

Returns the first link with the given rel type.

fn set_link(&mut self, link: Link)

Sets a link of the given rel type.

fn root_link(&self) -> Option<&Link>

Returns this object’s root link.

fn self_link(&self) -> Option<&Link>

Returns this object’s self link.

fn parent_link(&self) -> Option<&Link>

Returns this object’s parent link.

fn iter_child_links(&self) -> Box<dyn Iterator<Item = &Link> + '_>

Returns an iterator over this object’s child links.

fn iter_item_links(&self) -> Box<dyn Iterator<Item = &Link> + '_>

Returns an iterator over this object’s item links.

fn make_links_absolute(&mut self) -> Result<()>

Makes all relative links absolute with respect to this object’s self href.

fn make_links_relative(&mut self) -> Result<()>

Makes all links relative with respect to this object’s self href.

fn remove_relative_links(&mut self)

Removes all relative links.

fn remove_structural_links(&mut self)

Removes all structural links.

impl Migrate for Item

fn migrate(self, to: &Version) -> Result<Self>

Migrates this object to another version.

impl PartialEq for Item

fn eq(&self, other: &Item) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SelfHref for Item

fn self_href(&self) -> Option<&str>

Gets this object’s href.

fn self_href_mut(&mut self) -> &mut Option<String>

Returns a mutable reference to this object’s self href.

fn set_self_href(&mut self, href: impl ToString)

Sets this object’s self href.

fn clear_self_href(&mut self)

Clear’s this object’s self href.

impl Serialize for Item

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToNdjson for Item

fn to_ndjson_writer(&self, writer: impl Write) -> Result<()>

Writes a value to a writer as newline-delimited JSON.

fn to_ndjson_vec(&self) -> Result<Vec<u8>>

Writes a value as newline-delimited JSON bytes.

impl TryFrom<Feature> for Item

type Error = Error

The type returned in the event of a conversion error.

fn try_from(feature: Feature) -> Result<Item>

Performs the conversion.

impl TryFrom<Item> for Feature

type Error = Error

The type returned in the event of a conversion error.

fn try_from(item: Item) -> Result<Feature>

Performs the conversion.

impl TryFrom<Item> for Map<String, Value>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(item: Item) -> Result<Self>

Performs the conversion.

impl TryFrom<Map<String, Value>> for Item

type Error = Error

The type returned in the event of a conversion error.

fn try_from(map: Map<String, Value>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Item

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Item>

Performs the conversion.

impl StructuralPartialEq for Item