Struct Function

pub struct Function {
    pub name: Token,
    /* private fields */
}

Represents a function. This is a struct that wraps the function’s name, parameters, and body. It also contains a reference to the environment in which it was defined.

Fields

name: Token

Implementations

impl Function

pub fn new( stmt: Stmt, closure: Rc<RefCell<Environment>>, is_initializer: bool, ) -> Self

Creates a new function.

pub fn bind(&mut self, instance: Object) -> Self

Binds the function to an instance by wrapping its environment. This is used to allow the function to access the instance’s fields.

Trait Implementations

impl Callable for Function

fn call( &self, interpreter: &mut Interpreter<'_>, arguments: Vec<Object>, ) -> Result<Object, RuntimeError>

Calls the function (or method) and returns its return value. Function returns are handled by a special return type (ReturnError). A closure is created for the function’s environment and arguments are bound to it.

Note: Initializer methods will return the instance that they were called on.

fn arity(&self) -> usize

Returns the arity of the object.

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Display for Function

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

Formats the value using the given formatter.

impl From<Function> for Object

fn from(value: Function) -> Self

Converts to this type from the input type.

impl PartialEq for Function

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.