Struct ComposeCpCommand 

pub struct ComposeCpCommand {
    pub executor: CommandExecutor,
    pub config: ComposeConfig,
    pub source: String,
    pub destination: String,
    pub archive: bool,
    pub follow_link: bool,
    pub index: Option<u32>,
}

Docker Compose cp command builder

Fields

executor: CommandExecutor

Base command executor

config: ComposeConfig

Base compose configuration

source: String

Source path (can be service:path or local path)

destination: String

Destination path (can be service:path or local path)

archive: bool

Archive mode (preserve permissions)

follow_link: bool

Follow symbolic links

index: Option<u32>

Index of the container (if service has multiple instances)

Implementations

impl ComposeCpCommand

pub fn new(source: impl Into<String>, destination: impl Into<String>) -> Self

Create a new compose cp command

pub fn archive(self) -> Self

Enable archive mode (preserve permissions and ownership)

pub fn follow_link(self) -> Self

Follow symbolic links in source path

pub fn index(self, index: u32) -> Self

Set container index if service has multiple instances

Trait Implementations

impl Clone for ComposeCpCommand

fn clone(&self) -> ComposeCpCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeCommand for ComposeCpCommand

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 ComposeCpCommand

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

Formats the value using the given formatter.

impl DockerCommand for ComposeCpCommand

type Output = ComposeCpResult

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)

fn with_timeout(&mut self, timeout: Duration) -> &mut Self

Set a timeout for command execution

fn with_timeout_secs(&mut self, seconds: u64) -> &mut Self

Set a timeout in seconds for command execution