Struct DeclaredCommandContract 

pub struct DeclaredCommandContract {
    pub name: String,
    pub parameters: Vec<CommandParameterContract>,
    pub lines: Vec<CommandLineContract>,
    pub env: Vec<EnvBindingContract>,
    pub cwd: Option<String>,
    pub prior_form_refusal: Option<String>,
}

The emitted, executable form of one declared command.

Deserialization is hand-written (in [super::compat]): it reads this shape as written, and reads the PRIOR archive form — program words plus args slots — by translating it into this shape at the wire, so an archive deployed before the reshape still opens everywhere.

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.

lines: Vec<CommandLineContract>

The body’s logical lines, in execution order.

env: Vec<EnvBindingContract>

The document’s exported environment bindings, in declared order.

cwd: Option<String>

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

prior_form_refusal: Option<String>

Set ONLY by the prior-archive reader ([super::compat]), naming a construct of the prior form this shape cannot express faithfully. A contract carrying it still reads, lists and censuses everywhere; Self::render refuses it with the construct and the cure, so the unexpressible part can never execute as something it did not mean. The emitter never sets it.

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 list where one value belongs, a leading-dash operand standing where the program still reads options, or a body that reads a parameter the command does not declare.

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