Struct Template

pub struct Template { /* private fields */ }

A Spin template.

Implementations

impl Template

pub fn id(&self) -> &str

The ID of the template. This is used to identify the template on the Spin command line.

pub fn matches_all_tags(&self, match_set: &[String]) -> bool

Returns true if the templates matches the provided set of tags.

pub fn tags(&self) -> &HashSet<String>

The set of tags associated with the template, provided by the template author.

pub fn description(&self) -> &Option<String>

A human-readable description of the template, provided by the template author.

pub fn description_or_empty(&self) -> &str

A human-readable description of the template, provided by the template author, or an empty string if no description was provided.

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

The Git repository from which the template was installed, if it was installed from Git; otherwise None.

pub fn installed_from_or_empty(&self) -> &str

A human-readable description of where the template was installed from.

pub fn supports_variant(&self, variant: &TemplateVariantInfo) -> bool

Checks if the template supports the specified variant mode.

pub fn run(self, options: RunOptions) -> Run

Creates a runner for the template, governed by the given options. Call the relevant associated function of the Run to execute the template as appropriate to your application (e.g. interactive() to prompt the user for values and interact with the user at the console).

Trait Implementations

impl Debug for Template

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

Formats the value using the given formatter.