Struct Template

pub struct Template { /* private fields */ }

Represents a MediaWiki template ({{foo}})

How to access values from an existing template:

let code = client.transform_to_html("{{1x|test}}").await?.into_mutable();
// Get the `Template` instance
let template = code.filter_templates()?[0].clone();
assert_eq!(template.name(), "Template:1x".to_string());
assert_eq!(template.raw_name(), "./Template:1x".to_string());
assert_eq!(template.name_in_wikitext(), "1x".to_string());
assert_eq!(template.param("1"), Some("test".to_string()));

How to create and insert a new template:

let mut params = map::IndexMap::new();
params.insert("1".to_string(), "test".to_string());
let template = Template::new("1x", &params)?;
let code = Wikicode::new("");
code.append(&template);
let wikitext = client.transform_to_wikitext(&code).await?;
assert_eq!(wikitext, "{{1x|test}}".to_string());

You can also use Template::new_simple() if there are no parameters to pass.

Implementations

impl Template

pub fn new_simple(name: &str) -> Self

Create a new template with no parameters

pub fn new(name: &str, params: &IndexMap<String, String>) -> Result<Self>

Create a new template

pub fn remove_param(&self, name: &str) -> Result<Option<String>>

Remove the specified parameter from the template. If it was set, the previous value will be returned.

pub fn set_param(&self, name: &str, wikitext: &str) -> Result<Option<String>>

Set the specified wikitext as a template parameter with the given name

The previous value, if one was set, will be returned.

pub fn set_params( &self, map: impl Into<IndexMap<String, String>>, ) -> Result<IndexMap<String, String>>

Override all parameters with the specified map. A map of all previously set parameters and their values will be returned.

pub fn name_in_wikitext(&self) -> String

Get the name of the template as it appears in wikitext

pub fn set_name(&self, name: String) -> Result<()>

Change the name of the template or parser function. Note that the name should be how the name in wikitext. For example, "1x" for a Template:1x,

pub fn raw_name(&self) -> String

Get the full name of the template, e.g. ./Template:Foo_bar or the parser function, e.g. ifeq.

pub fn name(&self) -> String

Get a pretty normalized name of a template, e.g. Template:Foo bar or the parser function, e.g. ifeq

pub fn params(&self) -> IndexMap<String, String>

Get a map of all parameters, named and unnamed

pub fn param(&self, name: &str) -> Option<String>

Get the wikitext value of a specific parameter if it exists

pub fn param_in_wikitext(&self, name: &str) -> Option<String>

Get the name of the parameter as it appears in the wikitext. For example given {{1x|param<!--comment-->name=value}} looking up paramname would return Some("param<!--comment->name").

pub fn is_template(&self) -> bool

Whether it’s a template (as opposed to a parser function)

pub fn is_parser_function(&self) -> bool

Whether it’s a parser function (as opposed to a template)

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

Returns a copy 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 Display for Template

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

Formats the value using the given formatter.

impl WikiMultinode for Template

fn as_nodes(&self) -> Vec<NodeRef>

fn as_wikinodes(&self) -> WikinodeMap<IntoIter<NodeRef>>

fn detach(&self)

Remove this from the document