Struct SearchCommand

pub struct SearchCommand { /* private fields */ }

Command for searching Docker Hub repositories

The SearchCommand provides a builder pattern for constructing Docker search commands with various filtering and limiting options.

Examples

use docker_wrapper::SearchCommand;

// Basic search
let search = SearchCommand::new("redis");

// Search with filters and limits
let search = SearchCommand::new("nginx")
    .limit(25)
    .filter("stars=10")
    .no_trunc();

Implementations

impl SearchCommand

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

Creates a new search command for the given term

Arguments

• term - The search term to look for

Examples

use docker_wrapper::SearchCommand;

let search = SearchCommand::new("redis");

pub fn limit(self, limit: u32) -> Self

Sets the maximum number of results to return

Arguments

• limit - Maximum number of results

Examples

use docker_wrapper::SearchCommand;

let search = SearchCommand::new("nginx").limit(10);

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

Adds a filter to the search

Arguments

• filter - Filter condition (e.g., “stars=3”, “is-official=true”)

Examples

use docker_wrapper::SearchCommand;

let search = SearchCommand::new("postgres").filter("stars=50");

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

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

Adds multiple filters to the search

Arguments

• filters - Collection of filter conditions

Examples

use docker_wrapper::SearchCommand;

let search = SearchCommand::new("golang")
    .filters(vec!["stars=10", "is-official=true"]);

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

Sets the output format

Arguments

• format - Output format (e.g., “table”, “json”, or Go template)

Examples

use docker_wrapper::SearchCommand;

let search = SearchCommand::new("node").format("json");

pub fn format_table(self) -> Self

Sets output format to table (default)

pub fn format_json(self) -> Self

Sets output format to JSON

pub fn no_trunc(self) -> Self

Disables truncation of output

Examples

use docker_wrapper::SearchCommand;

let search = SearchCommand::new("mysql").no_trunc();

pub fn executor(self, executor: CommandExecutor) -> Self

Sets a custom command executor

Arguments

• executor - Custom command executor

pub fn get_term(&self) -> &str

Gets the search term

pub fn get_limit(&self) -> Option<u32>

Gets the limit (if set)

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

Gets the filters

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

Gets the output format (if set)

pub fn is_no_trunc(&self) -> bool

Returns true if output truncation is disabled

Trait Implementations

impl Clone for SearchCommand

fn clone(&self) -> SearchCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchCommand

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

Formats the value using the given formatter.

impl Default for SearchCommand

fn default() -> Self

Returns the “default value” for a type.

impl Display for SearchCommand

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

Formats the value using the given formatter.

impl DockerCommand for SearchCommand

type Output = SearchOutput

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)