Struct brane_dsl::symbol_table::SymbolTable

pub struct SymbolTable {
    pub parent: Option<Rc<RefCell<SymbolTable>>>,
    /* private fields */
}

Defines a SymbolTable that contains all definitions of a single scope.

Fields

parent: Option<Rc<RefCell<SymbolTable>>>

Contains the parent symbol table, if any.

Implementations

impl SymbolTable

pub fn new() -> Rc<RefCell<Self>>

Constructor for the SymbolTable.

Returns

A new SymbolTable that does not have any definitions within it yet. It is already wrapped in an Rc and RefCell for convenience.

pub fn add_func( &mut self, entry: FunctionEntry, ) -> Result<Rc<RefCell<FunctionEntry>>, Error>

Adds the given FunctionEntry to the function namespace in the SymbolTable.

Arguments

• entry: The new FunctionEntry to add.

Returns

The newly created entry (or rather, a reference-counted pointer to it).

Errors

This function may error if an entry with this name in this namespace already exists.

pub fn add_class( &mut self, entry: ClassEntry, ) -> Result<Rc<RefCell<ClassEntry>>, Error>

Adds the given ClassEntry to the class namespace in the SymbolTable.

Arguments

• entry: The new ClassEntry to add.

Returns

The newly created entry (or rather, a reference-counted pointer to it).

Errors

This function may error if an entry with this name in this namespace already exists.

pub fn add_var( &mut self, entry: VarEntry, ) -> Result<Rc<RefCell<VarEntry>>, Error>

Adds the given VarEntry to the variable namespace in the SymbolTable.

Arguments

• entry: The new VarEntry to add.

Returns

The newly created entry (or rather, a reference-counted pointer to it).

Errors

This function may error if an entry with this name in this namespace already exists.

pub fn get<S: AsRef<str>>(&self, name: S) -> Option<SymbolTableEntry>

Returns the entry in all namespaces with the given name if it exists.

This implies that the name is unique across namespaces, so it relies on an external source to make that happen.

If that somehow fails, returns the first occurrence in the order of functions -> classes -> variables.

Generic arguments

• S: The &str-like type of the target name.

Arguments

• name: The name of the entry to retrieve.

Returns

A reference-counter pointer to the entry if it exists, or else None.

pub fn get_func<S: AsRef<str>>( &self, name: S, ) -> Option<Rc<RefCell<FunctionEntry>>>

Returns the entry in the function namespace with the given name if it exists.

Generic arguments

• S: The &str-like type of the target name.

Arguments

• name: The name of the entry to retrieve.

Returns

A reference-counter pointer to the entry if it exists, or else None.

pub fn get_class<S: AsRef<str>>( &self, name: S, ) -> Option<Rc<RefCell<ClassEntry>>>

Returns the entry in the class namespace with the given name if it exists.

Generic arguments

• S: The &str-like type of the target name.

Arguments

• name: The name of the entry to retrieve.

Returns

A reference-counter pointer to the entry if it exists, or else None.

pub fn get_var<S: AsRef<str>>(&self, name: S) -> Option<Rc<RefCell<VarEntry>>>

Returns the entry in the variable namespace with the given name if it exists.

Generic arguments

• S: The &str-like type of the target name.

Arguments

• name: The name of the entry to retrieve.

Returns

A reference-counter pointer to the entry if it exists, or else None.

pub fn has_functions(&self) -> bool

Returns whether this SymbolTable has any functions defined at all.

pub fn n_functions(&self) -> usize

Returns the number of functions defined in the SymbolTable.

pub fn functions(&self) -> Iter<'_, String, Rc<RefCell<FunctionEntry>>>

Returns an iterator over the defined functions (as (name, entry) pairs).

Returns

The iterator returned by the internal HashMap.

pub fn functions_mut( &mut self, ) -> IterMut<'_, String, Rc<RefCell<FunctionEntry>>>

Returns a muteable iterator over the defined functions (as (name, entry) pairs).

Returns

The iterator returned by the internal HashMap.

pub fn into_functions(&mut self) -> IntoIter<String, Rc<RefCell<FunctionEntry>>>

Returns a consuming iterator over the defined functions (as (name, entry) pairs).

Returns

The iterator returned by the internal HashMap.

pub fn has_classes(&self) -> bool

Returns whether this SymbolTable has any classes defined at all.

pub fn n_classes(&self) -> usize

Returns the number of classes defined in the SymbolTable.

pub fn classes(&self) -> Iter<'_, String, Rc<RefCell<ClassEntry>>>

Returns an iterator over the defined classes (as (name, entry) pairs).

Returns

The iterator returned by the internal HashMap.

pub fn classes_mut(&mut self) -> IterMut<'_, String, Rc<RefCell<ClassEntry>>>

Returns a muteable iterator over the defined classes (as (name, entry) pairs).

Returns

The iterator returned by the internal HashMap.

pub fn into_classes(&mut self) -> IntoIter<String, Rc<RefCell<ClassEntry>>>

Returns a consuming iterator over the defined classes (as (name, entry) pairs).

Returns

The iterator returned by the internal HashMap.

pub fn has_variables(&self) -> bool

Returns whether this SymbolTable has any variables defined at all.

pub fn n_variables(&self) -> usize

Returns the number of variables defined in the SymbolTable.

pub fn variables(&self) -> Iter<'_, String, Rc<RefCell<VarEntry>>>

Returns an iterator over the defined variables (as (name, entry) pairs).

Returns

The iterator returned by the internal HashMap.

pub fn variables_mut(&mut self) -> IterMut<'_, String, Rc<RefCell<VarEntry>>>

Returns a muteable iterator over the defined variables (as (name, entry) pairs).

Returns

The iterator returned by the internal HashMap.

pub fn into_variables(&mut self) -> IntoIter<String, Rc<RefCell<VarEntry>>>

Returns a consuming iterator over the defined variables (as (name, entry) pairs).

Returns

The iterator returned by the internal HashMap.

Trait Implementations

impl Clone for SymbolTable

fn clone(&self) -> SymbolTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolTable

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

Formats the value using the given formatter.