Struct GlobalCacheTracker

pub struct GlobalCacheTracker {
    conn: Connection,
    auto_gc_checked_this_session: bool,
}

Tracking for the global shared cache (registry files, etc.).

This is the interface to the global cache database, used for tracking and cleaning. See the crate::core::global_cache_tracker module docs for details.

Fields

conn: Connection

Connection to the SQLite database.

auto_gc_checked_this_session: bool

This is an optimization used to make sure cargo only checks if gc needs to run once per session. This starts as false, and then the first time it checks if automatic gc needs to run, it will be set to true.

Implementations

impl GlobalCacheTracker

pub fn new(gctx: &GlobalContext) -> CargoResult<GlobalCacheTracker>

Creates a new GlobalCacheTracker.

The caller is responsible for locking the package cache with CacheLockMode::DownloadExclusive before calling this.

pub fn db_path(gctx: &GlobalContext) -> Filesystem

The path to the database.

fn id_from_name( conn: &Connection, table_name: &str, encoded_name: &str, ) -> CargoResult<Option<ParentId>>

Given an encoded registry name, returns its ID.

Returns None if the given name isn’t in the database.

fn get_id_map( conn: &Connection, table_name: &str, ids: &[i64], ) -> CargoResult<HashMap<i64, PathBuf>>

Returns a map of ID to path for the given ids in the given table.

For example, given registry_index IDs, it returns filenames of the form “index.crates.io-6f17d22bba15001f”.

pub fn registry_index_all(&self) -> CargoResult<Vec<(RegistryIndex, u64)>>

Returns all index cache timestamps.

pub fn registry_crate_all(&self) -> CargoResult<Vec<(RegistryCrate, u64)>>

Returns all registry crate cache timestamps.

pub fn registry_src_all(&self) -> CargoResult<Vec<(RegistrySrc, u64)>>

Returns all registry source cache timestamps.

pub fn git_db_all(&self) -> CargoResult<Vec<(GitDb, u64)>>

Returns all git db timestamps.

pub fn git_checkout_all(&self) -> CargoResult<Vec<(GitCheckout, u64)>>

Returns all git checkout timestamps.

pub fn should_run_auto_gc(&mut self, frequency: Duration) -> CargoResult<bool>

Returns whether or not an auto GC should be performed, compared to the last time it was recorded in the database.

pub fn set_last_auto_gc(&self) -> CargoResult<()>

Writes to the database to indicate that an automatic GC has just been completed.

pub fn clean( &mut self, clean_ctx: &mut CleanContext<'_>, gc_opts: &GcOpts, ) -> CargoResult<()>

Deletes files from the global cache based on the given options.

fn clean_inner( &mut self, clean_ctx: &mut CleanContext<'_>, gc_opts: &GcOpts, ) -> CargoResult<()>

fn names_from(path: &Path) -> CargoResult<Vec<String>>

Returns a list of directory entries in the given path.

fn sync_db_with_files( conn: &Connection, now: u64, gctx: &GlobalContext, base: &BasePaths, sync_size: bool, delete_paths: &mut Vec<PathBuf>, ) -> CargoResult<()>

Synchronizes the database to match the files on disk.

This performs the following cleanups:

1. Remove entries from the database that are missing on disk.

2. Adds missing entries to the database that are on disk (such as when files are added by older versions of cargo).

3. Fills in the size column where it is NULL (such as when something is added to disk by an older version of cargo, and one of the mark functions marked it without knowing the size).

   Size computations are only done if sync_size is set since it can be a very expensive operation. This should only be set if the user requested to clean based on the cache size.

4. Checks for orphaned files. For example, if there are .crate files associated with an index that does not exist.

   These orphaned files will be added to delete_paths so that the caller can delete them.

fn update_parent_for_missing_from_db( conn: &Connection, now: u64, parent_table_name: &str, base_path: &Path, ) -> CargoResult<()>

For parent tables, add any entries that are on disk but aren’t tracked in the db.

fn update_db_for_removed( conn: &Connection, parent_table_name: &str, id_column_name: &str, table_name: &str, base_path: &Path, ) -> CargoResult<()>

Removes database entries for any files that are not on disk for the child tables.

This could happen for example if the user manually deleted the file or any such scenario where the filesystem and db are out of sync.

fn update_db_parent_for_removed_from_disk( conn: &Connection, parent_table_name: &str, base_path: &Path, child_base_paths: &[&Path], delete_paths: &mut Vec<PathBuf>, ) -> CargoResult<()>

Removes database entries for any files that are not on disk for the parent tables.

fn populate_untracked_crate( conn: &Connection, now: u64, base_path: &Path, ) -> CargoResult<()>

Updates the database to add any .crate files that are currently not tracked (such as when they are downloaded by an older version of cargo).

fn populate_untracked( conn: &Connection, now: u64, gctx: &GlobalContext, id_table_name: &str, id_column_name: &str, table_name: &str, base_path: &Path, populate_size: bool, ) -> CargoResult<()>

Updates the database to add any files that are currently not tracked (such as when they are downloaded by an older version of cargo).

fn update_null_sizes( conn: &Connection, gctx: &GlobalContext, parent_table_name: &str, id_column_name: &str, table_name: &str, base_path: &Path, ) -> CargoResult<()>

Fills in the size column where it is NULL.

This can happen when something is added to disk by an older version of cargo, and one of the mark functions marked it without knowing the size.

update_db_for_removed should be called before this is called.

fn get_registry_items_to_clean_age( conn: &Connection, max_age: u64, table_name: &str, base_path: &Path, delete_paths: &mut Vec<PathBuf>, ) -> CargoResult<()>

Adds paths to delete from either registry_crate or registry_src whose last use is older than the given timestamp.

fn get_registry_items_to_clean_size( conn: &Connection, max_size: u64, table_name: &str, base_path: &Path, delete_paths: &mut Vec<PathBuf>, ) -> CargoResult<()>

Adds paths to delete from either registry_crate or registry_src in order to keep the total size under the given max size.

fn get_registry_items_to_clean_size_both( conn: &Connection, max_size: u64, base: &BasePaths, delete_paths: &mut Vec<PathBuf>, ) -> CargoResult<()>

Adds paths to delete from both registry_crate and registry_src in order to keep the total size under the given max size.

fn get_git_items_to_clean_size( conn: &Connection, max_size: u64, base: &BasePaths, delete_paths: &mut Vec<PathBuf>, ) -> CargoResult<()>

Adds paths to delete from the git cache, keeping the total size under the give value.

Paths are relative to the git directory in the cache directory.

fn get_registry_index_to_clean( conn: &Connection, max_age: u64, base: &BasePaths, delete_paths: &mut Vec<PathBuf>, ) -> CargoResult<()>

Adds paths to delete from registry_index whose last use is older than the given timestamp.

fn get_git_co_items_to_clean( conn: &Connection, max_age: u64, base_path: &Path, delete_paths: &mut Vec<PathBuf>, ) -> CargoResult<()>

Adds paths to delete from git_checkout whose last use is older than the given timestamp.

fn get_git_db_items_to_clean( conn: &Connection, max_age: u64, base: &BasePaths, delete_paths: &mut Vec<PathBuf>, ) -> CargoResult<()>

Adds paths to delete from git_db in order to keep the total size under the given max size.

Trait Implementations

impl Debug for GlobalCacheTracker

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 112 bytes