Struct ContainerRef 

pub struct ContainerRef<'a> { /* private fields */ }

Reference to a specific container.

Implementations

impl<'a> ContainerRef<'a>

pub fn id(&self) -> &str

Get the container ID.

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

Start the container.

Example

use lmrc_docker::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    client.containers().get("my-container").start().await?;
    Ok(())
}

pub async fn stop(&self, timeout: Option<i64>) -> Result<()>

Stop the container.

Arguments

• timeout - Optional timeout in seconds before killing the container

pub async fn restart(&self, timeout: Option<i64>) -> Result<()>

Restart the container.

pub async fn kill(&self, signal: Option<&str>) -> Result<()>

Kill the container with optional signal.

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

Pause the container.

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

Unpause the container.

pub async fn remove(&self, force: bool, remove_volumes: bool) -> Result<()>

Remove the container.

Arguments

• force - Force remove even if running
• remove_volumes - Remove associated volumes

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

Inspect the container to get detailed information.

pub async fn logs( &self, follow: bool, stdout: bool, stderr: bool, tail: Option<&str>, ) -> Result<Vec<String>>

Get container logs.

Arguments

• follow - Follow log output
• stdout - Show stdout
• stderr - Show stderr
• tail - Number of lines to show from end (default: all)

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

Rename the container.

pub async fn exec(&self, cmd: Vec<String>, tty: bool) -> Result<String>

Execute a command in the container and return the exec ID.