Struct stac_api::ItemCollection

pub struct ItemCollection {
    pub items: Vec<Item>,
    pub links: Vec<Link>,
    pub number_matched: Option<u64>,
    pub number_returned: Option<u64>,
    pub context: Option<Context>,
    pub additional_fields: Map<String, Value>,
    pub next: Option<Map<String, Value>>,
    pub prev: Option<Map<String, Value>>,
    pub first: Option<Map<String, Value>>,
    pub last: Option<Map<String, Value>>,
    /* private fields */
}

The return value of the /items and /search endpoints.

This might be a stac::ItemCollection, but if the fields extension is used, it might not be. Defined by the itemcollection fragment.

Fields

items: Vec<Item>

A possibly-empty array of Item objects.

links: Vec<Link>

An array of Links related to this ItemCollection.

number_matched: Option<u64>

The number of Items that meet the selection parameters, possibly estimated.

number_returned: Option<u64>

The number of Items in the features array.

context: Option<Context>

The search-related metadata for the ItemCollection.

Part of the context extension.

additional_fields: Map<String, Value>

Additional fields.

next: Option<Map<String, Value>>

Optional pagination information for the next page.

This is not part of the specification, but can be used to hold arbitrary pagination information (tokens) to later be turned into links.

prev: Option<Map<String, Value>>

Optional pagination information for the previous page.

This is not part of the specification, but can be used to hold arbitrary pagination information (tokens) to later be turned into links.

first: Option<Map<String, Value>>

Optional pagination information for the first page.

This is not part of the specification, but can be used to hold arbitrary pagination information (tokens) to later be turned into links.

last: Option<Map<String, Value>>

Optional pagination information for the last page.

This is not part of the specification, but can be used to hold arbitrary pagination information (tokens) to later be turned into links.

Implementations

impl ItemCollection

pub fn new(items: Vec<Item>) -> Result<ItemCollection>

Creates a new ItemCollection from a vector of items.

Examples

let item: stac_api::Item = stac::Item::new("an-id").try_into().unwrap();
let item_collection = stac_api::ItemCollection::new(vec![item]).unwrap();

Trait Implementations

impl Debug for ItemCollection

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

Formats the value using the given formatter.

impl Default for ItemCollection

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ItemCollection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Vec<Map<String, Value>>> for ItemCollection

fn from(items: Vec<Item>) -> Self

Converts to this type from the input type.

impl Href for ItemCollection

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

Sets this object’s href.

fn clear_href(&mut self)

Clears this object’s href.

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

Gets this object’s href.

impl Links for ItemCollection

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) -> Result<(), Error>

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

fn make_absolute_links_relative( &mut self, href: impl ToString, ) -> Result<(), Error>

Makes all absolute links relative with respect to an href.

fn remove_relative_links(&mut self)

Removes all relative links.

fn remove_structural_links(&mut self)

Removes all structural links.

impl Serialize for ItemCollection

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

where __S: Serializer,

Serialize this value into the given Serde serializer.