Struct Function

pub struct Function {
    pub ident: String,
    pub params: Vec<Parameter>,
    pub body: Vec<StatementNode>,
    pub docs: Option<String>,
    pub return_type: VarType,
}

A function statement, the basis for the whole language.

Syntax example

fun number_adder(first_num: int, second_num: int) -> int {
    --snip--
}

Fields

ident: String

Function identifier.

params: Vec<Parameter>

Parameters declared inside of the function signature.

body: Vec<StatementNode>

The main body inside of the function.

docs: Option<String>

A markdown-compatible String that is a documenation comment.

NOTE: This may be bound to a trait in the future to extend to other datatypes.

return_type: VarType

Expected return type inside of the function signature.

Trait Implementations

impl Debug for Function

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

Formats the value using the given formatter.

impl PartialEq for Function

fn eq(&self, other: &Function) -> 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 StructuralPartialEq for Function