Struct podman_api::api::Containers

source · [−]

pub struct Containers<'podman> { /* private fields */ }

Expand description

Handle for Podman Containers.

Implementations

source

impl<'podman> Containers<'podman>

source

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

Exports an interface for interacting with Podman Containers.

source

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

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

source

impl<'podman> Containers<'podman>

source

pub async fn create(
&self,
opts: &ContainerCreateOpts
) -> Result<ContainerCreateCreatedBody>

Api Reference

Create a container with specified options.

Examples:

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

    if let Err(e) = podman
        .containers()
        .create(
            &ContainerCreateOpts::builder()
                .image("debian:11")
                .command(
                    ["/usr/bin/httpd"]
                )
                .env([
                    ("app", "web"),
                ])
                .build(),
        )
        .await
    {
        eprintln!("{}", e);
    }
};

source

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

Api Reference

Returns a list of containers.

Examples:

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

    for container in podman
        .containers()
        .list(
            &ContainerListOpts::builder()
                .all(true)
                .filter([ContainerListFilter::LabelKeyVal("app".into(), "web".into())])
                .build(),
        )
        .await
        .unwrap()
    {
        println!("{:?}", container);
    }
};

source

pub async fn stats(
&self,
opts: &ContainerStatsOpts
) -> Result<LibpodContainerStatsResponse>

Api Reference

Return a single resource usage statistics of one or more container. If not container is specified in the options, the statistics of all are returned.

Examples:

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

    match podman.containers().stats(&Default::default()).await {
        Ok(stats) => println!("{:?}", stats),
        Err(e) => eprintln!("{}", e),
    }
};

source

pub fn stats_stream(
&self,
opts: &ContainerStatsOpts
) -> impl Stream<Item = Result<LibpodContainerStatsResponse>> + 'podman

Api Reference

Return a stream of resource usage statistics of one or more container. If not container is specified in the options, the statistics of all are returned.

Examples:

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

    let mut stats = podman
        .containers()
        .stats_stream(&Default::default());

    while let Some(chunk) = stats.next().await {
        match chunk {
            Ok(chunk) => println!("{:?}", chunk),
            Err(e) => eprintln!("{}", e),
        }
    }
};

source

pub async fn list_mounted(&self) -> Result<Value>

Api Reference

List all mounted containers mount points.

Examples:

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

    match podman.containers().list_mounted().await {
        Ok(mounts) => println!("{:?}", mounts),
        Err(e) => eprintln!("{}", e),
    }
};

source

pub async fn prune(
&self,
opts: &ContainerPruneOpts
) -> Result<Vec<ContainersPruneReport>>

Api Reference

Remove containers not in use.

Examples:

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

    match podman.containers().prune(&Default::default()).await {
        Ok(report) => println!("{:?}", report),
        Err(e) => eprintln!("{}", e),
    }
};