Struct Template 

pub struct Template {
    pub config: ConfigTemplate,
    pub template_string: String,
    pub context: Value,
}

Fields

config: ConfigTemplate

template_string: String

context: Value

Implementations

impl Template

pub fn parse(toml_str: &str) -> TemplateResult<Self>

Create a new Template instance This function parses the given TOML string and returns a Template instance or a TemplateError if parsing fails It also checks if it’s possible to parse the template with tinytemplate and returns an error if it fails

pub fn render(&self) -> TemplateResult<String>

Render the template with the current context

pub fn render_with_comments<P: AsRef<Path>>( &self, file_path: P, ) -> TemplateResult<Option<String>>

Render the template with the current context and wrap it in comment syntax

pub fn default_comment_styles() -> HashMap<String, CommentStyle>

Get the default comment styles for common file extensions

pub fn default_blacklist() -> Blacklist

Get the default blacklist extensions (binary files, archives, etc.)

pub fn should_skip(&self, file_path: &str) -> bool

Check if a file should be skipped based on blacklist

pub fn get_comment_style<P: AsRef<Path>>( &self, file_path: P, ) -> Option<CommentStyle>

Get the comment style for a file extension

pub fn add_field(&mut self, section: Option<&str>, key: &str, value: Value)

Add a field to a specific section or to variables if no section is specified

Examples

use chipa_touch::templates::config::Template;
use serde_json::json;
 
let toml = r#"
[config]
template = "Test"
[config.owner]
username = "user"
"#;
 
let mut template = Template::parse(toml).unwrap();
 
// Add to variables section (default)
template.add_field(None, "version", json!("1.0.0"));
 
// Add to a custom section
template.add_field(Some("metadata"), "key", json!("value"));

pub fn add_to_array(&mut self, section: &str, item: Value)

Add an item to an array section (like authors, contributors, sponsors, etc.) Creates the array if it doesn’t exist

Examples

use chipa_touch::templates::config::Template;
use serde_json::json;
 
let toml = r#"
[config]
template = "Test"
[config.owner]
username = "user"
"#;
 
let mut template = Template::parse(toml).unwrap();
 
// Add a new author
template.add_to_array("authors", json!({
    "username": "newuser",
    "name": "New User",
    "role": "Contributor"
}));
 
// Add a sponsor
template.add_to_array("sponsors", json!({
    "name": "ACME Corp",
    "tier": "Gold"
}));

pub fn remove_field(&mut self, section: Option<&str>, key: &str) -> bool

Remove a field from a section

Examples

use chipa_touch::templates::config::Template;
 
let toml = r#"
[config]
template = "Test"
[config.owner]
username = "user"
[variables]
old_version = "0.1.0"
"#;
 
let mut template = Template::parse(toml).unwrap();
 
template.remove_field(None, "old_version"); // Remove from variables
template.remove_field(Some("metadata"), "deprecated_key");

pub fn remove_from_array(&mut self, section: &str, index: usize) -> bool

Remove an item from an array section by index

Examples

use chipa_touch::templates::config::Template;
 
let toml = r#"
[config]
template = "Test"
[config.owner]
username = "user"
[[authors]]
username = "author1"
[[authors]]
username = "author2"
"#;
 
let mut template = Template::parse(toml).unwrap();
 
template.remove_from_array("authors", 1); // Remove second author

pub fn get_array_items(&self, section: &str) -> Option<Vec<Value>>

Get all items from an array section

pub fn update_array_item( &mut self, section: &str, index: usize, item: Value, ) -> bool

Update an item in an array section by index

pub fn store(&self) -> TemplateResult<String>

Serialize the template configuration to TOML string