Struct BlockingClient

pub struct BlockingClient(/* private fields */);

Available on crate feature client only.

A client for interacting with STAC APIs without async.

Implementations

impl BlockingClient

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

Creates a new blocking client.

Examples

use stac_api::BlockingClient;

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

pub fn search(&self, search: Search) -> Result<BlockingIterator>

Searches an API, returning an iterable of items.

To prevent fetching all the items (which might be a lot), it is recommended to pass a max_items.

Examples

use stac_api::{Search, BlockingClient};

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

Trait Implementations

impl Debug for BlockingClient

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

Formats the value using the given formatter.