Struct ComposePsCommand 

pub struct ComposePsCommand { /* private fields */ }

Docker Compose ps command builder

Implementations

impl ComposePsCommand

pub fn new() -> Self

Create a new compose ps command

pub fn with_config(config: ComposeConfig) -> Self

Create with a specific compose configuration

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

Add a service to list

pub fn all(self) -> Self

Show all containers (default shows only running)

pub fn quiet(self) -> Self

Only display container IDs

pub fn services(self) -> Self

Display services

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

Add a filter

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

Set output format

pub fn status(self, status: ContainerStatus) -> Self

Filter by status

pub fn json(self) -> Self

Use JSON output format

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

Set compose file

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

Set project name

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

Execute the compose ps command

Errors

Returns an error if:

• Docker Compose is not installed
• Compose file is not found
• Service lookup fails

Trait Implementations

impl Clone for ComposePsCommand

fn clone(&self) -> ComposePsCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeCommand for ComposePsCommand

type Output = ComposeOutput

The output type this command produces

fn subcommand(&self) -> &'static str

Get the compose subcommand name (e.g., “up”, “down”, “ps”)

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

Build command-specific 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 config(&self) -> &ComposeConfig

Get the compose configuration

impl Debug for ComposePsCommand

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

Formats the value using the given formatter.

impl Default for ComposePsCommand

fn default() -> Self

Returns the “default value” for a type.