Struct DownloadEngine 

pub struct DownloadEngine { /* private fields */ }

The main download engine

Implementations

impl DownloadEngine

pub async fn new(config: EngineConfig) -> Result<Arc<Self>>

Create a new download engine with the given configuration

When the storage feature is enabled and config.database_path is set, download state is persisted to the built-in SQLite storage. To use a custom Storage implementation instead, see with_storage.

pub async fn with_storage( config: EngineConfig, storage: Arc<dyn Storage>, ) -> Result<Arc<Self>>

Create a new download engine that persists state to the given Storage implementation.

This allows applications that maintain their own metadata store (custom database, sidecar files, …) to get full pause/resume and crash-recovery support without the built-in SQLite storage or the storage feature. Previously persisted downloads are loaded from the given storage during construction.

config.database_path is ignored when this constructor is used; the injected storage always wins.

Example

use std::sync::Arc;
use gosh_dl::{DownloadEngine, EngineConfig, MemoryStorage};

let storage = Arc::new(MemoryStorage::new());
let engine = DownloadEngine::with_storage(EngineConfig::default(), storage).await?;

pub async fn add_http( &self, url: &str, options: DownloadOptions, ) -> Result<DownloadId>

Add an HTTP/HTTPS download

pub async fn add_torrent( &self, torrent_data: &[u8], options: DownloadOptions, ) -> Result<DownloadId>

Add a BitTorrent download from torrent file data

pub async fn add_magnet( &self, magnet_uri: &str, options: DownloadOptions, ) -> Result<DownloadId>

Add a BitTorrent download from a magnet URI

pub async fn pause(&self, id: DownloadId) -> Result<()>

Pause a download

pub async fn resume(&self, id: DownloadId) -> Result<()>

Resume a paused download

pub async fn cancel(&self, id: DownloadId, delete_files: bool) -> Result<()>

Cancel a download and optionally delete files

pub async fn pause_all(&self) -> BatchResult

Pause every active or queued download.

Queued downloads are paused as well so that freed slots do not immediately promote them back into running state. Downloads that change state while the batch is in flight are reported as skipped. Per-download StateChanged/Paused events are emitted as usual; there is no separate batch event.

pub async fn resume_all(&self) -> BatchResult

Resume every paused download.

Downloads that change state while the batch is in flight are reported as skipped. Per-download Resumed events are emitted as usual.

pub async fn cancel_all(&self, delete_files: bool) -> BatchResult

Cancel every download, optionally deleting downloaded files.

Tracked recursive job records are removed as well, since all of their children are gone after this call. Per-download Removed events are emitted as usual.

pub fn status(&self, id: DownloadId) -> Option<DownloadStatus>

Get the status of a download

pub fn list(&self) -> Vec<DownloadStatus>

List all downloads

pub fn active(&self) -> Vec<DownloadStatus>

Get active downloads

pub fn waiting(&self) -> Vec<DownloadStatus>

Get waiting/queued downloads

pub fn stopped(&self) -> Vec<DownloadStatus>

Get stopped downloads (paused, completed, error)

pub fn global_stats(&self) -> GlobalStats

Get global statistics

pub fn subscribe(&self) -> Receiver<DownloadEvent>

Subscribe to download events

pub fn set_config(&self, config: EngineConfig) -> Result<()>

Update engine configuration

pub fn get_config(&self) -> EngineConfig

Get current configuration

pub fn set_priority( &self, id: DownloadId, priority: DownloadPriority, ) -> Result<()>

Set the priority of a download

This affects the order in which downloads acquire slots when queued. If the download is already active, the priority is updated but won’t affect scheduling until the download is paused and resumed.

The priority change is persisted to storage immediately (non-blocking).

pub fn get_priority(&self, id: DownloadId) -> Option<DownloadPriority>

Get the current priority of a download

pub fn get_bandwidth_limits(&self) -> BandwidthLimits

Get current bandwidth limits (accounting for schedule rules)

pub fn set_schedule_rules(&self, rules: Vec<ScheduleRule>)

Update the bandwidth schedule rules

The new rules take effect immediately after evaluation.

pub fn get_schedule_rules(&self) -> Vec<ScheduleRule>

Get the current schedule rules

pub async fn shutdown(&self) -> Result<()>

Graceful shutdown

Trait Implementations

impl Drop for DownloadEngine

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.