Struct podman_api::api::Pod

pub struct Pod { /* private fields */ }

Interface for accessing and manipulating Podman Pod.

Api Reference

Implementations

impl Pod

pub fn new(podman: Podman, id: impl Into<Id>) -> Self

Exports an interface exposing operations against a Pod instance.

pub fn id(&self) -> &Id

A getter for Pod id

impl Pod

pub async fn start(&self) -> Result<PodStartReport>

Api Reference

Start this pod.

Parameters:

• detach_keys - Override the key sequence for detaching a pod. Format is a single character [a-Z] or ctrl- where is one of: a-z, @, ^, [, , or _.

Examples:

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

    if let Err(e) = podman.pods().get("79c93f220e3e").start().await {
        eprintln!("{}", e);
    }
};

pub async fn stop(&self) -> Result<PodStopReport>

Api Reference

Stop this pod.

Examples:

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

    if let Err(e) = podman.pods().get("79c93f220e3e").stop().await {
        eprintln!("{}", e);
    }
};

pub async fn stop_with_timeout(&self, t: usize) -> Result<PodStopReport>

Api Reference

Stop this pod with a timeout.

Examples:

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

    if let Err(e) = podman.pods().get("79c93f220e3e").stop_with_timeout(10).await {
        eprintln!("{}", e);
    }
};

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

Api Reference

Return low-level information about this pod.

Examples:

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

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

pub async fn send_signal(
    &self,
    signal: impl Into<String>
) -> Result<PodKillReport>

Api Reference

Send a signal to this pod.

Examples:

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

    if let Err(e) = podman.pods().get("79c93f220e3e").send_signal("SIGINT").await {
        eprintln!("{}", e);
    }
};

pub async fn kill(&self) -> Result<PodKillReport>

Api Reference

Kill this pod.

Examples:

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

    if let Err(e) = podman.pods().get("79c93f220e3e").kill().await {
        eprintln!("{}", e);
    }
};

pub async fn pause(&self) -> Result<PodPauseReport>

Api Reference

Pause this pod.

Examples:

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

    if let Err(e) = podman.pods().get("79c93f220e3e").pause().await {
        eprintln!("{}", e);
    }
};

pub async fn unpause(&self) -> Result<PodUnpauseReport>

Api Reference

Unpause this pod

Examples:

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

    if let Err(e) = podman.pods().get("79c93f220e3e").unpause().await {
        eprintln!("{}", e);
    }
};

pub async fn restart(&self) -> Result<PodRestartReport>

Api Reference

Restart this pod.

Examples:

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

    if let Err(e) = podman.pods().get("79c93f220e3e").restart().await {
        eprintln!("{}", e);
    }
};

pub async fn delete(&self) -> Result<PodRmReport>

Api Reference

Delete this pod.

Examples:

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

    if let Err(e) = podman.pods().get("79c93f220e3e").delete().await {
        eprintln!("{}", e);
    }
};

pub async fn remove(&self) -> Result<PodRmReport>

Api Reference

Force remove this pod.

Examples:

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

    if let Err(e) = podman.pods().get("79c93f220e3e").remove().await {
        eprintln!("{}", e);
    }
};

pub async fn exists(&self) -> Result<bool>

Api Reference

Quick way to determine if a pod exists by name or ID.

Examples:

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

    match podman.pods().get("79c93f220e3e").exists().await {
        Ok(exists) => if exists {
            println!("pod exists!");
        } else {
            println!("pod doesn't exists!");
        },
        Err(e) => eprintln!("check failed: {}", e),
    }
};

pub async fn top(&self, opts: &PodTopOpts) -> Result<PodTopResponse>

Api Reference

List processes inside this pod.

Examples:

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

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

pub fn top_stream(
    &self,
    opts: &PodTopOpts
) -> impl Stream<Item = Result<PodTopResponse>> + Unpin + '_

Api Reference

List processes inside this pod.

Only supported as of version > 4.0

Examples:

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

    let pod = podman.pods().get("79c93f220e3e");
    let mut stream = pod.top_stream(&Default::default());
    while let Some(chunk) = stream.next().await {
        match chunk{
            Ok(chunk) => println!("{:?}", chunk),
            Err(e) => eprintln!("{}", e),
        }
    }
};

pub async fn generate_systemd_units(
    &self,
    opts: &SystemdUnitsOpts
) -> Result<Value>

Api Reference

Generate Systemd Units based on this pod.

Examples:

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

    match podman
        .pods()
        .get("ea03584c0fd6")
        .generate_systemd_units(&Default::default())
        .await
    {
        Ok(info) => println!("{:?}", info),
        Err(e) => eprintln!("{}", e),
    }
};

pub async fn generate_kube_yaml(&self, service: bool) -> Result<String>

Api Reference

Generate Kubernetes YAML based on this pod

Parameters:

• service - Generate YAML for a Kubernetes service object.

Examples:

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

    match podman
        .pods()
        .get("fc93f220e3e")
        .generate_kube_yaml(false)
        .await
    {
        Ok(yaml) => println!("{:?}", yaml),
        Err(e) => eprintln!("{}", e),
    }
};

Trait Implementations

impl Debug for Pod

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

Formats the value using the given formatter.