Struct stac_async::ApiClient

pub struct ApiClient { /* private fields */ }

A client for interacting with STAC APIs.

Implementations

impl ApiClient

pub fn new(url: &str) -> Result<ApiClient>

Creates a new API client.

Examples

let client = ApiClient::new("https://planetarycomputer.microsoft.com/api/stac/v1").unwrap();

pub fn with_client(client: Client, url: &str) -> Result<ApiClient>

Creates a new API client with the given Client.

Useful if you want to customize the behavior of the underlying Client, as documented in Client::new.

Examples

use stac_async::{Client, ApiClient};
let client = Client::new();
let api_client = ApiClient::with_client(client, "https://earth-search.aws.element84.com/v1/").unwrap();

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

Returns a single collection.

Examples

let client = ApiClient::new("https://planetarycomputer.microsoft.com/api/stac/v1").unwrap();
let collection = client.collection("sentinel-2-l2a").await.unwrap().unwrap();

pub async fn items( &self, id: &str, items: impl Into<Option<Items>>, ) -> Result<impl Stream<Item = Result<Item>>>

Returns a stream of items belonging to a collection, using the items endpoint.

The items argument can be used to filter, sort, and otherwise configure the request.

Examples

use stac_api::Items;
use stac_async::ApiClient;
use futures_util::stream::StreamExt;

let client = ApiClient::new("https://planetarycomputer.microsoft.com/api/stac/v1").unwrap();
let items = Items {
    limit: Some(1),
    ..Default::default()
};
let items: Vec<_> = client
    .items("sentinel-2-l2a", items)
    .await
    .unwrap()
    .map(|result| result.unwrap())
    .collect()
    .await;
assert_eq!(items.len(), 1);

pub async fn search( &self, search: Search, ) -> Result<impl Stream<Item = Result<Item>>>

Searches an API, returning a stream of items.

Examples

use stac_api::Search;
use stac_async::ApiClient;
use futures_util::stream::StreamExt;

let client = ApiClient::new("https://planetarycomputer.microsoft.com/api/stac/v1").unwrap();
let mut search = Search { collections: Some(vec!["sentinel-2-l2a".to_string()]), ..Default::default() };
search.items.limit = Some(1);
let items: Vec<_> = client
    .search(search)
    .await
    .unwrap()
    .map(|result| result.unwrap())
    .collect()
    .await;
assert_eq!(items.len(), 1);

Trait Implementations

impl Debug for ApiClient

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

Formats the value using the given formatter.