Skip to main content

Scope

Struct Scope 

Source
pub struct Scope(pub Rc<RefCell<ScopeData>>);
Expand description

A lexical environment: a table of bindings with an optional parent.

Name lookup (Scope::get) searches the scope itself and then its ancestors. New bindings (Scope::set) always go into the scope itself. A Scope is also the storage of a Value::Namespace.

Scope is a cheap handle: clones share the same bindings.

§Examples

use swan_core::value::{Scope, Value};

let parent = Scope::new();
parent.set("x", Value::Numb(1.0));

let child = parent.new_child();
child.set("y", Value::Numb(2.0));

assert_eq!(child.get("x"), Value::Numb(1.0));   // inherited
assert_eq!(parent.get("y"), Value::Nothing);    // not visible upwards

Tuple Fields§

§0: Rc<RefCell<ScopeData>>

Implementations§

Source§

impl Scope

Source

pub fn new() -> Self

Create a top-level scope with no parent.

Source

pub fn with_parent(parent: Scope) -> Self

Create a child scope that inherits from a parent.

Source

pub fn new_child(&self) -> Self

Creates a new child scope using self as the parent environment.

Source

pub fn get(&self, key: &str) -> Value

Returns the value bound to key in this scope or its nearest ancestor that binds it, or Value::Nothing if no scope binds it.

The borrow on self is released before recursing into the parent so that there is no live RefCell borrow held across the recursive call. This prevents a runtime panic in the (unlikely but possible) event that the same Scope node appears more than once in the chain.

Source

pub fn lift(&self, key: &str) -> Value

Returns the value bound to key in the outermost scope of the chain that binds it, or Value::Nothing if no scope binds it.

This is the opposite search order of Scope::get. It implements the Swan lifting operator $name.

Source

pub fn set(&self, key: impl Into<String>, val: Value)

Inserts or updates a binding in the current local scope only.

Trait Implementations§

Source§

impl Clone for Scope

Source§

fn clone(&self) -> Scope

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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 Eq for Scope

Source§

impl PartialEq for Scope

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Scope

§

impl !Send for Scope

§

impl !Sync for Scope

§

impl !UnwindSafe for Scope

§

impl Freeze for Scope

§

impl Unpin for Scope

§

impl UnsafeUnpin 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> 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.