Struct IndicatifReporter

pub struct IndicatifReporter<F> { /* private fields */ }

A Reporter implementation to outputs progress bars using indicatif.

Implementations

impl IndicatifReporter<DefaultProgressFormatter>

pub fn builder() -> IndicatifReporterBuilder<DefaultProgressFormatter>

Returns a builder to construct a IndicatifReporter.

Trait Implementations

impl Default for IndicatifReporter<DefaultProgressFormatter>

fn default() -> Self

Returns the “default value” for a type.

impl<F: ProgressFormatter + Send> Reporter for IndicatifReporter<F>

fn on_transaction_start( &self, transaction: &Transaction<PrefixRecord, RepoDataRecord>, )

Called when the transaction starts. This is the first method called.

fn on_transaction_operation_start(&self, _operation: usize)

Called when a transaction operation starts. During the operation the cache is populated, previous installations are uninstalled and new installations are linked.

fn on_populate_cache_start( &self, operation: usize, _record: &RepoDataRecord, ) -> usize

Called when starting to populate the cache for a package. This is called for any new package that will be installed. Before installation any package is first added to the cache.

fn on_validate_start(&self, cache_entry: usize) -> usize

Called when validation of a package starts. If a package is already present in the cache, the contents of the package is validated against its manifest, this is done to ensure that the package is not corrupted.

fn on_validate_complete(&self, cache_entry: usize)

Called when validation completes. If the package is valid, the package is immediately used and no downloading is required.

fn on_download_start(&self, cache_entry: usize) -> usize

Called when a download starts. If a package is not present in the cache or the package in the cache is corrupt, the package is downloaded. This function is called right before that happens.

fn on_download_progress( &self, cache_entry: usize, progress: u64, _total: Option<u64>, )

Called with regular updates on the download progress.

fn on_download_completed(&self, cache_entry: usize)

Called when a download completes.

fn on_populate_cache_complete(&self, _cache_entry: usize)

Called when the cache for a package was populated

fn on_unlink_start(&self, operation: usize, _record: &PrefixRecord) -> usize

Called when an unlink operation started.

fn on_unlink_complete(&self, operation: usize)

Called when an unlink operation completed.

fn on_link_start(&self, operation: usize, _record: &RepoDataRecord) -> usize

Called when linking of a package has started

fn on_link_complete(&self, operation: usize)

Called when linking of a package completed.

fn on_transaction_operation_complete(&self, _operation: usize)

Called when a transaction operation finishes.

fn on_transaction_complete(&self)

Called when the transaction completes. Unless an error occurs, this is the last function that is called.

fn on_post_link_start(&self, package_name: &str, script_path: &str) -> usize

Called when a post-link script starts execution.

fn on_post_link_complete(&self, _index: usize, success: bool)

Called when a post-link script completes execution.

fn on_pre_unlink_start(&self, package_name: &str, script_path: &str) -> usize

Called when a pre-unlink script starts execution.

fn on_pre_unlink_complete(&self, _index: usize, success: bool)

Called when a pre-unlink script completes execution.