Scope

Struct Scope 

Source
pub struct Scope { /* private fields */ }
Expand description

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§

Source§

impl Scope

Source

pub fn new() -> Self

Create a new scope.

Source

pub fn locals(&self) -> &Value

Get the underlying locals value.

Source

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.

Source

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

Get a named local.

Locals should have the @ prefix.

Source

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.

Source

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

Get the base value for this scope.

Trait Implementations§

Source§

impl Clone for Scope

Source§

fn clone(&self) -> Scope

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Scope

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Create a scope from a context and hash parameters.

Source§

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

Converts to this type from the input type.
Source§

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

Create a scope from hash parameters.

Source§

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

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Scope

§

impl RefUnwindSafe for Scope

§

impl Send for Scope

§

impl Sync for Scope

§

impl Unpin for Scope

§

impl UnwindSafe for Scope

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.