Struct DockerRegistry

pub struct DockerRegistry { /* private fields */ }

DockerRegistry is a client for interacting with Docker’s Registry HTTP API v2. It handles authentication, image manifest retrieval, and blob fetching.

See OCI distribution specification for more details on the manifest schema

See Docker Registry API for more details on the API

Implementations

impl DockerRegistry

pub fn get_client(&self) -> &ClientWithMiddleware

The HTTP client used to make requests to the Docker registry.

pub fn get_layer_download_dir(&self) -> &PathBuf

The directory where image layers are downloaded.

pub fn get_oci_db(&self) -> &Pool<Sqlite>

The database where image configurations, indexes, and manifests are stored.

impl DockerRegistry

pub fn set_client(&mut self, val: ClientWithMiddleware) -> &mut Self

The HTTP client used to make requests to the Docker registry.

pub fn set_layer_download_dir(&mut self, val: PathBuf) -> &mut Self

The directory where image layers are downloaded.

pub fn set_oci_db(&mut self, val: Pool<Sqlite>) -> &mut Self

The database where image configurations, indexes, and manifests are stored.

impl DockerRegistry

pub async fn new( layer_download_dir: impl Into<PathBuf>, oci_db_path: impl AsRef<Path>, ) -> MicrosandboxResult<Self>

Creates a new Docker Registry client with the specified image download path and OCI database path.

Arguments

• layer_download_dir - The directory where downloaded image layers will be stored
• oci_db_path - The path to the SQLite database that stores OCI-related metadata

pub async fn download_image_blob( &self, repository: &str, digest: &Digest, download_size: u64, ) -> MicrosandboxResult<bool>

Downloads a blob from the registry, supports download resumption if the file already partially exists.

Returns a tuple (MicrosandboxResult<()>, bool) where the boolean indicates whether a download actually occurred (true) or was skipped because the file already exists (false).

Trait Implementations

impl Debug for DockerRegistry

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

Formats the value using the given formatter.

impl OciRegistryPull for DockerRegistry

fn pull_image<'life0, 'life1, 'async_trait>( &'life0 self, repository: &'life1 str, selector: ReferenceSelector, ) -> Pin<Box<dyn Future<Output = MicrosandboxResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Pulls an OCI image from the specified repository. This includes downloading the image manifest, fetching the image configuration, and downloading the image layers.

fn fetch_index<'life0, 'life1, 'async_trait>( &'life0 self, repository: &'life1 str, selector: ReferenceSelector, ) -> Pin<Box<dyn Future<Output = MicrosandboxResult<ImageIndex>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetches the image index (manifest list) for multi-platform support. Retrieves the appropriate manifest for the target platform.

fn fetch_manifest<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, repository: &'life1 str, digest: &'life2 Digest, ) -> Pin<Box<dyn Future<Output = MicrosandboxResult<ImageManifest>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetches an image manifest by digest. Provides the list of layers and configurations for an image.

fn fetch_config<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, repository: &'life1 str, digest: &'life2 Digest, ) -> Pin<Box<dyn Future<Output = MicrosandboxResult<ImageConfiguration>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetches the image configuration by digest. Returns metadata about the image, such as environment variables and entrypoint.

fn fetch_image_blob<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, repository: &'life1 str, digest: &'life2 Digest, range: impl 'async_trait + RangeBounds<u64> + Send, ) -> Pin<Box<dyn Future<Output = MicrosandboxResult<BoxStream<'static, MicrosandboxResult<Bytes>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetches a image blob from the registry by its digest. This method returns a stream for efficient processing of large blobs.