Struct podman_api::api::Exec

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

Interface for accessing and manipulating Podman Exec.

Api Reference

Implementations

impl<'podman> Exec<'podman>

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

Exports an interface exposing operations against a Exec instance.

pub fn id(&self) -> &Id

A getter for Exec id

impl<'podman> Exec<'podman>

pub fn start(
    &'podman self,
    opts: &'podman ExecStartOpts
) -> impl Stream<Item = Result<TtyChunk>> + 'podman

Api Reference

Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.

To create an exec instance use Container::create_exec.

Examples:

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

    let exec = container
        .create_exec(
            &podman_api::opts::ExecCreateOpts::builder()
                .command(["cat", "/some/path/in/container"])
                .build(),
        )
        .await
        .unwrap();

    let opts = Default::default();
    let mut stream = exec.start(&opts);

    while let Some(chunk) = stream.next().await {
        println!("{:?}", chunk.unwrap());
    }
};

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

Api Reference

Returns low-level information about an exec instance.

Examples:

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

    let exec = container
        .create_exec(
            &podman_api::opts::ExecCreateOpts::builder()
                .command(["cat", "/some/path/in/container"])
                .build(),
        )
        .await
        .unwrap();

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

pub async fn resize(&self, width: usize, heigth: usize) -> Result<()>

Api Reference

Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.

Examples:

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

    let exec = container
        .create_exec(
            &podman_api::opts::ExecCreateOpts::builder()
                .command(["cat", "/some/path/in/container"])
                .build(),
        )
        .await
        .unwrap();

    if let Err(e) = exec.resize(1280, 720).await {
        eprintln!("{}", e);
    }
};

Trait Implementations

impl<'podman> Debug for Exec<'podman>

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

Formats the value using the given formatter.