Struct Template 

pub struct Template {
    pub source: PathBuf,
    pub target: PathBuf,
    pub hook: Option<String>,
}

Holds the template configuration:

• source path - file path to the template.
• target path - template build destination.

Template syntax

In the template, you have access to a rich object-oriented color API.

Colors in template

You have access to all colors defined in the Theme. To access a color, you can add this anywhere into your template file:

{{ color_name }}

Where color_name should be replace by the color you want to use. Available colors are:

• primary
• secondary
• background
• surface
• border
• foreground
• muted
• success
• warning
• error

Color methods

The following methods are available to manipulate the color object. They can be chained together.

• lighten(amount): lightens the color by adding a value to it.
• brighten(amount): brightens the color relatively by a given multiplier.
• darken(amount): darkens the color by adding a value to it.
• dim(amount): dims the color relatively by a given multiplier.
• saturate(amount): increases the saturation (chroma component) of the color.
• desaturate(amount): descreases the saturation (chroma component) of the color.

Color formats

You can also convert the color into multiple text formats. Note that after a color is formatted, it becomes a string and you cannot access the menipulation methods anymore. You should use these last.

• hex: #rrggbb (default if no formatter is specified)
• hexa(alpha): #rrggbbaa, where alpha is the provided float (0.0 to 1.0).
• rgb: r,g,b format (e.g. 42,128,56).
• rgba(alpha): r,g,b,a format (e.g. 42,128,56,0.8), where alpha is the provided float (0.0 to 1.0).
• strip: hex without the leading # character - rrggbb.
• r, g, b: extracts the corresponding raw RGB color component.

Example

/* Defaults to hex format. */
bg_color = "{{ background }}"

/* Chains methods before formatting. */
bg_hover = "rgb({{ background.lighten(0.1).rgb }})"

/* Creates transparent color. */
border = "rgba({{ primary.rgba(0.8) }})"

Fields

source: PathBuf

target: PathBuf

hook: Option<String>

Implementations

impl Template

pub fn new<P1, P2>(source: P1, target: P2) -> Self

where P1: AsRef<Path>, P2: AsRef<Path>,

Creates new template with source as the template file path and target as the build destination.

pub fn build(&self, theme: &Theme) -> Result<(), Error>

Builds the template at source and saves it to target.

Note that it’s more efficient to build multiple templates using build_templates, instead of using this function on each of the templates.

pub fn run_hook(&self)

Runs the template hook if set.

It runs the set hook in the home directory (or in / if home cannot be found).

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

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 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.