Struct podman_api::api::Container

source · [−]

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

Expand description

Interface for accessing and manipulating Podman Container.

Api Reference

Implementations

source

impl<'podman> Container<'podman>

source

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

Exports an interface exposing operations against a Container instance.

source

pub fn id(&self) -> &Id

A getter for Container id

source

impl<'podman> Container<'podman>

source

pub async fn start(&self, detach_keys: Option<String>) -> Result<()>

Api Reference

Start this container.

Parameters:

detach_keys - Override the key sequence for detaching a container. 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.containers().get("79c93f220e3e").start(None).await {
        eprintln!("{}", e);
    }
};

source

pub async fn stop(&self, opts: &ContainerStopOpts) -> Result<()>

Api Reference

Stop this container.

Examples:

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

    if let Err(e) = podman.containers().get("79c93f220e3e").stop(&Default::default()).await {
        eprintln!("{}", e);
    }
};

source

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

Api Reference

Return low-level information about this container.

Examples:

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

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

source

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

Api Reference

Send a signal to this container.

Examples:

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

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

source

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

Api Reference

Kill this container.

Examples:

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

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

source

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

Api Reference

Use the cgroups freezer to suspend all processes in this container.

Examples:

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

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

source

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

Api Reference

Unpause this container

Examples:

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

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

source

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

Api Reference

Restart this container with a timeout.

Parameters:

t - number of seconds to wait before killing the container

Examples:

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

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

source

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

Api Reference

Restart this container.

Examples:

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

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

source

pub async fn delete(&self, opts: &ContainerDeleteOpts) -> Result<()>

Api Reference

Delete this container.

Examples:

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

    if let Err(e) = podman
        .containers()
        .get("79c93f220e3e")
        .delete(&ContainerDeleteOpts::builder().volumes(true).build())
        .await
    {
        eprintln!("{}", e);
    }
};

source

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

Api Reference

Force remove this container.

Examples:

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

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

source

pub async fn mount(&self) -> Result<Id>

Api Reference

Mount this container to the filesystem.

Examples:

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

    match podman.containers().get("79c93f220e3e").mount().await {
        Ok(id) => println!("mounted container {}", id),
        Err(e) => eprintln!("{}", e),
    }
};

source

pub async fn unmount(&self) -> Result<()>

Api Reference

Unmount this container from the filesystem.

Examples:

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

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

source

pub fn checkpoint(
&self,
opts: &ContainerCheckpointOpts
) -> impl Stream<Item = Result<Vec<u8>>> + Unpin + 'podman

Api Reference

Checkpoint this container.

Examples:

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

    let mut container_stream = podman.containers().get("79c93f220e3e").checkpoint(
        &ContainerCheckpointOpts::builder()
            .leave_running(true)
            .print_stats(true)
            .build(),
    );

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

source

pub async fn commit(&self, opts: &ContainerCommitOpts) -> Result<()>

Api Reference

Create a new image from this container.

Examples:

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

    if let Err(e) = podman
        .containers()
        .get("79c93f220e3e")
        .commit(
            &ContainerCommitOpts::builder()
                .pause(true)
                .repo("image-name")
                .tag("1.0.0")
                .build(),
        )
        .await
    {
        eprintln!("{}", e);
    }
};

source

pub async fn create_exec(&self, opts: &ExecCreateOpts) -> Result<Exec<'_>>

Api Reference

Create an exec session to run a command inside this container. Exec sessions will be automatically removed 5 minutes after they exit.

This endpoint only creates the exec. To start it use Exec::start.

Examples:

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

    let exec = podman
    .containers()
    .get("79c93f220e3e")
    .create_exec(
        &podman_api::opts::ExecCreateOpts::builder()
            .command(["cat", "/some/path/in/container"])
            .attach_stdout(true)
            .attach_stderr(true)
            .build(),
    )
    .await
    .unwrap();
};

source

pub async fn rename(&self, new_name: impl AsRef<str>) -> Result<()>

