Struct gf::pivot::basic_block::UnsealedBasicBlockBuilder

pub struct UnsealedBasicBlockBuilder<'a> { /* fields omitted */ }

⚪ Builder for unsealed basic blocks that simplifies constructing common code patterns.

Implementations

impl<'a> UnsealedBasicBlockBuilder<'a>

pub fn new(
    module_builder: &'a mut UnsealedModuleBuilder,
    root_basic_block: BasicBlockId
) -> Self

Create a builder.

Errors

• Panics if the root basic block does not exist.
• Panics if the root basic block is not a stub.

pub fn module_builder(&self) -> &UnsealedModuleBuilder

Return a shared reference to the module builder.

pub fn module_builder_mut(&mut self) -> &mut UnsealedModuleBuilder

Return a mutable reference to the module builder.

pub fn add_stmt<S: Into<UnsealedStmt>>(
    &mut self,
    basic_block: BasicBlockId,
    stmt: S
)

Add a statement at the end of a basic block.

Errors

• Panics if the basic block is not managed by this builder.

pub fn add_split(&mut self, basic_block: BasicBlockId) -> BasicBlockId

Terminate the basic block and start a new one as its successor.

The returned value in the successor ID.

Errors

• Panics if the basic block is not managed by this builder.

pub fn add_if(
    &mut self,
    basic_block: BasicBlockId,
    branch_var: Var
) -> (BasicBlockId, BasicBlockId, BasicBlockId)

Add an if-then-else at the end of a basic block.

The three returned values are the “then,” the “else,” and the “join” basic blocks IDs.

Errors

• Panics if the basic block is not managed by this builder.

pub fn add_while(
    &mut self,
    basic_block: BasicBlockId,
    branch_var: Var
) -> (BasicBlockId, BasicBlockId)

Add a while loop at the end of the basic block.

The two returned values are the “loop” and the “join” basic block IDs.

Errors

• Panics if the basic block is not managed by this builder.

Trait Implementations

impl<'a> Debug for UnsealedBasicBlockBuilder<'a>

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

Formats the value using the given formatter.