Struct DockerRuntime 

pub struct DockerRuntime { /* private fields */ }

Docker container runtime backed by the bollard crate.

Connects to the local Docker daemon using the platform default transport (Unix socket on Linux and macOS, named pipe on Windows). Implements crate::ContainerRuntime so it can be passed to crate::LifecycleManager.

Example

use lightshuttle_runtime::DockerRuntime;

let runtime = DockerRuntime::connect()?;

Implementations

impl DockerRuntime

pub fn connect() -> Result<Self>

Connect to the local Docker daemon using the platform default transport.

Returns crate::RuntimeError::Connect when the daemon socket or named pipe cannot be reached.

pub fn from_client(client: Docker) -> Self

Wrap an existing bollard::Docker client.

Useful when the caller manages the client lifetime directly or needs a custom transport (e.g. a TLS-secured remote daemon or a test double).

pub async fn list_managed(&self, project: &str) -> Result<Vec<ManagedContainer>>

List every container labelled with lightshuttle.project=<project>.

Includes stopped and dead containers, so the CLI can implement ps and down without relying on in-memory state. The result is sorted alphabetically by resource name.

Example

use lightshuttle_runtime::DockerRuntime;

let runtime = DockerRuntime::connect()?;
let containers = runtime.list_managed("myapp").await?;
for c in &containers {
    println!("{}: {:?}", c.resource, c.status);
}

Trait Implementations

impl ContainerRuntime for DockerRuntime

async fn ensure_project_network(&self, project: &str) -> Result<()>

Ensure a per-project user-defined bridge network exists, creating it when absent. Idempotent: concurrent calls are safe because a 409 Conflict response (network already exists) is treated as success. Containers attached to this network can reach each other by their container name, enabling resources.<name>.url hostnames to resolve without extra configuration.

async fn teardown_project_network(&self, project: &str) -> Result<()>

Remove the per-project bridge network. Idempotent: a 404 Not Found response is treated as success. Call after all containers belonging to the project have been removed; Docker refuses to delete a network that still has active endpoints.

async fn start(&self, spec: &ContainerSpec) -> Result<ContainerId>

Start a container according to spec. Pulls the image if not already present locally.

async fn stop(&self, id: &ContainerId, grace: Duration) -> Result<()>

Stop a container, sending SIGTERM and then SIGKILL after grace. Idempotent: stopping an already stopped container is a no-op.

async fn remove(&self, name: &str) -> Result<()>

Remove a container by name, forcing removal even if it is still running. Idempotent: removing a container that does not exist is a no-op. Named volumes are preserved.

async fn inspect(&self, id: &ContainerId) -> Result<ContainerStatus>

Report the current status of a container.

async fn wait_healthy(&self, id: &ContainerId, timeout: Duration) -> Result<()>

Block until the container reports a healthy status or timeout elapses. Returns crate::RuntimeError::Timeout in the latter case.

async fn logs(&self, id: &ContainerId, follow: bool) -> Result<LogChunkStream>

Stream logs from a container. When follow is true the stream stays open and emits new chunks as they arrive; when false the stream completes after the existing logs are drained.