Struct TopCommand 

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

Docker top command builder

Display the running processes of a container.

Example

use docker_wrapper::TopCommand;

// Show processes in a container
let processes = TopCommand::new("my-container")
    .run()
    .await?;

// Use custom ps options
let detailed = TopCommand::new("my-container")
    .ps_options("aux")
    .run()
    .await?;

Fields

executor: CommandExecutor

Command executor

Implementations

impl TopCommand

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

Create a new top command

Example

use docker_wrapper::TopCommand;

let cmd = TopCommand::new("my-container");

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

Set ps command options

Example

use docker_wrapper::TopCommand;

// Show detailed process information
let cmd = TopCommand::new("my-container")
    .ps_options("aux");

// Show processes with specific format
let cmd = TopCommand::new("my-container")
    .ps_options("-eo pid,ppid,cmd,%mem,%cpu");

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

Execute the top command

Errors

Returns an error if:

• The Docker daemon is not running
• The container doesn’t exist
• The container is not running

Example

use docker_wrapper::TopCommand;

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

if result.success() {
    println!("Container processes:\n{}", result.output().stdout);
    for process in result.processes() {
        println!("PID: {}, CMD: {}", process.pid, process.command);
    }
}

pub fn get_executor(&self) -> &CommandExecutor

Gets the command executor

pub fn get_executor_mut(&mut self) -> &mut CommandExecutor

Gets the command executor mutably

pub fn build_command_args(&self) -> Vec<String>

Builds the command arguments for Docker top

Trait Implementations

impl Clone for TopCommand

fn clone(&self) -> TopCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopCommand

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

Formats the value using the given formatter.

impl DockerCommand for TopCommand

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)