Struct ComposeLsCommand 

pub struct ComposeLsCommand {
    pub executor: CommandExecutor,
    pub config: ComposeConfig,
    pub all: bool,
    pub filter: Option<String>,
    pub format: Option<LsFormat>,
    pub quiet: bool,
}

Docker Compose ls command

List running compose projects.

Fields

executor: CommandExecutor

Base command executor

config: ComposeConfig

Base compose configuration

all: bool

Show all projects (including stopped)

filter: Option<String>

Filter by name

format: Option<LsFormat>

Format output (table, json)

quiet: bool

Only display project names

Implementations

impl ComposeLsCommand

pub fn new() -> Self

Create a new ls command

pub fn all(self) -> Self

Show all projects

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

Filter projects

pub fn format(self, format: LsFormat) -> Self

Set output format

pub fn format_json(self) -> Self

Set output format to JSON

pub fn quiet(self) -> Self

Only display project names

Trait Implementations

impl Clone for ComposeLsCommand

fn clone(&self) -> ComposeLsCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeCommand for ComposeLsCommand

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 ComposeLsCommand

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

Formats the value using the given formatter.

impl Default for ComposeLsCommand

fn default() -> ComposeLsCommand

Returns the “default value” for a type.

impl DockerCommand for ComposeLsCommand

type Output = LsResult

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)