Struct podman_api::api::Image

pub struct Image { /* private fields */ }

Interface for accessing and manipulating Podman Image.

Api Reference

Implementations

impl Image

pub fn new(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 Image

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

Api Reference

Obtain low-level information about this image.

Examples:

async {
    use podman_api::Podman;
    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<Vec<HistoryResponse>>

Api Reference

Return parent layers of an image.

Examples:

async {
    use podman_api::Podman;
    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:

async {
    use podman_api::Podman;
    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:

async {
    use podman_api::Podman;
    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:

async {
    use podman_api::Podman;
    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:

async {
    use podman_api::Podman;
    use podman_api::opts::ImageTagOpts;
    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
    {
        eprintln!("{}", e);
    }
};

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:

async {
    use podman_api::Podman;
    use podman_api::opts::ImageTagOpts;
    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
    {
        eprintln!("{}", e);
    }
};

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

Api Reference

Export this image.

Examples:

async {
    use podman_api::Podman;
    use futures_util::stream::TryStreamExt;
    let podman = Podman::unix("/run/user/1000/podman/podman.sock");
    let image = podman.images().get("myimage");

    let export_stream = image.export(&Default::default());
    let export_data = export_stream.try_concat().await.expect("image archive");
    assert!(!export_data.is_empty());
};

pub async fn changes(
    &self,
    opts: &ChangesOpts
) -> Result<Vec<ContainerChangeResponseItem>>

Api Reference

Returns which files in this image’s filesystem have been added, deleted, or modified.

Examples:

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

    match podman
        .images()
        .get("79c93f220e3e")
        .changes(&Default::default())
        .await
    {
        Ok(changes) => println!("{:?}", changes),
        Err(e) => eprintln!("{}", e),
    }
};

pub async fn tree(&self, opts: &ImageTreeOpts) -> Result<TreeResponse>

Api Reference

Retrieve the image tree for this image.

Examples:

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

    match podman
        .images()
        .get("79c93f220e3e")
        .tree(&Default::default())
        .await
    {
        Ok(tree) => println!("{:?}", tree),
        Err(e) => eprintln!("{}", e),
    }
};

pub async fn push(&self, opts: &ImagePushOpts) -> Result<String>

Api Reference

Push this image to a container registry.

Examples:

async {
    use podman_api::Podman;
    use podman_api::opts::{RegistryAuth, ImagePushOpts};
    let podman = Podman::unix("/run/user/1000/podman/podman.sock");

    match podman.images().get("alpine").push(
        &ImagePushOpts::builder()
            .destinations("my-destination")
            .tls_verify(true)
            .auth(
                RegistryAuth::builder()
                    .username("test")
                    .password("test")
                    .server_address("https://my-registry")
                    .build(),
            )
            .build(),
    ).await {
        Ok(s) => println!("{}", s),
        Err(e) => eprintln!("{}", e),
    };
};

Trait Implementations

impl Debug for Image

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

Formats the value using the given formatter.