Struct podman_api::api::Image

pub struct Image<'podman> { /* fields omitted */ }

Interface for accessing and manipulating Podman Image.

Api Reference

Implementations

impl<'podman> Image<'podman>

pub fn new(podman: &'podman Podman, id: impl Into<Id>) -> Self

Exports an interface exposing operations against a Image instance.

pub fn id(&self) -> &Id

A getter for Image id

impl<'podman> Image<'podman>

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

Api Reference

Obtain low-level information about this image.

Examples:

let podman = Podman::unix("/run/user/1000/podman/podman.sock");

match podman.images().get("debian").inspect().await {
    Ok(info) => println!("{:?}", info),
    Err(e) => eprintln!("{}", e),
}

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

Api Reference

Return parent layers of an image.

Examples:

let podman = Podman::unix("/run/user/1000/podman/podman.sock");

match podman.images().get("debian").history().await {
    Ok(info) => println!("{:?}", info),
    Err(e) => eprintln!("{}", e),
}

pub async fn exists(&self) -> Result<bool>

Api Reference

Quick way to determine if a image exists by name or ID.

Examples:

let podman = Podman::unix("/run/user/1000/podman/podman.sock");

match podman.images().get("debian").exists().await {
    Ok(exists) => if exists {
        println!("image exists!");
    } else {
        println!("image doesn't exists!");
    },
    Err(e) => eprintln!("check failed: {}", e),
}

pub async fn delete(&self) -> Result<()>

Api Reference

Delete this image from local storage. To forcefully remove an image use Image::remove.

Examples:

let podman = Podman::unix("/run/user/1000/podman/podman.sock");

if let Err(e) = podman.images().get("debian").delete().await
    eprintln!("{}", e);
}

pub async fn remove(&self) -> Result<()>

Api Reference

Remove this image forcefully from local storage. To remove the image normally use Image::delete.

Examples:

let podman = Podman::unix("/run/user/1000/podman/podman.sock");

if let Err(e) = podman.images().get("debian").remove().await
    eprintln!("{}", e);
}

pub async fn tag(&self, opts: &ImageTagOpts) -> Result<()>

Api Reference

Tag an image so that it becomes part of a repository.

Examples:

let podman = Podman::unix("/run/user/1000/podman/podman.sock");

if let Err(e) = podman
    .images()
    .get("debian")
    .tag(
        &ImageTagOpts::builder()
            .repo("my.custom.repo/debian")
            .tag("1.0.0")
            .build(),
    )
    .await
    .unwrap()
{
    println!("{:?}", image);
}

pub async fn untag(&self, opts: &ImageTagOpts) -> Result<()>

Api Reference

Untag an image. If repo and tag are not specified, all tags are removed from the image.

Examples:

let podman = Podman::unix("/run/user/1000/podman/podman.sock");

if let Err(e) = podman
    .images()
    .get("debian")
    .untag(
        &ImageTagOpts::builder()
            .repo("my.custom.repo/debian")
            .tag("1.0.0")
            .build(),
    )
    .await
    .unwrap()
{
    println!("{:?}", image);
}

pub fn export(
    &self,
    opts: &ImageExportOpts
) -> impl Stream<Item = Result<Vec<u8>>> + Unpin + 'podman

Api Reference

Export this image.

Trait Implementations

impl<'podman> Debug for Image<'podman>

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

Formats the value using the given formatter.