Struct ComposeCpCommand 

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

Docker Compose cp command

Copy files/folders between a service container and the local filesystem.

Fields

config: ComposeConfig

Base configuration

source: String

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

destination: String

Destination path (can be container: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 cp command

pub fn from_container( service: impl Into<String>, container_path: impl Into<String>, local_path: impl Into<PathBuf>, ) -> Self

Copy from container to local

pub fn to_container( local_path: impl Into<PathBuf>, service: impl Into<String>, container_path: impl Into<String>, ) -> Self

Copy from local to container

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

Add a compose file

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

Set project name

pub fn archive(self) -> Self

Enable archive mode

pub fn follow_link(self) -> Self

Follow symbolic links

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

Set container index

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 ComposeCommandV2 for ComposeCpCommand

type Output = CpResult

The output type this command produces

fn get_config(&self) -> &ComposeConfig

Get the compose configuration

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

Get mutable compose configuration

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

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

Execute compose command with given 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 execute_compose_command<'life0, 'async_trait>( &'life0 self, args: Vec<String>, ) -> Pin<Box<dyn Future<Output = Result<ComposeOutput>> + Send + 'async_trait>>

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

Helper to execute compose command

impl Debug for ComposeCpCommand

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

Formats the value using the given formatter.