Struct ReleaseDownload 

pub struct ReleaseDownload<P: Platform> { /* private fields */ }

Implementations

impl<P: Platform> ReleaseDownload<P>

pub fn new(project: impl Into<String>) -> Self

Creates a new ReleaseDownload configured for the given project with sensible defaults.

The returned builder is initialized with:

• tag = None
• a default Filter
• no explicit output path
• overwrite = OverwriteMode::Prompt
• extraction disabled
• no extraction path
• no progress callback

Examples

use soar_dl::release::ReleaseDownload;
use soar_dl::github::Github;

let dl = ReleaseDownload::<Github>::new("owner/repo");
// You can then chain further configuration:
// let dl = dl.tag("v1.2.3").output("downloads/").extract(true);

pub fn tag(self, tag: impl Into<String>) -> Self

Sets the release tag to target when selecting a release.

The provided tag will be used by execute to find a release with a matching tag. Returns the updated builder to allow method chaining.

Examples

use soar_dl::release::ReleaseDownload;
use soar_dl::github::Github;

let builder = ReleaseDownload::<Github>::new("owner/repo").tag("v1.2.3");

pub fn filter(self, filter: Filter) -> Self

Sets the asset filter used to select which release assets will be downloaded.

The provided filter will be used to match asset names when executing the download.

Examples

use soar_dl::release::ReleaseDownload;
use soar_dl::filter::Filter;
use soar_dl::github::Github;

let _rd = ReleaseDownload::<Github>::new("owner/repo").filter(Filter::default());

pub fn output(self, path: impl Into<String>) -> Self

Sets the base output path for downloaded assets.

The provided path will be used as the destination directory or base file path when downloads are written.

Returns

The modified ReleaseDownload builder with the output path set.

Examples

use soar_dl::release::ReleaseDownload;
use soar_dl::github::Github;

let dl = ReleaseDownload::<Github>::new("owner/repo").output("downloads");

pub fn overwrite(self, mode: OverwriteMode) -> Self

Set the overwrite behavior for downloaded files.

mode determines how existing files are handled when downloading (for example, overwrite, skip, or prompt).

Examples

use soar_dl::release::ReleaseDownload;
use soar_dl::types::OverwriteMode;
use soar_dl::github::Github;

let dl = ReleaseDownload::<Github>::new("owner/repo").overwrite(OverwriteMode::Force);

pub fn extract(self, extract: bool) -> Self

Enables or disables extraction of downloaded assets.

When set to true, assets that are archives will be extracted after they are downloaded.

Examples

use soar_dl::release::ReleaseDownload;
use soar_dl::github::Github;

let rd = ReleaseDownload::<Github>::new("owner/repo").extract(true);

pub fn extract_to(self, path: impl Into<PathBuf>) -> Self

Sets the destination directory where downloaded archives will be extracted.

Arguments

• path - Destination path to extract downloaded assets into.

Examples

use soar_dl::release::ReleaseDownload;
use soar_dl::github::Github;

let rd = ReleaseDownload::<Github>::new("owner/repo").extract_to("out/artifacts");

pub fn progress<F>(self, f: F) -> Self

where F: Fn(Progress) + Send + Sync + 'static,

Registers a callback that will be invoked with progress updates for each download.

The provided callback is stored and called with Progress events as assets are downloaded.

Examples

use std::sync::Arc;
use soar_dl::release::ReleaseDownload;
use soar_dl::types::Progress;
use soar_dl::github::Github;

let _rd = ReleaseDownload::<Github>::new("owner/repo")
    .progress(|progress: Progress| {
        // handle progress (e.g., log or update UI)
        println!("{:?}", progress);
    });

pub fn execute(self) -> Result<Vec<PathBuf>, DownloadError>

Downloads matched assets for a project’s release and returns their local file paths.

Selects a release by the configured tag if provided; otherwise prefers the first non-prerelease release or falls back to the first release.

Filters the release’s assets using the configured Filter, downloads each matching asset with the configured output, overwrite, and extraction options, and returns a vector of the resulting local PathBufs.

Returns an error if no release is found or if no assets match the filter.

Returns

A Vec<PathBuf> containing the local paths of the downloaded assets on success, or a DownloadError on failure.

Examples

use std::path::PathBuf;
use soar_dl::release::ReleaseDownload;
use soar_dl::github::Github;
use soar_dl::filter::Filter;

let paths: Vec<PathBuf> = ReleaseDownload::<Github>::new("owner/repo")
    .tag("v1.0")
    .filter(Filter::default())
    .output("downloads")
    .execute()
    .unwrap();

assert!(!paths.is_empty());