Struct modio::download::Downloader

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

A Downloader can be used to stream a mod file or save the file to a local file. Constructed with Modio::download.

Implementations

impl Downloader

pub async fn save_to_file<P: AsRef<Path>>(self, file: P) -> Result<()>

Save the mod file to a local file.

Example

let action = modio::DownloadAction::Primary {
    game_id: Id::new(5),
    mod_id: Id::new(19),
};

modio
    .download(action)
    .await?
    .save_to_file("mod.zip")
    .await?;

pub async fn bytes(self) -> Result<Bytes>

Get the full mod file as Bytes.

Example

let action = modio::DownloadAction::Primary {
    game_id: Id::new(5),
    mod_id: Id::new(19),
};

let bytes = modio.download(action).await?.bytes().await?;

pub fn stream(self) -> impl Stream<Item = Result<Bytes>>

Stream of bytes of the mod file.

Example

use futures_util::TryStreamExt;

let action = modio::DownloadAction::Primary {
    game_id: Id::new(5),
    mod_id: Id::new(19),
};

let mut st = Box::pin(modio.download(action).await?.stream());
while let Some(bytes) = st.try_next().await? {
    println!("Bytes: {:?}", bytes);
}

pub fn content_length(&self) -> Option<u64>

Get the content length from the mod file response.

Example

let action = modio::DownloadAction::Primary {
    game_id: Id::new(5),
    mod_id: Id::new(19),
};

let content_length = modio
    .download(action)
    .await?
    .content_length()
    .expect("mod file response should have content length");