Enum TemplateSource

pub enum TemplateSource {
    Git(GitTemplateSource),
    File(PathBuf),
    RemoteTar(Url),
}

A source from which to install templates.

Variants

Git(GitTemplateSource)

Install from a Git repository at the specified URL. If a branch is specified, templates are installed from that branch or tag; otherwise, they are installed from HEAD.

Templates much be in a /templates directory under the root of the repository.

File(PathBuf)

Install from a directory in the file system.

Templates much be in a /templates directory under the specified root.

RemoteTar(Url)

Install from a remote tarball.

Templates should be in a /templates directory under the root of the tarball. The implementation also allows for there to be a single root directory containing the templates directory - this makes it compatible with GitHub release tarballs.

Implementations

impl TemplateSource

pub fn try_from_git( git_url: impl AsRef<str>, branch: &Option<String>, spin_version: &str, ) -> Result<Self>

Creates a TemplateSource referring to the specified Git repository and branch.

pub async fn resolved_tag(&self) -> Option<String>

For a Git source, resolves the tag to use as the source. For other sources, returns None.

Trait Implementations

impl Debug for TemplateSource

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

Formats the value using the given formatter.