Struct CommandTemplate 

pub struct CommandTemplate { /* private fields */ }

A declared command parsed into an executable argv with named holes.

Implementations

impl CommandTemplate

pub fn parse(command: &str) -> Result<Self, TemplateError>

Parse a declared command into a program and its arguments.

Words are split on unquoted whitespace. Single quotes take their contents literally, including $. Double quotes group text into one word while still substituting parameters. A parameter is written $name or ${name}; $$ is a literal $.

Errors

Returns TemplateError when the command is empty, a quote or ${ is unterminated, a $ names no parameter, or the program position is a parameter reference.

pub fn referenced_parameters(&self) -> Vec<String>

The parameter names this command references, in sorted order.

pub fn render( &self, values: &BTreeMap<String, Value>, ) -> Result<Vec<String>, SubstitutionError>

Render the full argv, substituting values for parameter references.

The first element is the program; the rest are its arguments. Each element is one whole argument regardless of what a value contains.

Errors

Returns SubstitutionError when a referenced parameter is absent or its value has no unambiguous argument form.

Trait Implementations

impl Clone for CommandTemplate

fn clone(&self) -> CommandTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandTemplate

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

Formats the value using the given formatter.

impl Eq for CommandTemplate

impl PartialEq for CommandTemplate

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CommandTemplate