Struct ComposeKillCommand 

pub struct ComposeKillCommand {
    pub config: ComposeConfig,
    pub signal: Option<String>,
    pub remove_orphans: bool,
    pub services: Vec<String>,
}

Docker Compose kill command

Force stop service containers.

Fields

config: ComposeConfig

Base configuration

signal: Option<String>

Signal to send (default: SIGKILL)

remove_orphans: bool

Remove containers after killing

services: Vec<String>

Services to kill

Implementations

impl ComposeKillCommand

pub fn new() -> Self

Create a new kill command

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 signal(self, signal: impl Into<String>) -> Self

Set signal to send

pub fn remove_orphans(self) -> Self

Remove orphaned containers

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

Add a service to kill

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

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

Add multiple services to kill

Trait Implementations

impl Clone for ComposeKillCommand

fn clone(&self) -> ComposeKillCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeCommandV2 for ComposeKillCommand

type Output = KillResult

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 ComposeKillCommand

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

Formats the value using the given formatter.

impl Default for ComposeKillCommand

fn default() -> ComposeKillCommand

Returns the “default value” for a type.