Struct CommandTemplate 

pub struct CommandTemplate {
    pub name: String,
    pub description: String,
    pub template: String,
    pub variables: Vec<TemplateVariable>,
    pub tags: Vec<String>,
    pub destructive: bool,
}

A parameterized command template.

Fields

name: String

description: String

template: String

variables: Vec<TemplateVariable>

tags: Vec<String>

destructive: bool

Implementations

impl CommandTemplate

pub fn new( name: impl Into<String>, description: impl Into<String>, template: impl Into<String>, ) -> Self

Create a new command template.

pub fn required_var( self, name: impl Into<String>, description: impl Into<String>, ) -> Self

Add a required variable.

pub fn optional_var( self, name: impl Into<String>, description: impl Into<String>, default: impl Into<String>, ) -> Self

Add an optional variable.

pub fn destructive(self) -> Self

Mark as destructive.

pub fn tag(self, tag: impl Into<String>) -> Self

Add a tag.

pub fn render(&self, vars: &HashMap<String, String>) -> Result<String>

Render the command with variable values.

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<'de> Deserialize<'de> for CommandTemplate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CommandTemplate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.