Struct CommandSpec 

pub struct CommandSpec {
    pub program: String,
    pub args: Vec<String>,
    pub env: BTreeMap<String, String>,
    pub clear_env: bool,
    pub cwd: Option<PathBuf>,
    pub purpose: String,
    pub stage: Option<ProvisionStage>,
    pub parallel_group: Option<u32>,
    pub creates_target: bool,
    pub ssh_destination: Option<String>,
    /* private fields */
}

Fields

program: String

args: Vec<String>

env: BTreeMap<String, String>

clear_env: bool

Replace ambient process variables with the explicitly supplied environment.

cwd: Option<PathBuf>

purpose: String

stage: Option<ProvisionStage>

parallel_group: Option<u32>

Commands that share this marker and appear consecutively in a plan’s command list may run concurrently under CommandPlan::execute_concurrent. Commands without a marker, or whose neighbors do not share it, keep running strictly in plan order.

creates_target: bool

Whether this command brings the session’s target into existence. Every command after it in a provisioning plan runs against a target that already exists, so a later failure owes that target’s teardown.

ssh_destination: Option<String>

The SSH destination this command opens a connection to, when it does. Tagged commands pass through SshAdmission so the daemon never exceeds the remote sshd’s MaxStartups budget, and a transport rejection is retried rather than reported as a command failure.

Implementations

impl CommandSpec

pub fn new( program: impl Into<String>, args: impl IntoIterator<Item = impl Into<String>>, ) -> CommandSpec

pub fn purpose(self, purpose: impl Into<String>) -> CommandSpec

pub fn stage(self, stage: ProvisionStage) -> CommandSpec

pub fn parallel_group(self, group: u32) -> CommandSpec

Mark this command as eligible to run concurrently with its plan-adjacent siblings that share the same group.

pub fn ssh_destination(self, destination: impl Into<String>) -> CommandSpec

Record that this command opens an ssh connection to destination, which is the host (or user@host) argument, never an option value.

pub fn creates_target(self) -> CommandSpec

Mark this command as the one that creates the session’s target.

pub fn with_sensitive_stdin(self, input: Vec<u8>) -> CommandSpec

Feed private file content through the shared concurrent pipe handler. The bytes stay out of argv, environments, serialization, and Debug.

Trait Implementations

impl Clone for CommandSpec

fn clone(&self) -> CommandSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandSpec

fn deserialize<__D>( __deserializer: __D, ) -> Result<CommandSpec, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommandSpec

impl PartialEq for CommandSpec

fn eq(&self, other: &CommandSpec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CommandSpec

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandSpec