Struct midenc_codegen_masm::Function

pub struct Function {
    pub span: SourceSpan,
    pub attrs: AttributeSet,
    pub name: FunctionIdent,
    pub signature: Signature,
    pub body: Region,
    /* private fields */
}

This represents a function in Miden Assembly

Fields

span: SourceSpan

attrs: AttributeSet

The attributes associated with this function

name: FunctionIdent

The name of this function

signature: Signature

The type signature of this function

body: Region

The Region which forms the body of this function

Implementations

impl Function

pub fn new(name: FunctionIdent, signature: Signature) -> Self

pub fn is_entrypoint(&self) -> bool

Returns true if this function is decorated with the entrypoint attribute.

pub fn arity(&self) -> usize

Return the number of arguments expected on the operand stack

pub fn num_results(&self) -> usize

Return the number of results produced by this function

pub fn alloc_local(&mut self, ty: Type) -> LocalId

Allocate a new local in this function, using the provided data

The index of the local is returned as it’s identifier

pub fn alloc_n_locals(&mut self, n: u16)

Allocate n locals for use by this function.

Each local can be independently accessed, but they are all of type Felt

pub fn local(&self, id: LocalId) -> &Local

Get the local with the given identifier

pub fn locals(&self) -> &[Local]

Return the locals allocated in this function as a slice

pub fn body(&self) -> &Block

Get a reference to the entry block for this function

pub fn body_mut(&mut self) -> &mut Block

Get a mutable reference to the entry block for this function

pub fn create_block(&mut self) -> BlockId

Allocate a new code block in this function

pub fn block(&self, id: BlockId) -> &Block

Get a reference to a Block by BlockId

pub fn block_mut(&mut self, id: BlockId) -> &mut Block

Get a mutable reference to a Block by BlockId

pub fn invoked(&self) -> impl Iterator<Item = &Invoke> + '_

pub fn register_invoked(&mut self, kind: InvokeKind, target: InvocationTarget)

pub fn register_absolute_invocation_target( &mut self, kind: InvokeKind, target: FunctionIdent, )

pub fn display<'a, 'b: 'a>( &'b self, imports: &'b ModuleImportInfo, ) -> DisplayMasmFunction<'a>

Return an implementation of std::fmt::Display for this function

pub fn from_ast(module: Ident, proc: &Procedure) -> Box<Self>

pub fn to_ast( &self, imports: &ModuleImportInfo, locals: &BTreeSet<FunctionIdent>, tracing_enabled: bool, ) -> Procedure

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy 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 Spanned for Function

fn span(&self) -> SourceSpan