Struct EventsCommand 

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

Docker events command builder

Get real-time events from the Docker daemon.

Example

use docker_wrapper::EventsCommand;

// Get all events
let events = EventsCommand::new()
    .run()
    .await?;

// Get container events only
let container_events = EventsCommand::new()
    .filter("type", "container")
    .format("json")
    .run()
    .await?;

Fields

executor: CommandExecutor

Command executor

Implementations

impl EventsCommand

pub fn new() -> Self

Create a new events command

Example

use docker_wrapper::EventsCommand;

let cmd = EventsCommand::new();

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

Add a filter for events

Example

use docker_wrapper::EventsCommand;

let cmd = EventsCommand::new()
    .filter("type", "container")
    .filter("event", "start")
    .filter("container", "my-container");

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

Set output format

Example

use docker_wrapper::EventsCommand;

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

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

Show events created since this timestamp

Example

use docker_wrapper::EventsCommand;

let cmd = EventsCommand::new()
    .since("2023-01-01T00:00:00");

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

Show events created until this timestamp

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

Execute the events command

Errors

Returns an error if:

• The Docker daemon is not running
• Invalid filter or timestamp format

Example

use docker_wrapper::EventsCommand;

let result = EventsCommand::new()
    .filter("type", "container")
    .format("json")
    .run()
    .await?;

if result.success() {
    for event in result.parsed_events() {
        println!("Event: {} on {}", event.action, event.actor.id);
    }
}

Trait Implementations

impl Clone for EventsCommand

fn clone(&self) -> EventsCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventsCommand

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

Formats the value using the given formatter.

impl Default for EventsCommand

fn default() -> Self

Returns the “default value” for a type.

impl DockerCommand for EventsCommand

type Output = CommandOutput

The output type this command produces

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 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 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)