Struct DeclaredCommandContract 

pub struct DeclaredCommandContract {
    pub name: String,
    pub parameters: Vec<CommandParameterContract>,
    pub program: Vec<String>,
    pub args: Vec<ArgvSlot>,
    pub env: Vec<EnvBindingContract>,
    pub cwd: Option<String>,
    pub hardened_path: Option<FillTemplate>,
    pub timeout_ms: Option<i64>,
    pub timeout_owner: Option<String>,
}

The emitted, executable form of one declared command.

Fields

name: String

The declaration’s own name, carried so a refusal can say which command it is talking about.

parameters: Vec<CommandParameterContract>

The declared parameters, in declared order.

program: Vec<String>

The invocation: the program and the subcommand words that qualify it, as literal argv elements. Never a fill — a caller-supplied value must never choose which program executes.

args: Vec<ArgvSlot>

The argument slots, in declared order, which IS the argv order.

env: Vec<EnvBindingContract>

The declared environment bindings, in declared order.

cwd: Option<String>

The declared working directory, verbatim — any {workspace_root} placeholder unexpanded, because expanding it is the executing side’s act against ITS workspace.

hardened_path: Option<FillTemplate>

The hardened PATH, if the declaration states one.

timeout_ms: Option<i64>

The declared timeout in milliseconds, if the declaration states one.

None means the declaration stated NONE, and that is a legal declared state. Nothing here substitutes a ceiling: a number this surface invented would be indistinguishable from one an author chose.

timeout_owner: Option<String>

Who owns the declared timeout, when there is one.

Implementations

impl DeclaredCommandContract

pub fn parameter_names(&self) -> Vec<&str>

Every parameter name this command declares, in declared order.

pub fn render( &self, supplied: &BTreeMap<String, ArgumentValue>, ) -> Result<RenderedCommand, RenderError>

Resolve this command against supplied.

supplied must name only parameters this command declares — a name it does not is refused rather than ignored, because a value nothing consumes is a value nobody reviewed. A caller holding a WIDER set (an action’s parameters, say, of which the command uses some) narrows it first with Self::parameter_names.

Errors

Returns the first refusal the resolution earns: an undeclared or missing argument, a shape mismatch against a declared type, or a leading-dash operand standing where the program still reads options.

Trait Implementations

impl Clone for DeclaredCommandContract

fn clone(&self) -> DeclaredCommandContract

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeclaredCommandContract

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeclaredCommandContract

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DeclaredCommandContract

impl PartialEq for DeclaredCommandContract

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DeclaredCommandContract

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DeclaredCommandContract