Struct DockerClient 

pub struct DockerClient { /* private fields */ }

Thin async wrapper around a Bollard Docker client.

Implementations

impl DockerClient

pub async fn connect() -> Result<Self, DockerError>

Connect to Docker using Bollard defaults and verify connectivity with ping.

pub fn from_bollard(docker: Docker) -> Self

Wrap an existing Bollard Docker client.

pub fn inner(&self) -> &Docker

Access the underlying Bollard client.

pub async fn ensure_image( &self, image: &str, ) -> Result<ImageStatus, DockerError>

Ensure a Docker image exists locally, pulling it if necessary.

pub async fn create_and_start( &self, spec: ContainerSpec, ) -> Result<SpawnedContainer, DockerError>

Create and start a container from a ContainerSpec.

pub async fn inspect_container( &self, container_id: &str, ) -> Result<SpawnedContainer, DockerError>

Inspect an existing container and return refreshed metadata.

pub async fn stop_container( &self, container_id: &str, ) -> Result<(), DockerError>

Stop an existing container. Already-stopped containers are treated as success.

pub async fn start_container( &self, container_id: &str, ) -> Result<SpawnedContainer, DockerError>

Start an existing container and return refreshed metadata.

pub async fn restart_container( &self, container_id: &str, ) -> Result<SpawnedContainer, DockerError>

Stop and start an existing container, returning refreshed metadata.

pub async fn create_network( &self, spec: NetworkSpec, ) -> Result<ManagedNetwork, DockerError>

Create a managed Docker network and return its inspected metadata.

pub async fn remove_network(&self, network: &str) -> Result<(), DockerError>

Remove a Docker network by id or name.

pub async fn copy_file_from_container( &self, container_id: &str, path: &str, ) -> Result<Vec<u8>, DockerError>

Copy a single file from a container and return its bytes.

pub async fn cleanup_cluster( &self, cluster_id: &str, ) -> Result<CleanupReport, DockerError>

Remove all managed containers with the given cluster id.

pub async fn cleanup_all(&self) -> Result<CleanupReport, DockerError>

Remove all containers and networks managed by this crate.

pub async fn managed_container_ids(&self) -> Result<Vec<String>, DockerError>

Return ids for all containers managed by this crate.

pub async fn managed_network_ids(&self) -> Result<Vec<String>, DockerError>

Return ids for all networks managed by this crate.

pub async fn cluster_container_ids( &self, cluster_id: &str, ) -> Result<Vec<String>, DockerError>

Return ids for all managed containers with the given cluster id.

pub async fn cluster_network_ids( &self, cluster_id: &str, ) -> Result<Vec<String>, DockerError>

Return ids for all managed networks with the given cluster id.

pub async fn container_logs( &self, container_id: &str, ) -> Result<String, DockerError>

Return recent stdout/stderr logs from a container.

pub fn rollback_guard(&self) -> StartupRollback<'_>

Create a rollback guard for containers created during startup.

pub async fn rollback_containers<I>( &self, container_ids: I, ) -> Result<CleanupReport, DockerError>

where I: IntoIterator, I::Item: Into<String>,

Stop and remove explicit container ids.

Trait Implementations

impl Clone for DockerClient

fn clone(&self) -> DockerClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DockerClient

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

Formats the value using the given formatter.