Struct midenc_codegen_masm::Region

pub struct Region {
    pub body: BlockId,
    pub blocks: PrimaryMap<BlockId, Block>,
}

This struct represents a region of code in Miden Assembly.

A region is a tree of blocks with isolated scope. In many ways a Region is basically a Function, just without any identity. Additionally, a Region does not have local variables, those must be provided by a parent Function.

In short, this represents both the body of a function, and the body of a begin block in Miden Assembly.

Fields

body: BlockId

blocks: PrimaryMap<BlockId, Block>

Implementations

impl Region

pub const fn id(&self) -> BlockId

Get the BlockId for the block which forms the body of this region

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 get(&self, ip: InstructionPointer) -> Option<Span<Op>>

Get the instruction under ip, if valid

pub fn create_block(&mut self) -> BlockId

Allocate a new code block in this region

pub fn display<'a, 'b: 'a>( &'b self, function: Option<FunctionIdent>, imports: &'b ModuleImportInfo, ) -> DisplayRegion<'a>

Render the code in this region as Miden Assembly, at the specified indentation level (in units of 4 spaces)

pub fn to_block( &self, imports: &ModuleImportInfo, locals: &BTreeSet<FunctionIdent>, ) -> Block

Convert this Region to a miden_assembly::ast::Block using the provided local/external function maps to handle calls present in the body of the region.

pub fn from_block(current_module: Ident, code: &Block) -> Self

Create a Region from a [miden_assembly::ast::CodeBody] and the set of imports and local procedures which will be used to map references to procedures to their fully-qualified names.

Trait Implementations

impl Clone for Region

fn clone(&self) -> Region

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl Default for Region

fn default() -> Self

Returns the “default value” for a type.

impl Index<InstructionPointer> for Region

type Output = MasmOp

The returned type after indexing.

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

Performs the indexing (container[index]) operation.