Struct StatsCommand 

pub struct StatsCommand {
    pub executor: CommandExecutor,
    /* private fields */
}

Docker stats command builder

Display a live stream of container(s) resource usage statistics.

Example

use docker_wrapper::StatsCommand;

// Get stats for all running containers
let stats = StatsCommand::new()
    .run()
    .await?;

// Get stats for specific containers
let stats = StatsCommand::new()
    .container("my-container")
    .container("another-container")
    .no_stream()
    .run()
    .await?;

// Parse as JSON for programmatic use
let json_stats = StatsCommand::new()
    .format("json")
    .no_stream()
    .run()
    .await?;

Fields

executor: CommandExecutor

Command executor

Implementations

impl StatsCommand

pub fn new() -> Self

Create a new stats command

Example

use docker_wrapper::StatsCommand;

let cmd = StatsCommand::new();

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

Add a container to monitor

Example

use docker_wrapper::StatsCommand;

let cmd = StatsCommand::new()
    .container("web-server")
    .container("database");

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

Add multiple containers to monitor

pub fn all(self) -> Self

Show stats for all containers (default shows only running)

Example

use docker_wrapper::StatsCommand;

let cmd = StatsCommand::new().all();

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

Set output format

Example

use docker_wrapper::StatsCommand;

// JSON format for programmatic parsing
let cmd = StatsCommand::new().format("json");

// Table format (default)
let cmd = StatsCommand::new().format("table");

pub fn no_stream(self) -> Self

Disable streaming stats and only pull the first result

Example

use docker_wrapper::StatsCommand;

let cmd = StatsCommand::new().no_stream();

pub fn no_trunc(self) -> Self

Do not truncate output (show full container IDs)

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

Execute the stats command

Errors

Returns an error if:

• The Docker daemon is not running
• Any specified container doesn’t exist
• No containers are running (when no specific containers are specified)

Example

use docker_wrapper::StatsCommand;

let result = StatsCommand::new()
    .container("my-container")
    .no_stream()
    .run()
    .await?;

if result.success() {
    println!("Container stats:\n{}", result.output.stdout);
}

Trait Implementations

impl Clone for StatsCommand

fn clone(&self) -> StatsCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatsCommand

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

Formats the value using the given formatter.

impl Default for StatsCommand

fn default() -> Self

Returns the “default value” for a type.

impl DockerCommand for StatsCommand

type Output = CommandOutput

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)