Struct Template 

pub struct Template {
    pub id: String,
    pub name: String,
    pub description: String,
    pub version: String,
    pub logo: Option<String>,
    pub tags: Vec<String>,
    pub links: BTreeMap<String, String>,
    pub variables: Vec<Variable>,
    pub apps: Vec<AppTemplate>,
    pub main: Option<String>,
    pub notes: Vec<String>,
}

A template, as written in YAML (docs/guides/templates.md).

Fields

id: String

[a-z0-9-], unique in its catalog.

name: String

description: String

version: String

The template’s own version (usually the app’s).

logo: Option<String>

A logo URL.

tags: Vec<String>

links: BTreeMap<String, String>

website, docs, source, … to URLs.

variables: Vec<Variable>

apps: Vec<AppTemplate>

main: Option<String>

The app named after the instance (default: the only app).

notes: Vec<String>

What to know after deploying (first-run steps, default logins).

Implementations

impl Template

pub fn from_yaml(text: &str) -> Result<Template>

Parse a template from YAML (or JSON) text.

pub fn var(&self, name: &str) -> Option<&Variable>

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

The key of the app named after the instance, if any.

pub fn validate(&self) -> Result<()>

Everything checkable without values: names, references, cycles.

pub fn order(&self) -> Result<Vec<String>>

App keys in deploy order: dependencies first, else as written.

Trait Implementations

impl Clone for Template

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Template

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Template

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Template

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Template

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 Template