Struct Registry 

pub struct Registry<'a> { /* private fields */ }

Registry operations

Implementations

impl<'a> Registry<'a>

pub async fn login(&self, config: &RegistryConfig) -> Result<()>

Authenticate with a registry

This is typically not needed for public pulls, but required for:

• Pushing images
• Pulling private images
• Accessing registries with rate limits

pub async fn search( &self, term: &str, limit: Option<i64>, ) -> Result<Vec<ImageSearchResult>>

Search for images in a registry

Arguments

• term - Search term
• limit - Maximum number of results (default: 25)

Example

let client = DockerClient::new()?;
let results = client.registry().search("nginx", Some(10)).await?;
for result in results {
    println!("{}: {}", result.name, result.description.unwrap_or_default());
}

pub async fn image_exists_locally(&self, image: &str) -> Result<bool>

Check if an image exists in the local registry cache

pub async fn list_local_images(&self, all: bool) -> Result<Vec<ImageSummary>>

List all local images

pub async fn inspect_image(&self, image: &str) -> Result<ImageInspect>

Get detailed information about a local image

pub async fn remove_image( &self, image: &str, force: bool, noprune: bool, ) -> Result<()>

Remove an image from local cache

Arguments

• image - Image name or ID
• force - Force removal even if image is in use
• noprune - Do not delete untagged parents

pub async fn tag_image( &self, source: &str, target_repo: &str, target_tag: Option<&str>, ) -> Result<()>

Tag an image with a new name/tag

Arguments

• source - Source image name
• target_repo - Target repository name
• target_tag - Target tag (default: “latest”)

pub async fn prune_images(&self, dangling_only: bool) -> Result<u64>

Prune unused images

Arguments

• dangling_only - Only remove dangling images (untagged)

Returns

Number of bytes reclaimed

pub async fn export_image(&self, image: &str) -> Result<Vec<u8>>

Export an image to a tar archive

pub async fn import_image( &self, tar_data: Vec<u8>, tag: Option<&str>, ) -> Result<String>

Import an image from a tar archive