Struct Images 

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

Image operations manager.

Implementations

impl<'a> Images<'a>

pub fn build(&self, tag: impl Into<String>) -> ImageBuilder<'a>

Create a new image builder for building images.

Example

use docker_client::DockerClient;
use std::path::Path;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;

    client.images()
        .build("my-app:latest")
        .dockerfile("Dockerfile")
        .context(Path::new("."))
        .build_arg("RUNTIME_IMAGE", "alpine:latest")
        .execute()
        .await?;

    Ok(())
}

pub fn get(&self, name_or_id: impl Into<String>) -> ImageRef<'a>

Get a reference to a specific image.

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

List all images.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    let images = client.images().list(true).await?;
    for image in images {
        println!("{:?}", image.repo_tags);
    }
    Ok(())
}

pub async fn pull( &self, image: impl Into<String>, credentials: Option<DockerCredentials>, ) -> Result<()>

Pull an image from a registry.

Arguments

• image - Image name with optional tag (e.g., “nginx:latest”)
• credentials - Optional Docker registry credentials

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    client.images().pull("nginx:latest", None).await?;
    Ok(())
}

pub async fn search( &self, term: impl Into<String>, limit: Option<i64>, ) -> Result<Vec<ImageSearchResponseItem>>

Search for images in a registry.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    let results = client.images().search("nginx", None).await?;
    for result in results {
        println!("{}: {}", result.name, result.description);
    }
    Ok(())
}

pub async fn prune(&self, dangling_only: bool) -> Result<ImagePruneResponse>

Prune unused images.

Arguments

• dangling_only - If true, only remove dangling images (untagged)