Struct BeamFunction 

pub struct BeamFunction {
    pub name: String,
    pub arity: usize,
    pub clauses: Vec<BeamClause>,
    pub params: Vec<String>,
    pub annotations: Vec<(String, String)>,
    pub exported: bool,
    pub instrs: Vec<BeamInstr>,
    pub frame_size: u32,
    pub return_type: Option<BeamType>,
    pub param_types: Vec<BeamType>,
}

A function in a BEAM module.

Fields

name: String

Function name (atom)

arity: usize

Number of formal parameters

clauses: Vec<BeamClause>

Core Erlang style clauses (pattern, guard, body)

params: Vec<String>

Optional parameter names (for documentation)

annotations: Vec<(String, String)>

Key-value annotations (e.g., {file, "foo.erl"})

exported: bool

Whether this function is exported

instrs: Vec<BeamInstr>

Low-level instruction sequence (populated by lowering pass)

frame_size: u32

Number of Y-register (stack) slots needed

return_type: Option<BeamType>

Return type annotation

param_types: Vec<BeamType>

Parameter type annotations

Implementations

impl BeamFunction

pub fn new(name: impl Into<String>, arity: usize) -> Self

Create a new function with the given name and arity.

pub fn add_clause(&mut self, clause: BeamClause)

Add a clause to this function.

pub fn annotate(&mut self, key: impl Into<String>, value: impl Into<String>)

Add an annotation.

pub fn export(&mut self)

Mark as exported.

pub fn key(&self) -> String

Get the function’s name/arity key.

Trait Implementations

impl Clone for BeamFunction

fn clone(&self) -> BeamFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BeamFunction

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

Formats the value using the given formatter.