Struct Symbol 

pub struct Symbol { /* private fields */ }

Symbol

Every Symbol has a [SymbolDefinition], a parent and children. 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: SymbolDef, 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(builtin: Builtin) -> 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_builtin_fn( name: &'static str, parameters: impl Iterator<Item = (Identifier, ParameterValue)>, f: &'static BuiltinFn, doc: Option<&'static str>, ) -> Symbol

New builtin function as symbol.

pub fn replace(&mut self, replacement: Symbol)

Replace inner of a symbol with the inner of another.

impl Symbol

pub fn try_children<E: Error>( &self, f: impl FnMut((&Identifier, &Symbol)) -> Result<(), E>, ) -> Result<(), E>

Try to apply a FnMut for each child.

pub fn with_children(&self, f: impl FnMut((&Identifier, &Symbol)))

Apply a FnMut for each child.

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, f: &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 Display for Symbol

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

Formats the value using the given formatter.

impl FullyQualify for Symbol

fn full_name(&self) -> QualifiedName

Get fully qualified name.

impl Info for Symbol

fn info(&self) -> SymbolInfo

Get symbol information.

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 SrcReferrer for Symbol

fn src_ref(&self) -> SrcRef

Return source code reference.

fn source_hash(&self) -> u64

Return source code hash.