pub struct GlobalCache { /* private fields */ }Expand description
On-disk global cache for OCI layers and EROFS images.
Layout:
~/.microsandbox/cache/manifests/<sha256-of-ref>.json # manifest + config metadata
~/.microsandbox/cache/tmp/<blob>.part # partial downloads
~/.microsandbox/cache/tmp/<blob>.download.lock # download flock files
~/.microsandbox/cache/tmp/<blob>.work/ # materialization work dirs
~/.microsandbox/cache/layers/<diff_id_safe>.erofs # per-layer EROFS
~/.microsandbox/cache/layers/<diff_id_safe>.erofs.lock # materialization flock
~/.microsandbox/cache/fsmeta/<manifest_safe>.erofs # fsmeta EROFS (fsmerge metadata)
~/.microsandbox/cache/fsmeta/<manifest_safe>.erofs.lock # materialization flock
~/.microsandbox/cache/vmdk/<manifest_safe>.vmdk # VMDK descriptor
~/.microsandbox/cache/vmdk/<manifest_safe>.vmdk.lock # materialization flockImplementations§
Source§impl GlobalCache
impl GlobalCache
Sourcepub fn new(cache_dir: &Path) -> ImageResult<Self>
pub fn new(cache_dir: &Path) -> ImageResult<Self>
Create a new GlobalCache using the provided cache directory.
Creates all subdirectories if they don’t exist.
Sourcepub async fn new_async(cache_dir: &Path) -> ImageResult<Self>
pub async fn new_async(cache_dir: &Path) -> ImageResult<Self>
Create a new GlobalCache using async filesystem operations.
Sourcepub fn layers_dir(&self) -> &Path
pub fn layers_dir(&self) -> &Path
Root layer EROFS cache directory.
Sourcepub fn layer_erofs_path(&self, diff_id: &Digest) -> PathBuf
pub fn layer_erofs_path(&self, diff_id: &Digest) -> PathBuf
Path to the per-layer EROFS image for a given diff_id.
Sourcepub fn layer_erofs_lock_path(&self, diff_id: &Digest) -> PathBuf
pub fn layer_erofs_lock_path(&self, diff_id: &Digest) -> PathBuf
Path to the materialization lock for a layer EROFS image.
Sourcepub fn is_layer_materialized(&self, diff_id: &Digest) -> bool
pub fn is_layer_materialized(&self, diff_id: &Digest) -> bool
Check if a layer EROFS image exists.
Sourcepub fn all_layers_materialized(&self, diff_ids: &[Digest]) -> bool
pub fn all_layers_materialized(&self, diff_ids: &[Digest]) -> bool
Check if all given layer diff_ids have materialized EROFS images.
Sourcepub fn fsmeta_dir(&self) -> &Path
pub fn fsmeta_dir(&self) -> &Path
Root fsmeta EROFS cache directory.
Sourcepub fn fsmeta_erofs_path(&self, manifest_digest: &Digest) -> PathBuf
pub fn fsmeta_erofs_path(&self, manifest_digest: &Digest) -> PathBuf
Path to the fsmeta EROFS image for a given manifest digest.
Sourcepub fn fsmeta_erofs_lock_path(&self, manifest_digest: &Digest) -> PathBuf
pub fn fsmeta_erofs_lock_path(&self, manifest_digest: &Digest) -> PathBuf
Path to the materialization lock for a fsmeta EROFS image.
Sourcepub fn is_fsmeta_materialized(&self, manifest_digest: &Digest) -> bool
pub fn is_fsmeta_materialized(&self, manifest_digest: &Digest) -> bool
Check if a fsmeta EROFS image exists.
Sourcepub fn vmdk_path(&self, manifest_digest: &Digest) -> PathBuf
pub fn vmdk_path(&self, manifest_digest: &Digest) -> PathBuf
Path to the VMDK descriptor for a given manifest digest.
Sourcepub fn vmdk_lock_path(&self, manifest_digest: &Digest) -> PathBuf
pub fn vmdk_lock_path(&self, manifest_digest: &Digest) -> PathBuf
Path to the materialization lock for a VMDK descriptor.
Sourcepub fn is_vmdk_materialized(&self, manifest_digest: &Digest) -> bool
pub fn is_vmdk_materialized(&self, manifest_digest: &Digest) -> bool
Check if a VMDK descriptor exists for a given manifest digest.
Sourcepub fn flat_ref_path(&self, manifest_digest: &Digest) -> PathBuf
pub fn flat_ref_path(&self, manifest_digest: &Digest) -> PathBuf
Path to the manifest-keyed flat rootfs reference.
Sourcepub fn flat_blob_path(&self, artifact_digest: &Digest) -> PathBuf
pub fn flat_blob_path(&self, artifact_digest: &Digest) -> PathBuf
Path to the immutable content-addressed raw ext4 artifact.
Sourcepub fn flat_lock_path(&self, derivation_digest: &Digest) -> PathBuf
pub fn flat_lock_path(&self, derivation_digest: &Digest) -> PathBuf
Path to the per-derivation flat materialization lock.
Sourcepub fn flat_work_dir(&self, derivation_digest: &Digest) -> PathBuf
pub fn flat_work_dir(&self, derivation_digest: &Digest) -> PathBuf
Same-filesystem work directory for one flat-rootfs derivation.
Sourcepub fn publish_flat_blob(
&self,
candidate: &Path,
artifact_digest: &Digest,
expected_size: u64,
) -> ImageResult<PathBuf>
pub fn publish_flat_blob( &self, candidate: &Path, artifact_digest: &Digest, expected_size: u64, ) -> ImageResult<PathBuf>
Publish a synchronized candidate as an immutable content-addressed blob.
Sourcepub fn read_flat_ref(
&self,
manifest_digest: &Digest,
) -> ImageResult<Option<FlatRootfsRef>>
pub fn read_flat_ref( &self, manifest_digest: &Digest, ) -> ImageResult<Option<FlatRootfsRef>>
Read and validate the manifest-keyed flat rootfs reference.
Sourcepub fn write_flat_ref(
&self,
manifest_digest: &Digest,
reference: &FlatRootfsRef,
) -> ImageResult<()>
pub fn write_flat_ref( &self, manifest_digest: &Digest, reference: &FlatRootfsRef, ) -> ImageResult<()>
Atomically replace a flat rootfs reference after its immutable blob is durable.
Sourcepub fn part_path(&self, blob_digest: &Digest) -> PathBuf
pub fn part_path(&self, blob_digest: &Digest) -> PathBuf
Path to the partial download file for a blob.
Sourcepub fn download_lock_path(&self, blob_digest: &Digest) -> PathBuf
pub fn download_lock_path(&self, blob_digest: &Digest) -> PathBuf
Path to the download lock file for a blob.
Sourcepub fn work_dir(&self, key: &Digest) -> PathBuf
pub fn work_dir(&self, key: &Digest) -> PathBuf
Path to the materialization work directory for an EROFS build.
Sourcepub fn manifests_dir(&self) -> &Path
pub fn manifests_dir(&self) -> &Path
Root manifest metadata directory.
Sourcepub fn image_lock_path(&self, reference: &Reference) -> PathBuf
pub fn image_lock_path(&self, reference: &Reference) -> PathBuf
Path to the pull lock file for an image reference.
Sourcepub fn read_image_metadata(
&self,
reference: &Reference,
) -> ImageResult<Option<CachedImageMetadata>>
pub fn read_image_metadata( &self, reference: &Reference, ) -> ImageResult<Option<CachedImageMetadata>>
Read cached metadata for an image reference.
Sourcepub async fn read_image_metadata_async(
&self,
reference: &Reference,
) -> ImageResult<Option<CachedImageMetadata>>
pub async fn read_image_metadata_async( &self, reference: &Reference, ) -> ImageResult<Option<CachedImageMetadata>>
Read cached metadata for an image reference using async filesystem I/O.
Sourcepub async fn write_image_metadata_async(
&self,
reference: &Reference,
metadata: &CachedImageMetadata,
) -> ImageResult<()>
pub async fn write_image_metadata_async( &self, reference: &Reference, metadata: &CachedImageMetadata, ) -> ImageResult<()>
Write cached metadata for an image reference using async filesystem I/O.
Sourcepub fn delete_image_metadata(&self, reference: &Reference) -> ImageResult<()>
pub fn delete_image_metadata(&self, reference: &Reference) -> ImageResult<()>
Delete cached metadata for an image reference.
Sourcepub async fn delete_image_metadata_async(
&self,
reference: &Reference,
) -> ImageResult<()>
pub async fn delete_image_metadata_async( &self, reference: &Reference, ) -> ImageResult<()>
Delete cached metadata for an image reference using async filesystem I/O.
Sourcepub fn image_metadata_path(&self, reference: &Reference) -> PathBuf
pub fn image_metadata_path(&self, reference: &Reference) -> PathBuf
Path to the cached metadata file for an image reference.
Trait Implementations§
Source§impl Clone for GlobalCache
impl Clone for GlobalCache
Source§fn clone(&self) -> GlobalCache
fn clone(&self) -> GlobalCache
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more