Struct SyntaxConfig

pub struct SyntaxConfig { /* private fields */ }

The delimiter configuration for the environment and the parser.

Custom syntax configurations require the custom_syntax feature. Otherwise just the default syntax is available.

You can override the syntax configuration for templates by setting different delimiters. The end markers can be shared, but the start markers need to be distinct. It would thus not be valid to configure {{ to be the marker for both variables and blocks.

let mut environment = Environment::new();
environment.set_syntax(
    SyntaxConfig::builder()
        .block_delimiters("\\BLOCK{", "}")
        .variable_delimiters("\\VAR{", "}")
        .comment_delimiters("\\#{", "}")
        .build()
        .unwrap()
);

Implementations

impl SyntaxConfig

pub fn builder() -> SyntaxConfigBuilder

Available on crate feature custom_syntax only.

Creates a syntax builder.

pub fn block_delimiters(&self) -> (&str, &str)

Returns the block delimiters.

pub fn variable_delimiters(&self) -> (&str, &str)

Returns the variable delimiters.

pub fn comment_delimiters(&self) -> (&str, &str)

Returns the comment delimiters.

Trait Implementations

impl Clone for SyntaxConfig

fn clone(&self) -> SyntaxConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SyntaxConfig

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

Formats the value using the given formatter.

impl Default for SyntaxConfig

fn default() -> Self

Returns the “default value” for a type.