Struct Symbol 

pub struct Symbol { /* private fields */ }

Symbol

Implementations

impl Symbol

pub fn new_builtin_fn( name: &'static str, parameters: impl Iterator<Item = (Identifier, ParameterValue)>, f: &'static dyn Fn(&ParameterValueList, &ArgumentValueList, &mut EvalContext) -> Result<Value, Box<EvalError>>, doc: Option<&'static str>, ) -> Symbol

New builtin function as symbol.

pub fn full_name(&self) -> QualifiedName

Get fully qualified name.

impl Symbol

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

Get any child with the given id.

Arguments

• id: Anticipated id of the possible child.

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

Apply a FnMut for each child.

pub fn iter(&self) -> Children

Return iterator over symbol’s children.

pub fn riter(&self) -> RecurseChildren

Iterate recursively

pub fn kind_ref(&self) -> Option<SrcRef>

Get the SrcRef for the kind keyword of this symbol, if any

impl Symbol

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.

impl Symbol

pub fn id(&self) -> Identifier

Return the internal id of this symbol.

pub fn with_def<T>(&self, f: impl FnMut(&SymbolDef) -> T) -> T

Work with the symbol definition.

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<(), Error>

Formats the value using the given formatter.

impl Default for Symbol

fn default() -> Symbol

Returns the “default value” for a type.

impl Display for Symbol

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

Formats the value using the given formatter.

impl Doc for Symbol

fn inner_doc(&self) -> DocBlock

Fetch inner documentation.

fn outer_doc(&self) -> DocBlock

Fetch outer documentation.

fn doc(&self) -> DocBlock

Return block of documentation.

impl Lookup for Symbol

fn lookup( &self, name: &QualifiedName, target: LookupTarget, ) -> Result<Symbol, ResolveError>

Lookup a symbol from global symbols.

fn ambiguity_error( ambiguous: QualifiedName, others: QualifiedNames, ) -> ResolveError

Return an ambiguity error.

fn lookup_within( &self, name: &QualifiedName, within: &Symbol, target: LookupTarget, ) -> Result<Symbol, E>

Search a symbol by it’s qualified name and within the given symbol.

fn lookup_within_opt( &self, name: &QualifiedName, within: &Option<Symbol>, target: LookupTarget, ) -> Result<Symbol, E>

Search a symbol by it’s qualified name and within a given symbol

impl PartialEq for Symbol

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

Equality operator ==.

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

Inequality operator !=.

impl SrcReferrer for Symbol

fn src_ref(&self) -> SrcRef

Return source code reference.

fn source_hash(&self) -> u64

Return source code hash.

impl TreeDisplay for Symbol

fn tree_print( &self, f: &mut Formatter<'_>, state: TreeState, ) -> Result<(), Error>

Write item into f and use {:depth$} syntax in front of your single line output to get proper indention.