Struct Cache 

pub struct Cache<FsT: Fs, KeyT: Key, GetStrategyT: GetStrategy> { /* private fields */ }

Manage a directory of downloaded, extracted artifacts. Coordinate fetching of these artifacts, and removing them when they are no longer in use and the amount of space used by the directory has grown too large.

Implementations

impl<FsT: Fs, KeyT: Key, GetStrategyT: GetStrategy> Cache<FsT, KeyT, GetStrategyT>

pub fn new( fs: FsT, root: RootBuf<CacheDir>, size: CacheSize, log: Logger, log_initial_message_at_info: bool, ) -> Result<(Self, TempFileFactory<FsT>)>

Create a new Cache rooted at root. The directory root and all necessary ancestors will be created, along with {root}/removing and {root}/{kind}/sha256. Any pre-existing entries in {root}/removing and {root}/{kind}/sha256 will be removed. That implies that the Cache doesn’t currently keep data stored across invocations.

bytes_used_target is the goal on-disk size for the cache. The cache will periodically grow larger than this size, but then shrink back down to this size. Ideally, the cache would use this as a hard upper bound, but that’s not how it currently works.

pub fn get_artifact(&mut self, key: KeyT, jid: JobId) -> GetArtifact

Attempt to fetch artifact from the cache. See GetArtifact for the meaning of the return values.

pub fn got_artifact_failure(&mut self, key: &KeyT) -> Vec<JobId>

Notify the cache that an artifact fetch has failed. The returned vector lists the jobs that are affected and that need to be canceled.

pub fn got_artifact_success( &mut self, key: &KeyT, artifact: GotArtifact<FsT>, ) -> Result<Vec<JobId>, (Error, Vec<JobId>)>

Notify the cache that an artifact fetch has successfully completed. The returned vector lists the jobs that are affected, and the path they can use to access the artifact.

pub fn try_increment_ref_count(&mut self, key: &KeyT) -> Option<u64>

Assuming that a reference count is already is already held for the artifact, increment it by one and return the size of the artifact. If no reference count is already held, return None.

pub fn try_get_size(&mut self, key: &KeyT) -> Option<u64>

Assuming that a reference count is already is already held for the artifact, return the size of the artifact, otherwise return None.

pub fn decrement_ref_count(&mut self, key: &KeyT)

Notify the cache that a reference to an artifact is no longer needed.

pub fn getter_disconnected(&mut self, getter: GetStrategyT::Getter)

pub fn root(&self) -> &Root<CacheDir>

pub fn cache_path(&self, key: &KeyT) -> RootBuf<EntryPath>

Return the directory path for the artifact referenced by digest.