Struct Symbol 

pub struct Symbol { /* private fields */ }

Symbol

Every Symbol has a SymbolDefinition, a parent and children stored within a Rc<RefCell<SymbolInner>. So Symbol is meant as a tree which is used by [SymbolTable] to store the resolved symbols by it’s original structure in the source code and by it’s id.

Symbol can be shared as mutable.

Implementations

impl Symbol

pub fn new(def: SymbolDefinition, parent: Option<Symbol>) -> Self

Create new symbol without children.

Arguments

• visibility: Visibility of the symbol
• def: Symbol definition
• parent: Symbol’s parent symbol or none for root

pub fn new_builtin( id: Identifier, parameters: Option<ParameterValueList>, f: &'static BuiltinFn, ) -> Symbol

Create a symbol node for a built-in.

Arguments

• id: Name of the symbol
• parameters: Optional parameter list
• f: The builtin function

pub fn new_call_argument(id: Identifier, value: Value) -> Symbol

Create a new argument (SymbolDefinition::Argument).

pub fn print_symbol( &self, f: &mut impl Write, id: Option<&Identifier>, depth: usize, children: bool, ) -> Result

Print out symbols from that point.

Arguments

• f: Output formatter
• id: Overwrite symbol’s internal id with this one if given (e.g. when using in a map).
• depth: Indention depth to use

pub fn add_child(parent: &Symbol, child: Symbol)

Insert child and change parent of child to new parent.

Arguments

• parent: New parent symbol (will be changed in child!).
• child: Child to insert

pub fn move_children(&self, from: &Symbol)

Move all children from another symbol into this one.

Arguments

• from: Append this symbol’s children

Technically, nothing will be moved here because of the Rc<RefCell<>>, but by resetting the parent of all moved children, those will see themselves as child of self (e.g when providing fully qualified name).

pub fn clone_with_visibility(&self, visibility: Visibility) -> Self

Clone this symbol but give the clone another visibility.

pub fn id(&self) -> Identifier

Return the internal id of this symbol.

pub fn get(&self, id: &Identifier) -> Option<Symbol>

Get any child with the given id.

Arguments

• id: Anticipated id of the possible child.

pub fn is_empty(&self) -> bool

True if symbol has any children

pub fn visibility(&self) -> Visibility

Return true if symbol’s visibility is private

pub fn is_public(&self) -> bool

Return true if symbol’s visibility set to is public.

pub fn is_private(&self) -> bool

Return true if symbol’s visibility set to is non-public.

pub fn search(&self, name: &QualifiedName) -> Option<Symbol>

Search down the symbol tree for a qualified name.

Arguments

• name: Name to search for.

pub fn can_const(&self) -> bool

check if a private symbol may be declared within this symbol

pub fn can_value(&self) -> bool

check if a value on the stack may be declared within this symbol

pub fn can_prop(&self) -> bool

check if a property may be declared within this symbol

pub fn can_pub(&self) -> bool

check if a public symbol may be declared within this symbol

pub fn set_value(&self, new_value: Value) -> ResolveResult<()>

Overwrite any value in this symbol

pub fn get_value(&self) -> ResolveResult<Value>

Get any value of this symbol

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Default for Symbol

fn default() -> Self

Returns the “default value” for a type.

impl DerefMut for Symbol

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for Symbol

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

Formats the value using the given formatter.

impl FromIterator<Symbol> for Symbols

fn from_iter<T: IntoIterator<Item = Symbol>>(iter: T) -> Self

Creates a value from an iterator.

impl FullyQualify for Symbol

fn full_name(&self) -> QualifiedName

Get fully qualified name.

impl PartialEq for Symbol

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Deref for Symbol

type Target = RcMut<SymbolInner>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.