Struct ImagesCommand 

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

Docker Images Command Builder

Implements the docker images command for listing local Docker images.

Docker Images Overview

The images command lists Docker images stored locally on the system. It supports:

• Repository and tag filtering
• Multiple output formats (table, JSON, custom templates)
• Image metadata display (digests, sizes, creation dates)
• Advanced filtering by various criteria
• Quiet mode for scripts

Image Information

Each image entry typically includes:

• Repository name
• Tag
• Image ID
• Creation date
• Size
• Optionally: digests, intermediate layers

Examples

use docker_wrapper::ImagesCommand;
use docker_wrapper::DockerCommand;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // List all nginx images
    let output = ImagesCommand::new()
        .repository("nginx")
        .execute()
        .await?;

    println!("Images success: {}", output.success());
    Ok(())
}

Fields

executor: CommandExecutor

Command executor for handling raw arguments and execution

Implementations

impl ImagesCommand

pub fn new() -> Self

Create a new ImagesCommand instance

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new();

pub fn repository<S: Into<String>>(self, repository: S) -> Self

Filter images by repository name (and optionally tag)

Arguments

• repository - Repository name (e.g., “nginx”, “nginx:alpine”, “ubuntu:20.04”)

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .repository("nginx:alpine");

pub fn all(self) -> Self

Show all images (including intermediate images)

By default, Docker hides intermediate images. This option shows them all.

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .all();

pub fn digests(self) -> Self

Show digests

Displays the digest (SHA256 hash) for each image.

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .digests();

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

Add a filter condition

Common filters:

• dangling=true|false - Show dangling images
• label=<key> or label=<key>=<value> - Filter by label
• before=<image> - Images created before this image
• since=<image> - Images created since this image
• reference=<pattern> - Filter by repository name pattern

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .filter("dangling=true")
    .filter("label=maintainer=nginx");

pub fn filters<I, S>(self, filters: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add multiple filter conditions

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .filters(vec!["dangling=false", "label=version=latest"]);

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

Set custom output format

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .format("table {{.Repository}}:{{.Tag}}\t{{.Size}}");

pub fn format_table(self) -> Self

Format output as table (default)

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .format_table();

pub fn format_json(self) -> Self

Format output as JSON

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .format_json();

pub fn no_trunc(self) -> Self

Don’t truncate output

By default, Docker truncates long values. This shows full values.

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .no_trunc();

pub fn quiet(self) -> Self

Only show image IDs

Useful for scripting and automation.

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .quiet();

pub fn tree(self) -> Self

List multi-platform images as a tree (experimental)

This is an experimental Docker feature for displaying multi-platform images.

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .tree();

pub fn get_repository(&self) -> Option<&str>

Get the repository filter if set

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new().repository("nginx");
assert_eq!(images_cmd.get_repository(), Some("nginx"));

pub fn is_all(&self) -> bool

Check if showing all images

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new().all();
assert!(images_cmd.is_all());

pub fn is_digests(&self) -> bool

Check if showing digests

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new().digests();
assert!(images_cmd.is_digests());

pub fn is_quiet(&self) -> bool

Check if quiet mode is enabled

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new().quiet();
assert!(images_cmd.is_quiet());

pub fn is_no_trunc(&self) -> bool

Check if no-trunc is enabled

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new().no_trunc();
assert!(images_cmd.is_no_trunc());

pub fn is_tree(&self) -> bool

Check if tree mode is enabled

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new().tree();
assert!(images_cmd.is_tree());

pub fn get_filters(&self) -> &[String]

Get the current filters

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new()
    .filter("dangling=true");
assert_eq!(images_cmd.get_filters(), &["dangling=true"]);

pub fn get_format(&self) -> Option<&str>

Get the format if set

Examples

use docker_wrapper::ImagesCommand;

let images_cmd = ImagesCommand::new().format_json();
assert_eq!(images_cmd.get_format(), Some("json"));

pub fn get_executor(&self) -> &CommandExecutor

Get a reference to the command executor

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

Get a mutable reference to the command executor

Trait Implementations

impl Clone for ImagesCommand

fn clone(&self) -> ImagesCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImagesCommand

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

Formats the value using the given formatter.

impl Default for ImagesCommand

fn default() -> Self

Returns the “default value” for a type.

impl DockerCommand for ImagesCommand

type Output = ImagesOutput

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)