Struct brane_dsl::symbol_table::VarEntry

pub struct VarEntry {
    pub name: String,
    pub data_type: DataType,
    pub function_name: Option<String>,
    pub class_name: Option<String>,
    pub index: usize,
    pub range: TextRange,
}

Defines a regular variable entry within the SymbolTable.

Fields

name: String

The name/identifier of the variable.

data_type: DataType

The data type of the variable (i.e., its signature).

A DataType of DataType::Any indicates that the data type may still need to be resolved in the typing phase. After that, though, it means there is not enough information to actually determine the variable’s type at compile time.

function_name: Option<String>

If this variable is actually a parameter of a function, the this field contains the function’s name.

class_name: Option<String>

If this variable is actually a property of a class, the this field contains the class’s name.

index: usize

The index in the workflow buffer of this variable.

range: TextRange

The range that points to the entire definition of the variable entry.

Implementations

impl VarEntry

pub fn from_def<S: Into<String>>(name: S, range: TextRange) -> Self

Creates a VarEntry as if it was defined in the source text.

Generic arguments

• S: The String-like type of the variable’s name.

Arguments

• name: The name of the VarEntry.
• range: The TextRange that points to the definition itself.

Returns

A new VarEntry that has no function or class set, and not yet any type information populated.

pub fn from_param<S1: Into<String>, S2: Into<String>>( name: S1, function: S2, range: TextRange, ) -> Self

Creates a VarEntry as if it was a parameter of a function.

Generic arguments

• S1: The String-like type of the variable’s name.
• S2: The String-like type of the function.

Arguments

• name: The name of the VarEntry.
• function: The name of the function to which this variable belongs.
• range: The TextRange that points to the definition itself (i.e., the import statement).

Returns

A new VarEntry that has the given function set but not yet any type information populated.

pub fn from_prop<S1: Into<String>, D: Into<DataType>, S2: Into<String>>( name: S1, data_type: D, class: S2, range: TextRange, ) -> Self

Creates a VarEntry as if it was a property of a class.

Generic arguments

• S1: The String-like type of the variable’s name.
• D: The DataType-like type of the data_type.
• S2: The String-like type of the class.

Arguments

• name: The name of the VarEntry.
• data_type: The DataType of this property.
• class: The name of the class to which this variable belongs.
• range: The TextRange that points to the definition itself (i.e., the import statement).

Returns

A new VarEntry that has the given class set but not yet any type information populated.

Trait Implementations

impl Clone for VarEntry

fn clone(&self) -> VarEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VarEntry

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

Formats the value using the given formatter.