Struct podman_api::api::Pods

source · [−]

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

Expand description

Handle for Podman Pods.

Implementations

source

impl<'podman> Pods<'podman>

source

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

Exports an interface for interacting with Podman Pods.

source

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

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

source

impl<'podman> Pods<'podman>

source

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

Api Reference

Returns a list of pods.

Examples:

async {
    use podman_api::Podman;
    use podman_api::opts::{PodListOpts, PodListFilter};
    use podman_api::models::PodStatus;
    let podman = Podman::unix("/run/user/1000/podman/podman.sock");

    for pod in podman
        .pods()
        .list(
            &PodListOpts::builder()
                .filter([PodListFilter::Status(PodStatus::Degraded)])
                .build(),
        )
        .await
        .unwrap()
    {
        println!("{:?}", pod);
    }
};

source

pub async fn prune(&self) -> Result<Vec<PodPruneReport>>

Api Reference

Returns a list of pods.

Examples:

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

    match podman.pods().prune().await {
        Ok(info) => println!("{:?}", info),
        Err(e) => eprintln!("{}", e),
    }
};

source

pub fn stats(
&self,
opts: &PodStatsOpts
) -> impl Stream<Item = Result<LibpodPodTopResponse>> + Unpin + 'podman

Api Reference

Display a live stream of resource usage statistics for the containers in one or more pods.

Examples:

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

    let mut stream = podman.pods().stats(&PodStatsOpts::builder().all(true).build());
    while let Some(chunk) = stream.next().await {
        match chunk{
            Ok(chunk) => println!("{:?}", chunk),
            Err(e) => eprintln!("{}", e),
        }
    }
};

source

pub async fn create(&self, opts: &PodCreateOpts) -> Result<Pod<'_>>

Api Reference

Create a container with specified options.

Examples:

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

    match podman
        .pods()
        .create(&PodCreateOpts::builder().name("my-pod").build())
        .await
    {
        Ok(pod) => { /* do something with the pod */ }
        Err(e) => eprintln!("{}", e),
    }
};