Struct ArtifactCache 

pub struct ArtifactCache { /* private fields */ }

Budgeted, pin-aware view of the verified artifacts of one exchange.

Implementations

impl ArtifactCache

pub fn new(ex: Arc<ArtifactExchange>, cfg: CacheConfig) -> Arc<Self>

Cache over ex. The exchange reports every artifact that becomes verified (seeded or fetched) to the cache, and the cache enforces the budget as they arrive. Artifacts already verified are admitted.

pub fn exchange(&self) -> &Arc<ArtifactExchange>

The exchange this cache accounts.

pub fn admit(&self, id: &ArtifactId) -> Result<Vec<ArtifactId>, CacheError>

Account for verified artifact id and enforce the budget. Returns the artifacts evicted to make room. An unpinned artifact larger than the whole budget is evicted again and reported as an error.

pub fn touch(&self, id: &ArtifactId)

Mark id as just used.

pub fn pin(&self, id: &ArtifactId) -> bool

Protect id from eviction. False if it is not in the cache.

pub fn unpin(&self, id: &ArtifactId) -> bool

Make id evictable again, then enforce the budget (it may go now).

pub fn pin_content(&self, content_hash: [u8; 32])

Pin whatever has this content hash, now or the moment it arrives. A fetch admits an artifact as soon as it verifies, so a caller about to run a package pins its hashes first, or an over-budget cache could evict the artifact before the caller can pin it.

pub fn unpin_content(&self, content_hash: &[u8; 32])

Undo Self::pin_content and make matching entries evictable again.

pub fn pin_package(&self, pkg: &ExchangedPackage)

Pin a package’s manifest and every file it lists.

pub fn unpin_package(&self, pkg: &ExchangedPackage)

Make a package’s manifest and files evictable again (it was removed).

pub fn is_pinned(&self, id: &ArtifactId) -> bool

True if id is pinned.

pub fn set_kind(&self, id: &ArtifactId, kind: ArtifactKind) -> bool

Set what id is (for model.present).

pub fn remove(&self, id: &ArtifactId) -> Result<(), CacheError>

Evict id now. Pinned entries are refused.

pub fn enforce(&self) -> Vec<ArtifactId>

Evict least-recently-used unpinned entries until the total fits the budget. Returns the evicted ids, oldest first.

pub fn used_bytes(&self) -> u64

Bytes accounted: verified entries plus downloads in progress.

pub fn over_budget(&self) -> u64

Bytes over the budget (only pins and downloads in progress can cause this).

pub fn entries(&self) -> Vec<CacheEntryInfo>

Entries, least recently used first.

pub fn advertise(&self, facts: &mut NodeFacts)

Merge what this node can serve into facts as capabilities (store.artifact.*, model.present), replacing any older ones.