Struct Catalog

pub struct Catalog {
    pub version: Version,
    pub extensions: Vec<String>,
    pub id: String,
    pub title: Option<String>,
    pub description: String,
    pub links: Vec<Link>,
    pub additional_fields: Map<String, Value>,
    /* private fields */
}

A STAC Catalog object represents a logical group of other Catalog, Collection, and Item objects.

These Items can be linked to directly from a Catalog, or the Catalog can link to other Catalogs (often called sub-catalogs) that contain links to Collections and Items. The division of sub-catalogs is up to the implementor, but is generally done to aid the ease of online browsing by people.

A Catalog object will typically be the entry point into a STAC catalog. Their purpose is discovery: to be browsed by people or be crawled by clients to build a searchable index.

Fields

version: Version

The STAC version the Catalog implements.

extensions: Vec<String>

A list of extension identifiers the Catalog implements.

id: String

Identifier for the Catalog.

title: Option<String>

A short descriptive one-line title for the Catalog.

description: String

Detailed multi-line description to fully explain the Catalog.

CommonMark 0.29 syntax MAY be used for rich text representation.

links: Vec<Link>

A list of references to other documents.

additional_fields: Map<String, Value>

Additional fields not part of the Catalog specification.

Implementations

impl Catalog

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

Creates a new Catalog with the given id.

Examples

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

Trait Implementations

impl Clone for Catalog

fn clone(&self) -> Catalog

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Catalog

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Catalog

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Fields for Catalog

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<Catalog> for Container

fn from(value: Catalog) -> Self

Converts to this type from the input type.

impl From<Catalog> for Node

fn from(value: Catalog) -> Self

Converts to this type from the input type.

impl From<Catalog> for Value

fn from(o: Catalog) -> Value

Converts to this type from the input type.

impl FromGeoparquet for Catalog

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

Creates a STAC object from geoparquet bytes.

fn from_geoparquet_path(path: impl AsRef<Path>) -> Result<Self>

Reads geoparquet data from a file.

impl FromNdjson for Catalog

fn from_ndjson_path(path: impl AsRef<Path>) -> Result<Self>

Reads newline-delimited JSON data from a file.

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

Creates a STAC object from ndjson bytes.

impl IntoGeoparquet for Catalog

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

Writes a value to a writer as stac-geoparquet.

fn into_geoparquet_path( self, path: impl AsRef<Path>, compression: Option<Compression>, ) -> Result<()>

Writes a value to a path 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 Catalog

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 Catalog

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

Migrates this object to another version.

impl PartialEq for Catalog

fn eq(&self, other: &Catalog) -> 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 Catalog

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

Gets this object’s href.

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

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

impl Serialize for Catalog

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 Catalog

fn to_ndjson_path(&self, path: impl AsRef<Path>) -> Result<()>

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

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<Catalog> for Map<String, Value>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(catalog: Catalog) -> Result<Self>

Performs the conversion.

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

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 Catalog

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for Catalog