docker_utils 0.2.4

Utilities for integration testsing with Docker
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

/*
 * SPDX-License-Identifier: MIT
 * Copyright (c) "2025" . The buildutils Authors and Contributors. All Rights Reserved.
 */

use crate::{DockerError, DockerUtil};
use std::process::Command;

impl DockerUtil {
    /// Prune all stopped containers, their associated volumes and networks.
    ///
    /// This method executes the `docker system prune` command with the `--all` and `--force` options
    /// to remove all stopped containers, their associated volumes, and networks.
    ///
    /// # Errors
    ///
    /// Returns a `DockerError` if there is an error executing the `docker system prune` command.
    pub(crate) fn prune(&mut self) -> Result<(), DockerError> {
        match Command::new("docker")
            .arg("system")
            .arg("prune")
            .arg("--all")
            .arg("--force")
            .spawn()
        {
            Ok(_) => Ok(()),
            Err(e) => Err(DockerError::from(format!("Error pruning containers: {e}"))),
        }
    }
}