Struct DockerCliRunner 

pub struct DockerCliRunner { /* private fields */ }

Docker CLI runner bound to a Unix socket.

Implementations

impl DockerCliRunner

pub fn new(socket_path: impl Into<PathBuf>) -> Result<Self>

Creates a new CLI runner for the provided Docker socket.

Errors

Returns an error if the docker binary cannot be located.

pub fn socket_path(&self) -> &Path

Returns the socket path used by this runner.

pub const fn helper_image_reference(&self) -> &'static str

Returns the helper image reference used for temporary volume containers.

pub async fn info(&self) -> Result<DockerInfo>

Returns Docker daemon info.

pub async fn list_images(&self) -> Result<Vec<ImageInspect>>

Returns all image inspect payloads.

pub async fn list_volumes(&self) -> Result<Vec<VolumeInspect>>

Returns all volume inspect payloads.

pub async fn list_networks(&self) -> Result<Vec<NetworkInspect>>

Returns all user-defined network inspect payloads.

pub async fn list_containers(&self) -> Result<Vec<ContainerInspect>>

Returns all container inspect payloads, including stopped containers.

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

Stops a container.

pub async fn remove_container(&self, id: &str) -> Result<()>

Removes a container forcibly.

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

Removes a volume.

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

Removes a network.

pub async fn create_volume( &self, name: &str, labels: &[(String, String)], options: &[(String, String)], ) -> Result<()>

Creates a volume with labels and options.

pub async fn create_network( &self, name: &str, config: &CreateNetworkOptions, ) -> Result<()>

Creates a network using supported bridge-network flags.

pub async fn create_container<I, S>(&self, args: I) -> Result<String>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Creates a container and returns its ID.

pub async fn connect_network( &self, network: &str, container: &str, aliases: &[String], ) -> Result<()>

Connects a container to an additional network.

pub async fn create_helper_container( &self, name: &str, volume_name: &str, ) -> Result<String>

Creates a helper container mounting the provided volume at /volume.

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

Ensures the helper image exists by importing an empty tar archive when needed.

pub async fn save_image(&self, reference: &str) -> Result<NamedTempFile>

Saves an image to a tempfile.

pub async fn load_image(&self, path: &Path) -> Result<()>

Loads an image from a tempfile.

pub async fn copy_from_container( &self, container: &str, source_path: &str, ) -> Result<NamedTempFile>

Streams a container path into a tempfile via docker cp.

pub async fn copy_to_container( &self, source_archive: &Path, container: &str, target_path: &str, ) -> Result<()>

Streams a tar archive tempfile into a container via docker cp.

Trait Implementations

impl Clone for DockerCliRunner

fn clone(&self) -> DockerCliRunner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DockerCliRunner

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

Formats the value using the given formatter.