Struct TmplGroup

pub struct TmplGroup { /* private fields */ }

A template group in which the templates can ref each other.

Implementations

impl TmplGroup

pub fn new() -> Self

Create a new template group.

pub fn new_dev() -> Self

Create a new template group in dev mode.

pub fn dev(&self) -> bool

Get the dev mode.

pub fn import_group(&mut self, group: &TmplGroup)

import another group.

pub fn get_tree(&self, path: &str) -> Result<&Template, TmplError>

Add a ref of a parsed tree in the group.

pub fn get_tree_mut(&mut self, path: &str) -> Result<&mut Template, TmplError>

Get a mutable ref of a parsed tree in the group.

pub fn add_tmpl(&mut self, path: &str, tmpl_str: &str) -> Vec<ParseError>

Add a template into the group.

pub fn remove_tmpl(&mut self, path: &str) -> bool

Remove a template from the group.

This simply removes a template path. It is useful when doing hot-update debugging, but not suitable for final builds since it does not do cleanups. Returns true when a template is actually removed.

pub fn stringify_tmpl(&self, path: &str) -> Option<String>

Regenerate a template content string of the specified template.

pub fn get_script(&mut self, path: &str) -> Result<&str, TmplError>

Get a script segment in the group.

pub fn add_script(&mut self, path: &str, content: &str)

Add a script segment into the group.

The content must be valid JavaScript file content. require and exports can be visited in this JavaScript segment, similar to Node.js.

pub fn remove_script(&mut self, path: &str) -> bool

Remove a script segment from the group.

This simply removes a script path. It is useful when doing hot-update debugging, but not suitable for final builds since it does not do cleanups. Returns true when a script is actually removed.

pub fn set_extra_runtime_script(&mut self, content: &str)

Set extra runtime JavaScript code as a string.

The content must be valid JavaScript statements, ended by semicolon.

pub fn get_runtime_string(&self) -> String

Output js runtime environment js code string.

pub fn get_runtime_var_list() -> Vec<&'static str>

Output js runtime environment js var name list.

pub fn direct_dependencies<'a>( &'a self, path: &str, ) -> Result<impl Iterator<Item = String> + 'a, TmplError>

Get direct dependency template files.

pub fn script_dependencies<'a>( &'a self, path: &str, ) -> Result<impl Iterator<Item = String> + 'a, TmplError>

Get dependency script files.

pub fn inline_script_module_names<'a>( &'a self, path: &str, ) -> Result<impl Iterator<Item = &'a str>, TmplError>

Get inline script module names.

pub fn inline_script_start_line( &self, path: &str, module_name: &str, ) -> Result<u32, TmplError>

Get the start line of the inline script.

pub fn inline_script_content( &self, path: &str, module_name: &str, ) -> Result<&str, TmplError>

Get inline script content.

pub fn set_inline_script_content( &mut self, path: &str, module_name: &str, new_content: &str, ) -> Result<(), TmplError>

Set inline script content.

pub fn get_tmpl_gen_object(&self, path: &str) -> Result<String, TmplError>

Convert to WXML GenObject js string.

pub fn get_tmpl_gen_object_groups(&self) -> Result<String, TmplError>

Convert all to WXML GenObject js string.

pub fn get_wx_gen_object_groups(&self) -> Result<String, TmplError>

Convert all to WXML GenObject js string, with wx environment support.

pub fn export_globals(&self) -> Result<String, TmplError>

pub fn export_all_scripts(&self) -> Result<String, TmplError>

pub fn len(&self) -> usize

Returns the number of templates in the group.

pub fn contains_template(&self, path: &str) -> bool

Check if the group contains certain template.

pub fn list_template_trees(&self) -> impl Iterator<Item = (&str, &Template)>

List all available templates.

Trait Implementations

impl Debug for TmplGroup

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

Formats the value using the given formatter.