Struct TemplateDefinition

pub struct TemplateDefinition {
    pub title: String,
    pub description: String,
    pub path: Option<String>,
    pub use_cases: Vec<String>,
    pub tags: Vec<String>,
    pub live_demo: Option<String>,
    pub template: Option<String>,
    pub author: Option<String>,
    pub repo: Option<String>,
}

Fields

title: String

Title of the template

description: String

A short description of the template

path: Option<String>

Path relative to the repo root

use_cases: Vec<String>

List of areas where this template is useful. Examples: “Web app”, “Discord bot”, “Monitoring”, “Automation”, “Utility”

tags: Vec<String>

List of keywords that describe the template. Examples: “axum”, “serenity”, “typescript”, “saas”, “fullstack”, “database”

live_demo: Option<String>

URL to a live instance of the template (if relevant)

template: Option<String>

If this template is available in the shuttle init --template short-hand options, add that name here

author: Option<String>

GitHub username of the author of the community template

repo: Option<String>

URL to the repo of the community template

Trait Implementations

impl Debug for TemplateDefinition

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

Formats the value using the given formatter.

impl Default for TemplateDefinition

fn default() -> TemplateDefinition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TemplateDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TemplateDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.