Function brane_ctl::lifetime::stop

source · 
pub fn stop(
    compose_verbose: bool,
    exe: impl AsRef<str>,
    file: Option<PathBuf>,
    node_config_path: impl Into<PathBuf>,
) -> Result<(), Error>
Expand description

Stops the (currently running) local node.

This is a very simple command, no more than a wrapper around docker-compose.

§Arguments

  • compose_verbose: If given, attempts to enable additional debug prints in the Docker Compose executable.
  • exe: The docker-compose executable to run.
  • file: The docker-compose file file to use to stop.
  • node_config_path: The path to the node config file that we use to deduce the project name.

§Returns

Nothing, but does change the local Docker daemon to stop the services if they are running.

§Errors

This function errors if we failed to run docker-compose.