Struct stac::Collection

pub struct Collection {
    pub extensions: Option<Vec<String>>,
    pub id: String,
    pub title: Option<String>,
    pub description: String,
    pub keywords: Option<Vec<String>>,
    pub license: String,
    pub providers: Option<Vec<Provider>>,
    pub extent: Extent,
    pub summaries: Option<Map<String, Value>>,
    pub links: Vec<Link>,
    pub assets: HashMap<String, Asset>,
    pub additional_fields: Map<String, Value>,
    /* private fields */
}

The STAC Collection Specification defines a set of common fields to describe a group of Items that share properties and metadata.

The Collection Specification shares all fields with the STAC Catalog Specification (with different allowed values for type and extensions) and adds fields to describe the whole dataset and the included set of Items. Collections can have both parent Catalogs and Collections and child Items, Catalogs and Collections.

A STAC Collection is represented in JSON format. Any JSON object that contains all the required fields is a valid STAC Collection and also a valid STAC Catalog.

Fields

extensions: Option<Vec<String>>

A list of extension identifiers the Collection implements.

id: String

Identifier for the Collection that is unique across the provider.

title: Option<String>

A short descriptive one-line title for the Collection.

description: String

Detailed multi-line description to fully explain the Collection.

CommonMark 0.29 syntax MAY be used for rich text representation.

keywords: Option<Vec<String>>

List of keywords describing the Collection.

license: String

Collection’s license(s), either a SPDX License identifier, "various" if multiple licenses apply or "proprietary" for all other cases.

providers: Option<Vec<Provider>>

A list of providers, which may include all organizations capturing or processing the data or the hosting provider.

Providers should be listed in chronological order with the most recent provider being the last element of the list.

extent: Extent

Spatial and temporal extents.

summaries: Option<Map<String, Value>>

A map of property summaries, either a set of values, a range of values or a JSON Schema.

links: Vec<Link>

A list of references to other documents.

assets: HashMap<String, Asset>

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

additional_fields: Map<String, Value>

Additional fields not part of the Collection specification.

Implementations

impl Collection

pub fn new(id: impl ToString, description: impl ToString) -> Collection

Creates a new Collection with the given id.

Examples

use stac::Collection;
let collection = Collection::new("an-id", "a description");
assert_eq!(collection.id, "an-id");
assert_eq!(collection.description, "a description");

Trait Implementations

impl Assets for Collection

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

Returns a reference to this object’s assets.

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

Returns a mut reference to this object’s assets.

impl Clone for Collection

fn clone(&self) -> Collection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Collection

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Collection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extensions for Collection

fn extensions(&self) -> Option<&[String]>

Returns a reference to this object’s extensions.

impl Href for Collection

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

Gets this object’s href.

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

Sets this object’s href.

impl Links for Collection

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_relative_links_absolute(&mut self, href: impl ToString) -> Result<()>

Makes all relative links absolute with respect to an href.

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

Removes all relative links.

impl PartialEq<Collection> for Collection

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Collection

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

Serialize this value into the given Serde serializer.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(collection: Collection) -> Result<Self>

Performs the conversion.

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

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 Validate for Collection

Available on crate feature jsonschema only.

fn validate(self) -> Result<(), Vec<Error>>

Validate this STAC object using a one-time-use Validator.

impl StructuralPartialEq for Collection