Struct DockerCompose 

pub struct DockerCompose { /* private fields */ }

Docker Compose integration using subprocess execution

Implementations

impl DockerCompose

pub fn new<P: AsRef<Path>>(compose_file: P) -> Result<Self>

Create a new Docker Compose instance

pub fn with_project_name<S: Into<String>>(self, name: S) -> Self

Set a custom project name

pub fn is_available() -> bool

Check if docker-compose is available

pub fn compose_file(&self) -> &Path

Get the compose file path

pub fn working_dir(&self) -> &Path

Get the working directory

pub fn project_name(&self) -> Option<&str>

Get the project name

impl DockerCompose

High-level Docker Compose operations

pub fn up(&self, options: UpOptions) -> Result<ComposeOutput>

Start services (docker-compose up)

pub fn down(&self, options: DownOptions) -> Result<ComposeOutput>

Stop and remove services (docker-compose down)

pub fn restart(&self, options: RestartOptions) -> Result<ComposeOutput>

Restart services (docker-compose restart)

pub fn logs(&self, options: LogsOptions) -> Result<ComposeOutput>

View service logs (docker-compose logs)

pub fn ps(&self, options: PsOptions) -> Result<ComposeOutput>

List running services (docker-compose ps)

pub fn build(&self, options: BuildOptions) -> Result<ComposeOutput>

Build services (docker-compose build)

pub fn start(&self, services: &[String]) -> Result<ComposeOutput>

Start services (docker-compose start)

pub fn stop(&self, options: StopOptions) -> Result<ComposeOutput>

Stop services (docker-compose stop)

pub fn exec( &self, service: &str, command: &[String], options: ExecOptions, ) -> Result<ComposeOutput>

Execute a command in a service container (docker-compose exec)

pub fn pull(&self, services: &[String]) -> Result<ComposeOutput>

Pull service images (docker-compose pull)

pub fn config(&self, options: ConfigOptions) -> Result<ComposeOutput>

Validate and view the compose configuration (docker-compose config)

Trait Implementations

impl Clone for DockerCompose

fn clone(&self) -> DockerCompose

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DockerCompose

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

Formats the value using the given formatter.