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_oci_dir(&self) -> &PathBuf

The path to the OCI directory where artifacts like repositories metadata and layers 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_oci_dir(&mut self, val: PathBuf) -> &mut Self

The path to the OCI directory where artifacts like repositories metadata and layers are stored.

impl DockerRegistry

Creates a new instance of DockerRegistry with an HTTP client configured for retrying transient errors. This client is used to interact with the Docker Registry HTTP API.

pub fn new() -> Self

Creates a new DockerRegistry instance with the default artifacts directory (MONOCORE_HOME).

pub fn with_oci_dir(oci_dir: PathBuf) -> Self

Creates a new DockerRegistry instance with a custom base path.

This is useful for testing or when you need to store OCI artifacts in a different location than the default MONOCORE_HOME.

Arguments

• oci_dir - The base path where OCI artifacts will be stored. The OCI directory structure will be created under this path.

Trait Implementations

impl AuthProvider for DockerRegistry

fn get_auth_material<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, repository: &'life1 str, service: &'life2 str, scopes: &'life3 [&'life4 str], ) -> Pin<Box<dyn Future<Output = MonocoreResult<Self::AuthMaterial>> + Send + 'async_trait>>

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

Gets the necessary authentication credentials for the given repository and tag.

Currently, Docker tokens expire after 300 seconds, so we need to re-authenticate after that period or just fetch new tokens on each request.

type AuthMaterial = DockerAuthMaterial

The type of the authentication material.

impl Debug for DockerRegistry

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

Formats the value using the given formatter.

impl Default for DockerRegistry

fn default() -> Self

Returns the “default value” for a type.

impl OciRegistryPull for DockerRegistry

fn pull_image<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, repository: &'life1 str, tag: Option<&'life2 str>, ) -> Pin<Box<dyn Future<Output = MonocoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: '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, 'life2, 'async_trait>( &'life0 self, repository: &'life1 str, tag: Option<&'life2 str>, ) -> Pin<Box<dyn Future<Output = MonocoreResult<ImageIndex>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: '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 = MonocoreResult<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 = MonocoreResult<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 = MonocoreResult<BoxStream<'static, MonocoreResult<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.