Struct Progress 

pub struct Progress {
    pub current: usize,
    pub total: usize,
    pub status: Option<String>,
}

Progress information for long-running operations.

This struct tracks the current progress of operations like file uploads, downloads, or dataset processing. It provides the current count, total count, and an optional status string to enable progress reporting in applications.

Multi-Stage Progress

The status field enables multi-stage progress tracking. When an operation has multiple phases, the status field changes to indicate the current phase. Applications should detect status changes to reset their progress display.

Operation Progress Details

Operation	Status	Unit	Notes
download_dataset	None then "Downloading"	samples	Two phases: fetch metadata, then download files
populate_samples	None	samples	Each sample may contain multiple files
samples	None	samples	Paginated API fetch
sample_names	None	samples	Paginated API fetch, names only
annotations	None	samples	Samples processed for annotations
download_artifact	None	bytes	Single file byte-level progress
download_checkpoint	None	bytes	Single file byte-level progress
download_snapshot	None	bytes	Combined byte progress across all files

Examples

Basic progress display:

use edgefirst_client::Progress;

let progress = Progress {
    current: 25,
    total: 100,
    status: Some("Downloading".to_string()),
};
let percentage = (progress.current as f64 / progress.total as f64) * 100.0;
println!(
    "{}: {:.1}% ({}/{})",
    progress.status.as_deref().unwrap_or("Progress"),
    percentage,
    progress.current,
    progress.total
);

Multi-stage progress handling (e.g., for download_dataset):

let mut last_status: Option<String> = None;

while let Some(progress) = rx.recv().await {
    // Detect stage change and reset progress bar
    if progress.status != last_status {
        if let Some(ref status) = progress.status {
            println!("\n{}", status);
        }
        last_status = progress.status.clone();
    }

    let pct = (progress.current as f64 / progress.total as f64) * 100.0;
    print!("\r{:.1}% ({}/{})", pct, progress.current, progress.total);
}

Fields

current: usize

Current number of completed items or bytes.

total: usize

Total number of items or bytes to process.

status: Option<String>

Optional status describing the current operation phase.

When this value changes from None to Some(...) or between different values, it indicates a new phase has started. Applications should reset their progress display when the status changes.

Currently only Client::download_dataset uses status changes:

• Phase 1: None while fetching sample metadata
• Phase 2: "Downloading" while downloading files

All other operations use None throughout.

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Progress

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Progress

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

Formats the value using the given formatter.