Struct ComposeRunCommand 

pub struct ComposeRunCommand {

    pub executor: CommandExecutor,
    pub config: ComposeConfig,
    pub service: String,
    pub command: Vec<String>,
    pub detach: bool,
    pub rm: bool,
    pub no_deps: bool,
    pub no_tty: bool,
    pub interactive: bool,
    pub entrypoint: Option<String>,
    pub env: HashMap<String, String>,
    pub labels: HashMap<String, String>,
    pub name: Option<String>,
    pub publish: Vec<String>,
    pub user: Option<String>,
    pub workdir: Option<String>,
    pub volumes: Vec<String>,
    pub volume_rm: bool,
}

Docker Compose run command builder

Fields

executor: CommandExecutor

Base command executor

config: ComposeConfig

Base compose configuration

service: String

Service to run

command: Vec<String>

Command and arguments to run

detach: bool

Run container in background

rm: bool

Automatically remove the container when it exits

no_deps: bool

Don’t start linked services

no_tty: bool

Disable pseudo-TTY allocation

interactive: bool

Keep STDIN open even if not attached

entrypoint: Option<String>

Override the entrypoint

env: HashMap<String, String>

Set environment variables

labels: HashMap<String, String>

Add or override labels

name: Option<String>

Container name

publish: Vec<String>

Publish container ports to host

user: Option<String>

Run as specified user

workdir: Option<String>

Working directory inside the container

volumes: Vec<String>

Bind mount volumes

volume_rm: bool

Remove associated volumes when container is removed

Implementations

impl ComposeRunCommand

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

Create a new compose run command

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

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

Set the command to run

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

Add command arguments

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

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

Add multiple arguments

pub fn detach(self) -> Self

Run container in background

pub fn rm(self) -> Self

Automatically remove the container when it exits

pub fn no_deps(self) -> Self

Don’t start linked services

pub fn no_tty(self) -> Self

Disable pseudo-TTY allocation

pub fn interactive(self) -> Self

Keep STDIN open even if not attached

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

Override the entrypoint

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set an environment variable

pub fn envs(self, env_vars: HashMap<String, String>) -> Self

Set multiple environment variables

pub fn label(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add or override a label

pub fn labels(self, labels: HashMap<String, String>) -> Self

Set multiple labels

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

Set container name

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

Publish a port to the host

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

Run as specified user

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

Set working directory inside the container

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

Bind mount a volume

pub fn volume_rm(self) -> Self

Remove associated volumes when container is removed

Trait Implementations

impl Clone for ComposeRunCommand

fn clone(&self) -> ComposeRunCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeCommand for ComposeRunCommand

fn get_config(&self) -> &ComposeConfig

Get the compose configuration

fn get_config_mut(&mut self) -> &mut ComposeConfig

Get mutable compose configuration for builder pattern

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

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

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

Build command-specific arguments (without global compose args)

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

Build complete command arguments including “compose” and global args
(This provides the implementation for DockerCommandV2::build_command_args)

fn file<P: Into<PathBuf>>(self, file: P) -> Self

where Self: Sized,

Helper builder methods for common compose config options

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

where Self: Sized,

Set project name for compose command

impl Debug for ComposeRunCommand

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

Formats the value using the given formatter.

impl DockerCommand for ComposeRunCommand

type Output = ComposeRunResult

The output type this command produces

fn get_executor(&self) -> &CommandExecutor

Get the command executor for extensibility

fn get_executor_mut(&mut self) -> &mut CommandExecutor

Get mutable command executor for extensibility

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

Build the complete command arguments including subcommands

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 and return the typed output

fn execute_command<'life0, 'async_trait>( &'life0 self, command_args: Vec<String>, ) -> Pin<Box<dyn Future<Output = Result<CommandOutput>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Helper method to execute the command with proper error handling

fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self

Add a raw argument to the command (escape hatch)

fn args<I, S>(&mut self, args: I) -> &mut Self

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

Add multiple raw arguments to the command (escape hatch)

fn flag(&mut self, flag: &str) -> &mut Self

Add a flag option (e.g., –detach, –rm)

fn option(&mut self, key: &str, value: &str) -> &mut Self

Add a key-value option (e.g., –name value, –env key=value)