Struct ComposeUpCommand 

pub struct ComposeUpCommand { /* private fields */ }

Docker Compose up command builder

Implementations

impl ComposeUpCommand

pub fn new() -> Self

Create a new compose up command

pub fn with_config(config: ComposeConfig) -> Self

Create with a specific compose configuration

pub fn service(self, service: impl Into<String>) -> Self

Add a service to start

pub fn services<I, S>(self, services: I) -> Self

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

Add multiple services

pub fn detach(self) -> Self

Run in detached mode

pub fn no_deps(self) -> Self

Don’t start linked services

pub fn force_recreate(self) -> Self

Force recreate containers

pub fn always_recreate_deps(self) -> Self

Always recreate dependent containers

pub fn no_recreate(self) -> Self

Don’t recreate containers

pub fn no_build(self) -> Self

Don’t build images

pub fn no_start(self) -> Self

Don’t start services after creating

pub fn build(self) -> Self

Build images before starting

pub fn remove_orphans(self) -> Self

Remove orphan containers

pub fn scale(self, service: impl Into<String>, instances: u32) -> Self

Scale a service to a specific number of instances

pub fn timeout(self, timeout: Duration) -> Self

Set timeout for container shutdown

pub fn exit_code_from(self, service: impl Into<String>) -> Self

Use exit code from specific container

pub fn abort_on_container_exit(self) -> Self

Abort when containers stop

pub fn attach_dependencies(self) -> Self

Attach to dependent containers

pub fn renew_anon_volumes(self) -> Self

Recreate anonymous volumes

pub fn wait(self) -> Self

Wait for services to be running/healthy

pub fn wait_timeout(self, timeout: Duration) -> Self

Set maximum wait timeout

pub fn pull(self, policy: PullPolicy) -> Self

Set pull policy

pub fn file(self, path: impl Into<PathBuf>) -> Self

Set compose file

pub fn project_name(self, name: impl Into<String>) -> Self

Set project name

pub async fn run(&self) -> Result<ComposeUpResult>

Execute the compose up command

Errors

Returns an error if:

• Docker Compose is not installed
• Compose file is not found or invalid
• Service configuration errors
• Container creation/start fails

Trait Implementations

impl Clone for ComposeUpCommand

fn clone(&self) -> ComposeUpCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeCommand for ComposeUpCommand

type Output = ComposeOutput

The output type this command produces

fn subcommand(&self) -> &'static str

Get the compose subcommand name (e.g., “up”, “down”, “ps”)

fn build_args(&self) -> Vec<String>

Build command-specific arguments

fn execute<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self::Output>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the command

fn config(&self) -> &ComposeConfig

Get the compose configuration

impl Debug for ComposeUpCommand

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

Formats the value using the given formatter.

impl Default for ComposeUpCommand

fn default() -> Self

Returns the “default value” for a type.