Struct ImageRef 

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

Reference to a specific image.

Implementations

impl<'a> ImageRef<'a>

pub fn name(&self) -> &str

Get the image name.

pub async fn inspect(&self) -> Result<ImageInspect>

Inspect the image to get detailed information.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    let info = client.images().get("nginx:latest").inspect().await?;
    println!("Image ID: {:?}", info.id);
    Ok(())
}

pub async fn history(&self) -> Result<Vec<HistoryResponseItem>>

Get the history of the image (layer information).

pub async fn tag(&self, new_tag: impl Into<String>) -> Result<()>

Tag the image with a new name/tag.

Example

use docker_client::DockerClient;

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

pub async fn push(&self, credentials: Option<DockerCredentials>) -> Result<()>

Push the image to a registry.

Arguments

• 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()
        .get("myregistry.com/my-app:v1.0")
        .push(None)
        .await?;
    Ok(())
}

pub async fn remove( &self, force: bool, noprune: bool, ) -> Result<Vec<ImageDeleteResponseItem>>

Remove the image.

Arguments

• force - Force removal even if image is in use
• noprune - Do not delete untagged parent images

pub async fn export(&self) -> Result<Vec<u8>>

Export the image as a tar archive.