Struct brane_dsl::symbol_table::FunctionEntry

pub struct FunctionEntry {
    pub name: String,
    pub signature: FunctionSignature,
    pub params: Vec<Rc<RefCell<VarEntry>>>,
    pub package_name: Option<String>,
    pub package_version: Option<Version>,
    pub class_name: Option<String>,
    pub arg_names: Vec<String>,
    pub requirements: Option<HashSet<Capability>>,
    pub index: usize,
    pub range: TextRange,
}

Defines a function entry within the SymbolTable.

Fields

name: String

The name of the function entry.

signature: FunctionSignature

The signature of the function entry.

params: Vec<Rc<RefCell<VarEntry>>>

References to entries that form the Function’s parameters.

package_name: Option<String>

If set to non-zero, then this function is imported from a package with the given name.

package_version: Option<Version>

If set to non-zero, then this function is imported from a package with the given version.

class_name: Option<String>

If set to non-zero, then this function is a method in the class with the given name.

arg_names: Vec<String>

If this function is external (i.e., package_name is not None), then this list represents the name of each of the arguments. It will thus always be as long as the number of arguments in that case (and empty otherwise).

requirements: Option<HashSet<Capability>>

Any requirements the function has in terms of hardware support. Only ever not-None if an external function.

index: usize

The index in the workflow buffer of this function.

range: TextRange

Points to the entire function definition (or import).

Implementations

impl FunctionEntry

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

Creates a FunctionEntry as if it was defined as a builtin function.

Generic arguments

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

Arguments

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

Returns

A new FunctionEntry that has no package or class set, but does have type information populated.

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

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

Generic arguments

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

Arguments

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

Returns

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

pub fn from_import<S1: Into<String>, S2: Into<String>>( name: S1, signature: FunctionSignature, package: S2, package_version: Version, arg_names: Vec<String>, requirements: HashSet<Capability>, range: TextRange, ) -> Self

Creates a FunctionEntry as if it was imported by the given package.

Generic arguments

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

Arguments

• name: The name of the FunctionEntry.
• signature: The FunctionSignature of this function.
• package: The name of the package to which this function belongs.
• package_version: The version of the package to which this function belongs.
• arg_names: The names of the arguments (corresponds index-wise to the signature::arg list).
• requirements: The list of hardware requirements (as Capabilities) as defined in the function’s package file.
• range: The TextRange that points to the definition itself (i.e., the import statement).

Returns

A new FunctionEntry that has the given package set, and not yet any type information populated.

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

Creates a FunctionEntry as if it was a class method.

Generic arguments

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

Arguments

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

Returns

A new FunctionEntry that has the given class set, and not yet any type information populated.

Trait Implementations

impl Clone for FunctionEntry

fn clone(&self) -> FunctionEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionEntry

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

Formats the value using the given formatter.