Struct ComposeConfigCommand 

pub struct ComposeConfigCommand {

    pub executor: CommandExecutor,
    pub config: ComposeConfig,
    pub format: Option<ConfigFormat>,
    pub resolve_image_digests: bool,
    pub no_interpolate: bool,
    pub no_normalize: bool,
    pub no_consistency: bool,
    pub services: bool,
    pub volumes: bool,
    pub profiles: bool,
    pub images: bool,
    pub hash: Option<String>,
    pub output: Option<String>,
    pub quiet: bool,
}

Docker Compose config command builder

Fields

executor: CommandExecutor

Base command executor

config: ComposeConfig

Base compose configuration

format: Option<ConfigFormat>

Output format

resolve_image_digests: bool

Resolve image digests

no_interpolate: bool

Don’t interpolate environment variables

no_normalize: bool

Don’t normalize paths

no_consistency: bool

Don’t check consistency

services: bool

Show services only

volumes: bool

Show volumes only

profiles: bool

Show profiles only

images: bool

Show images only

hash: Option<String>

Hash of services to include

output: Option<String>

Output file path

quiet: bool

Quiet mode

Implementations

impl ComposeConfigCommand

pub fn new() -> Self

Create a new compose config command

pub fn format(self, format: ConfigFormat) -> Self

Set output format

pub fn format_json(self) -> Self

Set output format to JSON

pub fn format_yaml(self) -> Self

Set output format to YAML

pub fn resolve_image_digests(self) -> Self

Resolve image digests

pub fn no_interpolate(self) -> Self

Don’t interpolate environment variables

pub fn no_normalize(self) -> Self

Don’t normalize paths

pub fn no_consistency(self) -> Self

Don’t check consistency

pub fn services(self) -> Self

Show services only

pub fn volumes(self) -> Self

Show volumes only

pub fn profiles(self) -> Self

Show profiles only

pub fn images(self) -> Self

Show images only

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

Set hash of services to include

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

Set output file path

pub fn quiet(self) -> Self

Enable quiet mode

Trait Implementations

impl Clone for ComposeConfigCommand

fn clone(&self) -> ComposeConfigCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeCommand for ComposeConfigCommand

fn get_config(&self) -> &ComposeConfig

Get the compose configuration

fn get_config_mut(&mut self) -> &mut ComposeConfig

Get mutable compose configuration for builder pattern

fn subcommand(&self) -> &'static str

Get the compose subcommand name (e.g., “up”, “down”, “ps”)

fn build_subcommand_args(&self) -> Vec<String>

Build command-specific arguments (without global compose args)

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

Build complete command arguments including “compose” and global args
(This provides the implementation for DockerCommandV2::build_command_args)

fn file<P: Into<PathBuf>>(self, file: P) -> Self

where Self: Sized,

Helper builder methods for common compose config options

fn project_name(self, name: impl Into<String>) -> Self

where Self: Sized,

Set project name for compose command

impl Debug for ComposeConfigCommand

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

Formats the value using the given formatter.

impl Default for ComposeConfigCommand

fn default() -> Self

Returns the “default value” for a type.

impl DockerCommand for ComposeConfigCommand

type Output = ComposeConfigResult

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)

fn with_timeout(&mut self, timeout: Duration) -> &mut Self

Set a timeout for command execution

fn with_timeout_secs(&mut self, seconds: u64) -> &mut Self

Set a timeout in seconds for command execution