Struct StatisticsTracker 

pub struct StatisticsTracker { /* private fields */ }

Subscribes to the event bus and maintains running statistics about all download and metadata fetch operations.

The tracker runs a background task that processes events from the EventBus and updates its internal counters. Use snapshot to retrieve a point-in-time view of the collected data.

Examples

let libraries = Libraries::new(PathBuf::from("libs/yt-dlp"), PathBuf::from("libs/ffmpeg"));
let downloader = Downloader::builder(libraries, "output").build().await?;

// ... perform downloads ...

let snapshot = downloader.statistics().snapshot().await;
println!("Completed: {}", snapshot.downloads.completed);
println!("Total bytes: {}", snapshot.downloads.total_bytes);

Implementations

impl StatisticsTracker

pub fn new(bus: &EventBus) -> Self

Creates a tracker with default configuration and subscribes to bus.

Arguments

• bus - The event bus to subscribe to.

Returns

A new StatisticsTracker that is already running its background event loop.

pub fn with_config(bus: &EventBus, config: TrackerConfig) -> Self

Creates a tracker with custom configuration and subscribes to bus.

Arguments

• bus - The event bus to subscribe to.
• config - History-size bounds and other settings.

Returns

A new StatisticsTracker that is already running its background event loop.

pub async fn snapshot(&self) -> GlobalSnapshot

Returns a point-in-time snapshot of all collected statistics.

Acquires a read lock on the internal state, computes derived metrics (averages, rates), and returns a fully-owned GlobalSnapshot. Subsequent mutations to the tracker are not reflected in an already-obtained snapshot.

Returns

A GlobalSnapshot containing aggregate statistics for downloads, fetches, post-processing, and playlists at the time of the call.

pub async fn active_count(&self) -> usize

Returns the number of downloads currently in progress.

Returns

The count of downloads that have been started but have not yet reached a terminal state (completed, failed, or canceled).

pub async fn completed_count(&self) -> u64

Returns the total number of successfully completed downloads.

Returns

Cumulative count of downloads that ended with a DownloadCompleted event.

pub async fn total_bytes(&self) -> u64

Returns the total number of bytes transferred across all completed downloads.

Returns

Sum of total_bytes from every DownloadCompleted event received.

pub async fn reset(&self)

Resets all counters and history to their initial state, preserving the configuration.

This is useful for implementing rolling windows or clearing statistics between logical phases of an application. The tracker continues running and will start collecting fresh data immediately after the reset.

Trait Implementations

impl Debug for StatisticsTracker

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

Formats the value using the given formatter.

impl Display for StatisticsTracker

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

Formats the value using the given formatter.