Struct Function

pub struct Function {
    pub name: RefString,
    pub t: RefType,
    pub findex: RefFun,
    pub regs: Vec<RefType>,
    pub ops: Vec<Opcode>,
    pub debug_info: Option<Vec<(usize, usize)>>,
    pub assigns: Option<Vec<(RefString, usize)>>,
    pub parent: Option<RefType>,
}

A function definition with its code.

Fields

name: RefString

Functions have no name per se, this is the name of the field or method they are attached to

t: RefType

findex: RefFun

regs: Vec<RefType>

The types of the registers used by this function

ops: Vec<Opcode>

Instructions

debug_info: Option<Vec<(usize, usize)>>

Debug File and line information for each instruction

assigns: Option<Vec<(RefString, usize)>>

Debug Information about some variables names for some instructions

parent: Option<RefType>

Parent type (Obj/Struct) this function is a member of. This does not mean it’s a method

Implementations

impl Function

pub fn is_from_std(&self, code: &Bytecode) -> bool

return true if the function is from the standard library

pub fn find_fun_refs( &self, ) -> impl Iterator<Item = (usize, &Opcode, RefFun)> + '_

Find any outbound references to other functions in a function

pub fn find_last_closure_assign( &self, code: &Bytecode, reg: Reg, pos: usize, ) -> Option<RefFun>

Starting from a position in a function, finds the last time a register has been assigned a closure

impl Function

pub fn display_fmt<'a, Fmt: BytecodeFmt + 'a>( &'a self, bcfmt: Fmt, ctx: &'a Bytecode, ) -> impl Display + 'a

pub fn display<'a, Fmt: BytecodeFmt + Default + 'a>( &'a self, ctx: &'a Bytecode, ) -> impl Display + 'a

impl Function

pub fn display_header_fmt<'a, Fmt: BytecodeFmt + 'a>( &'a self, bcfmt: Fmt, ctx: &'a Bytecode, ) -> impl Display + 'a

pub fn display_header<'a, Fmt: BytecodeFmt + Default + 'a>( &'a self, ctx: &'a Bytecode, ) -> impl Display + 'a

impl Function

pub fn regtype(&self, reg: Reg) -> RefType

Get the type of a register

pub fn name(&self, code: &Bytecode) -> Str

Convenience method to resolve the function name

pub fn ty<'a>(&self, code: &'a Bytecode) -> &'a TypeFun

Get the function signature type

pub fn args<'a>(&self, code: &'a Bytecode) -> &'a [RefType]

Convenience method to resolve the function args

pub fn ret<'a>(&self, code: &'a Bytecode) -> &'a Type

Convenience method to resolve the function return type

pub fn arg_name(&self, code: &Bytecode, pos: usize) -> Option<Str>

Uses the assigns to find the name of an argument

pub fn var_name(&self, code: &Bytecode, pos: usize) -> Option<Str>

Uses the assigns to find the name of a variable

pub fn is_method(&self) -> bool

A function is a method if the first argument has the same type as the parent type

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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 Index<Reg> for Function

fn index(&self, index: Reg) -> &Self::Output

Get the type of a register

type Output = RefType

The returned type after indexing.