Struct DownloadPlan 

pub struct DownloadPlan {
    pub repo_id: String,
    pub revision: String,
    pub files: Vec<FilePlan>,
    pub total_bytes: u64,
    pub cached_bytes: u64,
    pub download_bytes: u64,
}

A download plan describing which files need downloading and which are cached.

Created by download_plan(). Contains per-file metadata and aggregate byte counts. Use recommended_config() to compute an optimized FetchConfig based on the file size distribution.

Fields

repo_id: String

Repository identifier (e.g., "google/gemma-2-2b-it").

revision: String

Resolved revision (commit hash or branch name).

files: Vec<FilePlan>

Per-file plan entries.

total_bytes: u64

Total bytes across all files (cached + uncached).

cached_bytes: u64

Bytes already present in local cache.

download_bytes: u64

Bytes that need downloading.

Implementations

impl DownloadPlan

pub fn files_to_download(&self) -> usize

Number of files that still need downloading.

pub const fn fully_cached(&self) -> bool

Whether all files are already cached (download would be a no-op).

pub fn recommended_config(&self) -> Result<FetchConfig, FetchError>

Computes an optimized FetchConfig based on the size distribution of uncached files.

The returned config has no token, revision, on_progress, or glob filters set — only the performance-tuning fields (concurrency, connections_per_file, chunk_threshold). Merge with user config before use.

Errors

Returns FetchError::InvalidPattern if the internal builder fails (should not happen since no patterns are set).

pub fn recommended_config_builder(&self) -> FetchConfigBuilder

Like recommended_config() but returns a FetchConfigBuilder so the caller can override specific fields.

Trait Implementations

impl Clone for DownloadPlan

fn clone(&self) -> DownloadPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DownloadPlan

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

Formats the value using the given formatter.