Struct InstallDriver

pub struct InstallDriver { /* private fields */ }

Packages can mostly be installed in isolation and therefore in parallel. However, when installing a large number of packages at the same time the different installation tasks start competing for resources. The InstallDriver helps to assist in making sure that tasks don’t starve each other from resource as well as making sure that due to the large number of requests the process doesn’t try to acquire more resources than the system has available.

Implementations

impl InstallDriver

pub fn builder() -> InstallDriverBuilder

Constructs a builder to configure a new InstallDriver.

pub async fn acquire_io_permit( &self, ) -> Result<Option<OwnedSemaphorePermit>, AcquireError>

Returns a permit that will allow the caller to perform IO operations. This is used to make sure that the system doesn’t try to acquire more IO resources than the system has available.

pub fn clobber_registry(&self) -> MutexGuard<'_, ClobberRegistry>

Return a locked reference to the paths registry. This is used to make sure that the same path is not installed twice.

pub fn pre_process<Old: Borrow<PrefixRecord>, New>( &self, transaction: &Transaction<Old, New>, target_prefix: &Path, reporter: Option<&dyn Reporter>, ) -> Result<Option<PrePostLinkResult>, PrePostLinkError>

Call this before any packages are installed to perform any pre processing that is required.

pub async fn run_blocking_io_task<T: Send + 'static, E: Send + From<Cancelled> + 'static, F: FnOnce() -> Result<T, E> + Send + 'static>( &self, f: F, ) -> Result<T, E>

Runs a blocking task that will execute on a separate thread. The task is not started until an IO permit is acquired. This is used to make sure that the system doesn’t try to acquire more IO resources than the system has available.

pub fn post_process<Old: Borrow<PrefixRecord> + AsRef<New>, New: AsRef<PackageRecord>>( &self, transaction: &Transaction<Old, New>, target_prefix: &Prefix, reporter: Option<&dyn Reporter>, ) -> Result<PostProcessResult, PostProcessingError>

Call this after all packages have been installed to perform any post processing that is required.

This function will select a winner among multiple packages that might write to a single package and will also execute any post-link.sh/bat scripts

pub fn remove_empty_directories<Old: Borrow<PrefixRecord>, New>( &self, operations: &[TransactionOperation<Old, New>], new_prefix_records: &[PrefixRecord], target_prefix: &Path, ) -> Result<(), UnlinkError>

Remove all empty directories that are not part of the new prefix records.

impl InstallDriver

pub fn run_post_link_scripts<Old, New>( &self, transaction: &Transaction<Old, New>, prefix_records: &[&PrefixRecord], target_prefix: &Path, reporter: Option<&dyn Reporter>, ) -> Result<PrePostLinkResult, LinkScriptError>

where Old: AsRef<New>, New: AsRef<PackageRecord>,

Run any post-link scripts that are part of the packages that are being installed.

pub fn run_pre_unlink_scripts<Old, New>( &self, transaction: &Transaction<Old, New>, target_prefix: &Path, reporter: Option<&dyn Reporter>, ) -> Result<PrePostLinkResult, LinkScriptError>

where Old: Borrow<PrefixRecord>,

Run any pre-unlink scripts that are part of the packages that are being removed.

Trait Implementations

impl Default for InstallDriver

fn default() -> Self

Returns the “default value” for a type.