Struct DeclaredCommandAction 

pub struct DeclaredCommandAction { /* private fields */ }

A declared command, ready to run as an activity.

Implementations

impl DeclaredCommandAction

pub const fn new(contract: DeclaredCommandContract) -> Self

Wrap an emitted command.

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

The working directory the DECLARATION states, verbatim.

Returned unexpanded because a {workspace_root} placeholder resolves against the executing host’s own workspace, which this crate has no business knowing. A caller reads this, resolves it however its host resolves roots, and hands the answer back through Self::with_working_directory.

pub fn with_working_directory(self, directory: impl Into<PathBuf>) -> Self

Run the command in directory.

pub fn declared_timeout(&self) -> Result<Option<Duration>, ActivityFailure>

The timeout the declaration states, if it states one.

Ok(None) means the declaration stated NONE, which is a legal declared state: nothing here substitutes a ceiling.

Errors

Returns a terminal ActivityFailure when the contract carries a millisecond count no duration can hold — a negative one, say. The AWL checker refuses those before deploy, so reaching this arm means a defective contract was deployed; it is REFUSED rather than treated as “no ceiling”, because the direction of that failure is a command running unbounded on the operator’s machine while the declaration, the --check report and the named owner all say a bound was set.

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

Who owns the declared timeout, when there is one.

pub fn name(&self) -> &str

The command’s declared name, for a diagnostic.

pub fn render( &self, arguments: &BTreeMap<String, Value>, ) -> Result<RenderedCommand, ActivityFailure>

Render this command against arguments.

arguments is the ACTION’s whole input and may name parameters the command does not use — an action is free to declare more than one of its bodies needs. The command’s own declared names select from it, so a surplus is not a refusal here; a command parameter the action cannot supply is refused at check time, before anything is deployed.

Errors

Returns a terminal ActivityFailure when a value has no unambiguous argument form, when a declared parameter has neither a supplied value nor a default, or when an operand would carry leading-dash bytes into a position the program still reads options in. Every one of those fails identically on every retry, which is why none is retryable.

pub async fn run( &self, arguments: &BTreeMap<String, Value>, context: &ActivityContext, ) -> Result<ShellOutcome, ActivityFailure>

Run the command with arguments bound to its declared parameters.

Two things end the command early and both reach the same termination ladder the string-body executor uses — SIGTERM → grace → SIGKILL across the whole process group, with the verdict withheld until the group has been proven gone. The first is the activity being cancelled. The second is the command’s OWN declared timeout, which is enforced here, where the process is: a deadline applied only to the waiting side stops a caller waiting and leaves a process running.

Errors

Returns a terminal ActivityFailure for a render refusal, a command that cannot be spawned or observed, a cancellation, or a declared timeout; and a retryable one for a non-zero exit, carrying the exit code and the command’s own standard error.

Trait Implementations

impl Clone for DeclaredCommandAction

fn clone(&self) -> DeclaredCommandAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeclaredCommandAction

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

Formats the value using the given formatter.