Struct CommandConfig

pub struct CommandConfig { /* private fields */ }

Configuration for command execution including arguments and environment variables.

The CommandConfig struct provides a centralized way to manage command-line arguments and environment variables that are passed to Ansible commands. It’s used internally by all the main Ansible wrapper structs.

Examples

Basic Usage

use ansible::command_config::CommandConfig;

let mut config = CommandConfig::default();
config
    .arg("--verbose")
    .arg("--check")
    .add_env("ANSIBLE_HOST_KEY_CHECKING", "False");

assert_eq!(config.get_args().len(), 2);
assert!(config.get_envs().contains_key("ANSIBLE_HOST_KEY_CHECKING"));

Environment Variable Management

use ansible::command_config::CommandConfig;

let mut config = CommandConfig::default();
config
    .set_system_envs()
    .filter_envs(["HOME", "PATH", "USER"]);

// Only HOME, PATH, and USER environment variables are retained
assert!(config.get_envs().len() <= 3);

Implementations

impl CommandConfig

pub fn set_system_envs(&mut self) -> &mut Self

Set environment variables from the current system environment

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

Add a single environment variable

pub fn filter_envs<T, S>(&mut self, iter: T) -> &mut Self

where T: IntoIterator<Item = S>, S: AsRef<OsStr> + Display,

Filter environment variables to only include specified keys

pub fn arg<S: AsRef<OsStr> + Display>(&mut self, arg: S) -> &mut Self

Add a single command argument

pub fn args<T, S>(&mut self, args: T) -> &mut Self

where T: IntoIterator<Item = S>, S: AsRef<OsStr> + Display,

Add multiple command arguments

pub fn clear_args(&mut self) -> &mut Self

Clear all arguments

pub fn clear_envs(&mut self) -> &mut Self

Clear all environment variables

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

Get a reference to the arguments

pub fn get_envs(&self) -> &HashMap<String, String>

Get a reference to the environment variables

Trait Implementations

impl Clone for CommandConfig

fn clone(&self) -> CommandConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandConfig

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

Formats the value using the given formatter.

impl Default for CommandConfig

fn default() -> CommandConfig

Returns the “default value” for a type.