Struct podman_api::api::Images

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

Handle for Podman Images.

Implementations

impl<'podman> Images<'podman>

pub fn new(podman: &'podman Podman) -> Self

Exports an interface for interacting with Podman Images.

pub fn get(&self, id: impl Into<Id>) -> Image<'podman>

Returns a reference to a set of operations available to a specific Image.

impl<'podman> Images<'podman>

pub async fn build(
    &self,
    opts: &ImageBuildOpts
) -> Result<LibpodImageBuildResponse>

Api Reference

Build an image from the given Dockerfile(s)

Examples:

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

if let Err(e) = podman
    .images()
    .create(
        &ImageBuildOpts::builder()
            .remote("http://some.url.to/Dockerfile")
            .tag("myimage:1.0.0")
            .build(),
    )
    .await
{
    eprintln!("{}", e);
}

pub async fn list(
    &self,
    opts: &ImageListOpts
) -> Result<Vec<LibpodImageSummary>>

Api Reference

Returns a list of images.

Examples:

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

for image in podman
    .images()
    .list(
        &ImageListOpts::builder()
            .all(true)
            .filter([ImageListFilter::Dangling(true)])
            .build(),
    )
    .await
    .unwrap()
{
    println!("{:?}", image);
}

pub async fn pull(&self, opts: &PullOpts) -> Result<LibpodImagesPullReport>

Api Reference

Pull one or more images from a container registry.

Examples:

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

if let Err(e) = podman
    .images()
    .pull(
        &PullOpts::builder()
            .reference("rockylinux/rockylinux:8")
            .build(),
    )
    .await
{
    eprintln!("{}", e);
}

pub async fn load(&self, image: impl AsRef<[u8]>) -> Result<ImageLoadReport>

Api Reference

Load an image (oci-archive or docker-archive) stream.

Examples:

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

let image = std::fs::read("image_archive")?;

match podman.images().load(&image).await {
    Ok(info) => println!("{:?}", info),
    Err(e) => eprintln!("{}", e),
}

pub async fn import(
    &self,
    opts: &ImageImportOpts,
    image: impl AsRef<[u8]>
) -> Result<LibpodImagesPullReport>

Api Reference

Import a previously exported tarball as an image.

Examples:

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

if let Err(e) = podman
    .images()
    .pull(
        &PullOpts::builder()
            .reference("rockylinux/rockylinux:8")
            .build(),
    )
    .await
{
    eprintln!("{}", e);
}

Trait Implementations

impl<'podman> Debug for Images<'podman>

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

Formats the value using the given formatter.