Struct Api

pub struct Api<B: Backend> {
    pub backend: B,
    pub description: String,
    pub id: String,
    pub root: Url,
}

A STAC server API.

Fields

backend: B

The backend storage for this API.

description: String

The text description of this API.

id: String

The catalog id of this API.

root: Url

The root url of this API.

Implementations

impl<B: Backend> Api<B>

pub fn new(backend: B, root: &str) -> Result<Api<B>>

Creates a new API with the given backend.

Examples

use stac_server::{Api, MemoryBackend};

let backend = MemoryBackend::new();
let api = Api::new(backend, "http://stac.test").unwrap();

pub fn id(self, id: impl ToString) -> Api<B>

Sets this API’s id.

Examples

use stac_server::{Api, MemoryBackend};

let backend = MemoryBackend::new();
let api = Api::new(backend, "http://stac.test").unwrap().id("an-id");

pub fn description(self, description: impl ToString) -> Api<B>

Sets this API’s description.

Examples

use stac_server::{Api, MemoryBackend};

let backend = MemoryBackend::new();
let api = Api::new(backend, "http://stac.test").unwrap().description("a description");

pub async fn root(&self) -> Result<Root>

Returns the root of the API.

Examples

use stac_server::{Api, MemoryBackend};

let api = Api::new(MemoryBackend::new(), "http://stac.test").unwrap();
let root = api.root().await.unwrap();

pub fn conformance(&self) -> Conformance

Returns the conformance classes.

Examples

use stac_server::{Api, MemoryBackend};

let api = Api::new(MemoryBackend::new(), "http://stac.test").unwrap();
let conformance = api.conformance();

pub fn queryables(&self) -> Value

Returns queryables.

pub async fn collections(&self) -> Result<Collections>

Returns the collections from the backend.

Examples

use stac_server::{Api, MemoryBackend};

let api = Api::new(MemoryBackend::new(), "http://stac.test").unwrap();
let collections = api.collections().await.unwrap();

pub async fn collection(&self, id: &str) -> Result<Option<Collection>>

Returns the collections from the backend.

Examples

use stac_server::{Api, MemoryBackend, Backend};
use stac::Collection;

let mut backend = MemoryBackend::new();
backend.add_collection(Collection::new("an-id", "a description")).await.unwrap();
let api = Api::new(backend, "http://stac.test").unwrap();
let collection = api.collection("an-id").await.unwrap().unwrap();

pub async fn items( &self, collection_id: &str, items: Items, ) -> Result<Option<ItemCollection>>

Returns all items for a given collection.

Examples

use stac_server::{Api, MemoryBackend, Backend};
use stac::{Collection, Item};
use stac_api::Items;

let mut backend = MemoryBackend::new();
backend.add_collection(Collection::new("collection-id", "a description")).await.unwrap();
backend.add_item(Item::new("item-id").collection("collection-id")).await.unwrap();
let api = Api::new(backend, "http://stac.test").unwrap();
let items = api.items("collection-id", Items::default()).await.unwrap().unwrap();
assert_eq!(items.items.len(), 1);

pub async fn item( &self, collection_id: &str, item_id: &str, ) -> Result<Option<Item>>

Returns an item.

Examples

use stac_server::{Api, MemoryBackend, Backend};
use stac::{Collection, Item};
use stac_api::Items;

let mut backend = MemoryBackend::new();
backend.add_collection(Collection::new("collection-id", "a description")).await.unwrap();
backend.add_item(Item::new("item-id").collection("collection-id")).await.unwrap();
let api = Api::new(backend, "http://stac.test").unwrap();
let item = api.item("collection-id", "item-id").await.unwrap().unwrap();

pub async fn search( &self, search: Search, method: Method, ) -> Result<ItemCollection>

Searches the API.

Examples

use stac_api::Search;
use stac_server::{Api, MemoryBackend, Backend};
use http::Method;

let api = Api::new(MemoryBackend::new(), "http://stac.test").unwrap();
let item_collection = api.search(Search::default(), Method::GET).await.unwrap();

Trait Implementations

impl<B: Clone + Backend> Clone for Api<B>

fn clone(&self) -> Api<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug + Backend> Debug for Api<B>

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

Formats the value using the given formatter.