Struct PsCommand

pub struct PsCommand { /* private fields */ }

Docker ps command builder with fluent API

Implementations

impl PsCommand

pub fn new() -> Self

Create a new ps command

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new();

pub fn all(self) -> Self

Show all containers (default shows just running)

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new().all();

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

Filter output based on conditions provided

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new()
    .filter("status=running")
    .filter("name=my-container");

pub fn filters(self, filters: Vec<String>) -> Self

Add multiple filters

Examples

use docker_wrapper::PsCommand;

let filters = vec!["status=running".to_string(), "name=web".to_string()];
let ps_cmd = PsCommand::new().filters(filters);

pub fn format_table(self) -> Self

Format output using table format

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new().format_table();

pub fn format_json(self) -> Self

Format output using JSON format

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new().format_json();

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

Format output using a custom Go template

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new()
    .format_template("table {{.ID}}\\t{{.Names}}\\t{{.Status}}");

pub fn last(self, n: i32) -> Self

Show n last created containers (includes all states)

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new().last(5);

pub fn latest(self) -> Self

Show the latest created container (includes all states)

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new().latest();

pub fn no_trunc(self) -> Self

Don’t truncate output

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new().no_trunc();

pub fn quiet(self) -> Self

Only display container IDs

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new().quiet();

pub fn size(self) -> Self

Display total file sizes

Examples

use docker_wrapper::PsCommand;

let ps_cmd = PsCommand::new().size();

Trait Implementations

impl Clone for PsCommand

fn clone(&self) -> PsCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PsCommand

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

Formats the value using the given formatter.

impl Default for PsCommand

fn default() -> Self

Returns the “default value” for a type.

impl DockerCommand for PsCommand

type Output = PsOutput

The output type this command produces

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

Get the command name (e.g., “run”, “exec”, “ps”)

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

Build the command 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 and return the typed output

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)