Struct leo_asg::scope::Scope

pub struct Scope<'a> {
    pub context: AsgContext<'a>,
    pub id: u32,
    pub parent_scope: Cell<Option<&'a Scope<'a>>>,
    pub function: Cell<Option<&'a Function<'a>>>,
    pub circuit_self: Cell<Option<&'a Circuit<'a>>>,
    pub variables: RefCell<IndexMap<String, &'a Variable<'a>>>,
    pub functions: RefCell<IndexMap<String, &'a Function<'a>>>,
    pub circuits: RefCell<IndexMap<String, &'a Circuit<'a>>>,
    pub input: Cell<Option<Input<'a>>>,
}

An abstract data type that track the current bindings for variables, functions, and circuits.

Fields

context: AsgContext<'a>

id: u32

The unique id of the scope.

parent_scope: Cell<Option<&'a Scope<'a>>>

The parent scope that this scope inherits.

function: Cell<Option<&'a Function<'a>>>

The function definition that this scope occurs in.

circuit_self: Cell<Option<&'a Circuit<'a>>>

The circuit definition that this scope occurs in.

variables: RefCell<IndexMap<String, &'a Variable<'a>>>

Maps variable name => variable.

functions: RefCell<IndexMap<String, &'a Function<'a>>>

Maps function name => function.

circuits: RefCell<IndexMap<String, &'a Circuit<'a>>>

Maps circuit name => circuit.

input: Cell<Option<Input<'a>>>

The main input to the program.

Implementations

impl<'a> Scope<'a>

pub fn resolve_variable(&self, name: &str) -> Option<&'a Variable<'a>>

Returns a reference to the variable corresponding to the name.

If the current scope did not have this name present, then the parent scope is checked. If there is no parent scope, then None is returned.

pub fn resolve_current_function(&self) -> Option<&'a Function<'_>>

Returns a reference to the current function.

If the current scope did not have a function present, then the parent scope is checked. If there is no parent scope, then None is returned.

pub fn resolve_input(&self) -> Option<Input<'a>>

Returns a reference to the current input.

If the current scope did not have an input present, then the parent scope is checked. If there is no parent scope, then None is returned.

pub fn resolve_function(&self, name: &str) -> Option<&'a Function<'a>>

Returns a reference to the function corresponding to the name.

If the current scope did not have this name present, then the parent scope is checked. If there is no parent scope, then None is returned.

pub fn resolve_circuit(&self, name: &str) -> Option<&'a Circuit<'a>>

Returns a reference to the circuit corresponding to the name.

If the current scope did not have this name present, then the parent scope is checked. If there is no parent scope, then None is returned.

pub fn resolve_circuit_self(&self) -> Option<&'a Circuit<'a>>

Returns a reference to the current circuit.

If the current scope did not have a circuit self present, then the parent scope is checked. If there is no parent scope, then None is returned.

pub fn make_subscope(self: &'a Scope<'a>) -> &'a Scope<'a>

Returns a new scope given a parent scope.

pub fn resolve_ast_type(
    &self,
    type_: &Type
) -> Result<Type<'a>, AsgConvertError>

Returns the type returned by the current scope.

Trait Implementations

impl<'a> Clone for Scope<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.