Struct CpCommand 

pub struct CpCommand {
    pub executor: CommandExecutor,
    /* private fields */
}

Docker cp command builder

Copy files/folders between a container and the local filesystem. Use - as the source to read from stdin or as the destination to write to stdout.

Example

use docker_wrapper::CpCommand;
use std::path::Path;

// Copy from container to host
CpCommand::from_container("my-container", "/app/config.yml")
    .to_host(Path::new("./config.yml"))
    .run()
    .await?;

// Copy from host to container
CpCommand::from_host(Path::new("./data.txt"))
    .to_container("my-container", "/data/data.txt")
    .run()
    .await?;

Fields

executor: CommandExecutor

Command executor

Implementations

impl CpCommand

pub fn from_container( container: impl Into<String>, path: impl Into<String>, ) -> Self

Create a cp command copying from container to host

Example

use docker_wrapper::CpCommand;
use std::path::Path;

let cmd = CpCommand::from_container("my-container", "/etc/config")
    .to_host(Path::new("./config"));

pub fn from_host(path: &Path) -> Self

Create a cp command copying from host to container

Example

use docker_wrapper::CpCommand;
use std::path::Path;

let cmd = CpCommand::from_host(Path::new("./file.txt"))
    .to_container("my-container", "/app/file.txt");

pub fn to_host(self, path: &Path) -> Self

Set destination on host filesystem

pub fn to_container( self, container: impl Into<String>, path: impl Into<String>, ) -> Self

Set destination in container

pub fn archive(self) -> Self

Archive mode - preserve UIDs/GIDs and permissions

Example

use docker_wrapper::CpCommand;
use std::path::Path;

let cmd = CpCommand::from_container("my-container", "/app")
    .to_host(Path::new("./app-backup"))
    .archive();

pub fn follow_link(self) -> Self

Follow symbolic links in source

pub fn quiet(self) -> Self

Suppress progress output during copy

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

Execute the cp command

Errors

Returns an error if:

• The Docker daemon is not running
• The container doesn’t exist
• The source path doesn’t exist
• Permission denied for destination

Trait Implementations

impl Clone for CpCommand

fn clone(&self) -> CpCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CpCommand

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

Formats the value using the given formatter.

impl DockerCommand for CpCommand

type Output = CommandOutput

The output type this command produces

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

Build the complete command arguments including subcommands

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 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)