Struct CompileOptions 

#[non_exhaustive]
pub struct CompileOptions<'a> {
    pub allow_unused: bool,
    pub base_dir: Option<&'a Path>,
    pub env: &'a [(&'a str, Value)],
}

Configuration for template compilation.

Collects all optional parameters that previously required separate constructor functions. Use with Template::compile or Template::compile_file.

Examples

use md_tmpl_core::CompileOptions;

// Default options (strict mode):
let opts = CompileOptions::default();

// Allow unused declared parameters:
let opts = CompileOptions::default().allow_unused(true);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allow_unused: bool

When true, declared parameters that are never referenced in the template body are allowed instead of producing an error.

Equivalent to allow_unused: true in frontmatter.

base_dir: Option<&'a Path>

Base directory for resolving {% include %} and {% import %} directives.

When None, includes are not resolved (suitable for in-memory templates).

env: &'a [(&'a str, Value)]

Compile-time environment variables (name-value pairs). Values are typed — they must match the type declared in env: frontmatter. String values for scalar types (int, bool, float) are auto-parsed.

Implementations

impl<'a> CompileOptions<'a>

pub fn base_dir(self, dir: &'a Path) -> CompileOptions<'a>

Set the base directory for include resolution.

impl<'a> CompileOptions<'a>

pub fn allow_unused(self, allow: bool) -> CompileOptions<'a>

Allow unused declared parameters.

pub fn env(self, pairs: &'a [(&'a str, Value)]) -> CompileOptions<'a>

Set compile-time environment variables.

Trait Implementations

impl<'a> Clone for CompileOptions<'a>

fn clone(&self) -> CompileOptions<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for CompileOptions<'a>

impl<'a> Debug for CompileOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CompileOptions<'a>

fn default() -> CompileOptions<'a>

Returns the “default value” for a type.