Struct stac_async::download::Downloader

pub struct Downloader<T: Links + Assets + Href + Serialize + Clone> { /* private fields */ }

A customizable download structure.

Implementations

impl<T: Links + Assets + Href + Serialize + Clone> Downloader<T>

pub fn new(stac: T) -> Result<Downloader<T>>

Creates a new downloader.

Examples

let item: stac::Item = stac::read("data/simple-item.json").unwrap();
let downloader = stac_async::Downloader::new(item);

pub fn create_directory(self, create_directory: bool) -> Downloader<T>

Should the downloader create the output directory?

Defaults to true.

Examples

let item: stac::Item = stac::read("data/simple-item.json").unwrap();
let downloader = stac_async::Downloader::new(item)
    .unwrap()
    .create_directory(false);

pub fn with_sender(self, sender: Sender<Message>) -> Downloader<T>

Set the sender for messages from this downloader.

Examples

use tokio::sync::mpsc;
use stac_async::Downloader;
use stac::Item;

let (tx, mut rx)  = mpsc::channel(100);
let item: Item = stac::read("data/simple-item.json").unwrap();
let downloader = Downloader::new(item)
    .unwrap()
    .with_sender(tx);

tokio::spawn(async move {
    downloader.download(".").await.unwrap()
});

while let Some(message) = rx.recv().await {
    dbg!(message);
}

pub async fn download(self, directory: impl AsRef<Path>) -> Result<T>

Downloads assets to the specified directory.

Consumes this downloader, and returns the modified object.

Examples

let item: stac::Item = stac::read("data/simple-item.json").unwrap();
let downloader = stac_async::Downloader::new(item).unwrap();
let item = downloader.download("outdir").await.unwrap();

Trait Implementations

impl<T: Debug + Links + Assets + Href + Serialize + Clone> Debug for Downloader<T>

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

Formats the value using the given formatter.