Struct hatter::Env

pub struct Env { /* fields omitted */ }

Env is the top-level environment in which a Hatter template is evaluated and rendered.

Implementations

impl Env

pub fn new() -> Env

New, top-level Env.

pub fn out(&mut self) -> String

Return and clear output.

pub fn empty_args(&mut self) -> Args<'_>

Create an empty Args struct, to call a helper function.

pub fn scope(&self) -> &Scope

Nearest (currently active) scope.

pub fn push_scope(&mut self)

Add a new scope to the stack, which becomes active.

pub fn pop_scope(&mut self)

Kill the active scope.

pub fn mut_scope(&mut self) -> &mut Scope

Nearest (currently active) scope.

pub fn var_exists(&self, key: &str) -> bool

Does a value exist in this or any parent scopes?

pub fn lookup(&self, key: &str) -> Option<Ref<'_, Value>>

Find a value, looking first in the most recently pushed scope.

pub fn set<V: Into<Value>>(&self, key: &str, val: V)

Set a value to the nearest scope.

pub fn update<V: Into<Value>>(&self, key: &str, val: V)

Set a value in a parent scope, or create it in the nearest.

pub fn print<V: Into<Value>>(&mut self, val: V)

Add something to our render buffer without a trailing line.

pub fn render(&mut self, source: &str) -> Result<String>

Render statements into a String.

pub fn block(&mut self, stmts: &[Stmt]) -> Result<Value>

Evaluate a block of statements, returning the last one.

pub fn printed_block(&mut self, stmts: &[Stmt]) -> Result<Value>

Evaluate a block of statements and print what each returns. "Outside of a tag, tags are printed. Inside of a tag, everything is printed."

pub fn eval_src(&mut self, src: &str) -> Result<Value>

Evaluate source code, returning its Value.

pub fn eval(&mut self, stmt: &Stmt) -> Result<Value>

Evaluate one statement, returning its Value.

Trait Implementations

impl Debug for Env

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

Formats the value using the given formatter.

impl Default for Env

fn default() -> Env

Returns the "default value" for a type.