Struct podman_api::api::Pods

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

Handle for Podman Pods.

Implementations

impl<'podman> Pods<'podman>

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

Exports an interface for interacting with Podman Pods.

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

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

impl<'podman> Pods<'podman>

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

Api Reference

Returns a list of pods.

Examples:

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);
}

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

Api Reference

Returns a list of pods.

Examples:

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

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

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

Api Reference

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

Examples:

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

let 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);
    }
}

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

Api Reference

Create a container with specified options.

Examples:

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

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

Trait Implementations

impl<'podman> Debug for Pods<'podman>

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

Formats the value using the given formatter.