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>,
    pub ssh_session: Option<SshTarget>,
    pub ssh_session_probe: bool,
    /* 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.

ssh_session: Option<SshTarget>

The shared SSH connection this command runs on as one session, when it does. Just before spawning, the executor leases a session on one of the connection’s masters with SshSessions::lease and puts the options that bind the command to that master in front of its arguments (see CommandSpec::open_ssh_session). The arguments stored here never contain them.

ssh_session_probe: bool

The session is a fail-fast probe: it is counted on a shard but never opens a master (see CommandSpec::ssh_probe_session).

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 ssh_session(self, ssh: &SshTarget) -> CommandSpec

Record that this command is an ssh or scp invocation that runs as one session on ssh’s shared connection. It also opens a connection to that destination, for admission, when sharing is off.

pub fn ssh_probe_session(self, ssh: &SshTarget) -> CommandSpec

Record that this command is a fail-fast ssh probe, such as a target validation, that joins ssh’s shared connection without ever opening a master. Its short timeouts and keepalives belong to the probe alone: a master opened by it would impose them on every later session. The probe still uses one of the master’s sessions while it runs, so the executor counts it in the session ledger like any other session.

pub fn open_ssh_session( &self, executor: &dyn CommandExecutor, ) -> Result<SessionCommand<'_>, Error>

Lease the SSH session this command asks for and return the command as it must be spawned, with the lease that must outlive the child.

A command without a session request is returned unchanged. executor runs the master check and, when needed, the opener.

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