Api Reference

Change the name of this container.

Parameters:

new_name - new name to give for this container

Examples:

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

    if let Err(e) = podman.containers().get("79c93f220e3e").rename("my-container").await {
        eprintln!("{}", e);
    }
};

source

pub async fn init(&self) -> Result<()>

Api Reference

Performs all tasks necessary for initializing the container but does not start the container.

Examples:

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

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

source

pub async fn wait(&self, opts: &ContainerWaitOpts) -> Result<()>

Api Reference

Wait for this container to meet a given condition.

Examples:

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

    if let Err(e) = podman
        .containers()
        .get("79c93f220e3e")
        .wait(
            &ContainerWaitOpts::builder()
                .conditions([ContainerStatus::Configured])
                .interval("300ms")
                .build(),
        )
        .await
    {
        eprintln!("{}", e);
    }
};

source

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

Api Reference

Quick way to determine if a container exists by name or ID

Examples:

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

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

source

pub async fn attach(
&self,
opts: &ContainerAttachOpts
) -> Result<Multiplexer<'podman>>

Api Reference

Attach to this container.

Examples:

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

    let tty_multiplexer = podman
            .containers()
            .get("79c93f220e3e")
            .attach(&Default::default())
            .await
            .unwrap();
    let (mut reader, _writer) = tty_multiplexer.split();

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

source

pub async fn changes(
&self,
opts: &ChangesOpts
) -> Result<Vec<ContainerChangeResponseItem>>

Api Reference

Returns which files in this container’s filesystem have been added, deleted, or modified.

Examples:

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

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

source

pub fn logs(
&self,
opts: &ContainerLogsOpts
) -> impl Stream<Item = Result<Vec<u8>>> + 'podman

Api Reference

Get logs from this container.

Examples:

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

    let mut logs = podman.containers().get("3f278d2d0d79").logs(
        &ContainerLogsOpts::builder()
            .stdout(true)
            .stderr(true)
            .follow(true)
            .build(),
    );

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

source

pub async fn stats(&self) -> Result<LibpodContainerStatsResponse>

Api Reference

Return a single resource usage statistics of this container.

Examples:

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

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

source

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

Api Reference

Return a stream of resource usage statistics of this container.

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()
        .get("fc93f220e3e")
        .stats_stream(None);

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

source

pub async fn top(&self, opts: &ContainerTopOpts) -> Result<ContainerTopOkBody>

Api Reference

List processes running inside this container.

Examples:

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

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

source

pub fn top_stream(
&self,
opts: &ContainerTopOpts
) -> impl Stream<Item = Result<ContainerTopOkBody>> + 'podman

Api Reference

List processes running inside this container as a stream. (As of libpod version 4.0)

Examples:

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

    let mut top = podman
        .containers()
        .get("fc93f220e3e")
        .top_stream(&Default::default());

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

source

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

Api Reference

Generate Systemd Units based on this container.

Examples:

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

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

source

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

Api Reference

Generate Kubernetes YAML based on this container

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
        .containers()
        .get("fc93f220e3e")
        .generate_kube_yaml(false)
        .await
    {
        Ok(yaml) => println!("{:?}", yaml),
        Err(e) => eprintln!("{}", e),
    }
};

source

pub async fn connect(
 &self,
 network: impl Into<Id>,
 opts: &NetworkConnectOpts
) -> Result<()>

Api Reference

Connect this container to a network

Examples:

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

    if let Err(e) = podman
            .containers()
            .get("fc93f220e3e")
            .connect("my-network", &Default::default())
            .await
    {
        eprintln!("{}", e);
    }
};

source

pub async fn disconnect(
 &self,
 network: impl Into<Id>,
 force: bool
) -> Result<()>

Api Reference

Disconnect this container from a network.

Examples:

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

    if let Err(e) = podman.containers().get("fc93f220e3e").disconnect("my-network", true).await {
        eprintln!("{}", e);
    }
};

source

pub async fn healtcheck(&self) -> Result<HealthCheckResults>

Api Reference

Execute the defined healtcheck and return information about the result.

Examples:

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

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

Trait Implementations

source

impl<'podman> Debug for Container<'podman>

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<'podman> !RefUnwindSafe for Container<'podman>

impl<'podman> Send for Container<'podman>

impl<'podman> Sync for Container<'podman>

impl<'podman> Unpin for Container<'podman>

impl<'podman> !UnwindSafe for Container<'podman>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct podman_api::api::Container

Implementations

impl<'podman> Container<'podman>

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

pub fn id(&self) -> &Id

impl<'podman> Container<'podman>

pub async fn start(&self, detach_keys: Option<String>) -> Result<()>

pub async fn stop(&self, opts: &ContainerStopOpts) -> Result<()>

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

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

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

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

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

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

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

pub async fn delete(&self, opts: &ContainerDeleteOpts) -> Result<()>

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

pub async fn mount(&self) -> Result<Id>

pub async fn unmount(&self) -> Result<()>

pub fn checkpoint( &self, opts: &ContainerCheckpointOpts) -> impl Stream<Item = Result<Vec<u8>>> + Unpin + 'podman

pub async fn commit(&self, opts: &ContainerCommitOpts) -> Result<()>

pub async fn create_exec(&self, opts: &ExecCreateOpts) -> Result<Exec<'_>>

pub async fn rename(&self, new_name: impl AsRef<str>) -> Result<()>

pub async fn init(&self) -> Result<()>

pub async fn wait(&self, opts: &ContainerWaitOpts) -> Result<()>

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

pub async fn attach( &self, opts: &ContainerAttachOpts) -> Result<Multiplexer<'podman>>

pub async fn changes( &self, opts: &ChangesOpts) -> Result<Vec<ContainerChangeResponseItem>>

pub fn logs( &self, opts: &ContainerLogsOpts) -> impl Stream<Item = Result<Vec<u8>>> + 'podman

pub async fn stats(&self) -> Result<LibpodContainerStatsResponse>

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

pub async fn top(&self, opts: &ContainerTopOpts) -> Result<ContainerTopOkBody>

pub fn top_stream( &self, opts: &ContainerTopOpts) -> impl Stream<Item = Result<ContainerTopOkBody>> + 'podman

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

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

pub async fn connect( &self, network: impl Into<Id>, opts: &NetworkConnectOpts) -> Result<()>

pub async fn disconnect( &self, network: impl Into<Id>, force: bool) -> Result<()>

pub async fn healtcheck(&self) -> Result<HealthCheckResults>

Trait Implementations

impl<'podman> Debug for Container<'podman>

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

Auto Trait Implementations

impl<'podman> !RefUnwindSafe for Container<'podman>

impl<'podman> Send for Container<'podman>

impl<'podman> Sync for Container<'podman>

impl<'podman> Unpin for Container<'podman>

impl<'podman> !UnwindSafe for Container<'podman>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn checkpoint(
&self,
opts: &ContainerCheckpointOpts
) -> impl Stream<Item = Result<Vec<u8>>> + Unpin + 'podman

pub async fn attach(
&self,
opts: &ContainerAttachOpts
) -> Result<Multiplexer<'podman>>

pub async fn changes(
&self,
opts: &ChangesOpts
) -> Result<Vec<ContainerChangeResponseItem>>

pub fn logs(
&self,
opts: &ContainerLogsOpts
) -> impl Stream<Item = Result<Vec<u8>>> + 'podman

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

pub fn top_stream(
&self,
opts: &ContainerTopOpts
) -> impl Stream<Item = Result<ContainerTopOkBody>> + 'podman

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

pub async fn connect(
&self,
network: impl Into<Id>,
opts: &NetworkConnectOpts
) -> Result<()>

pub async fn disconnect(
&self,
network: impl Into<Id>,
force: bool
) -> Result<()>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,