Struct bracket::render::scope::Scope

pub struct Scope { /* fields omitted */ }

A scope encapsulates a base value (lookup object) used when resolving variable paths and a collection of local variables which are prefixed using the @ symbol.

Helpers can create scopes and push and pop them from the scope stack to create new variable evaluation contexts.

Implementations

impl Scope

pub fn new() -> Self

Create a new scope.

pub fn locals(&self) -> &Value

Get the underlying locals value.

pub fn set_local(&mut self, name: &str, value: Value)

Set a named local variable.

The name does not need an @ prefix it is automatically prepended to the key.

pub fn local(&self, name: &str) -> Option<&Value>

Get a named local.

Locals should have the @ prefix.

pub fn set_base_value(&mut self, value: Value)

Set the base value for the scope.

When the renderer resolves variables if they can be resolved using this value they are preferred over the root object.

pub fn base_value(&self) -> &Option<Value>

Get the base value for this scope.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl From<Map<String, Value>> for Scope

Create a Scope from a locals map.

fn from(map: Map<String, Value>) -> Self

Performs the conversion.