Struct If 

pub struct If { /* private fields */ }

If is a structured control flow operation representing conditional execution.

An If takes a single condition as an argument, which chooses between one of its two regions based on the condition. If the condition is true, then the then_body region is executed, otherwise else_body.

Neither region allows any arguments, and both regions must be terminated with one of:

• midenc_hir::dialects::builtin::Ret to return from the enclosing function directly
• midenc_dialect_ub::Unreachable to abort execution
• Yield to return from the enclosing If

Implementations

impl If

Construction

pub fn create<B: ?Sized + Builder>( builder: &mut B, span: SourceSpan, condition: ValueRef, ) -> Result<UnsafeIntrusiveEntityRef<Self>, Report>

Manually construct a new If

It is generally preferable to use ::midenc_hir::BuilderExt::create instead.

pub fn alloc_default(context: Rc<Context>) -> UnsafeIntrusiveEntityRef<Self>

Allocate a new, default-initialized If

This method is used as part of op definition implementation, and should not be used directly if at all possible.

impl If

This impl block contains no public items.

User-defined Fields

impl If

This impl block contains no public items.

Attributes

impl If

This impl block contains no public items.

Symbols

impl If

Operands

pub fn condition(&self) -> EntityRef<'_, OpOperandImpl>

Get a reference to the condition operand.

pub fn condition_mut(&mut self) -> EntityMut<'_, OpOperandImpl>

Get a mutable reference to the condition operand.

impl If

Results

pub fn returns(&self) -> OpResultRange<'_>

Get a reference to the returns result group.

pub fn returns_mut(&mut self) -> OpResultRangeMut<'_>

Get a mutable reference to the returns result group.

impl If

Regions

pub fn then_body(&self) -> EntityRef<'_, Region>

Get a reference to the then_body region.

pub fn then_body_mut(&mut self) -> EntityMut<'_, Region>

Get a mutable reference to the then_body region.

pub fn else_body(&self) -> EntityRef<'_, Region>

Get a reference to the else_body region.

pub fn else_body_mut(&mut self) -> EntityMut<'_, Region>

Get a mutable reference to the else_body region.

impl If

This impl block contains no public items.

Successors

impl If

pub fn then_yield(&self) -> UnsafeIntrusiveEntityRef<Yield>

pub fn else_yield(&self) -> UnsafeIntrusiveEntityRef<Yield>

Trait Implementations

impl AsMut<Operation> for If

fn as_mut(&mut self) -> &mut Operation

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Operation> for If

fn as_ref(&self) -> &Operation

Converts this type into a shared reference of the (usually inferred) input type.

impl BuildableOp<(RawEntityRef<dyn Value<Id = ValueId, Use = OpOperandImpl>>,)> for If

type Builder<'a, T: ?Sized + Builder + 'a> = IfBuilder<'a, T>

fn builder<'b, B>(builder: &'b mut B, span: SourceSpan) -> Self::Builder<'b, B>

where B: ?Sized + Builder + 'b,

impl Canonicalizable for If

fn get_canonicalization_patterns( rewrites: &mut RewritePatternSet, context: Rc<Context>, )

Populate rewrites with the set of rewrite patterns that should be applied to canonicalize this operation.

impl HasRecursiveMemoryEffects for If

impl NoRegionArguments for If

impl Op for If

fn name(&self) -> OperationName

The name of this operation’s opcode

fn as_operation(&self) -> &Operation

fn as_operation_mut(&mut self) -> &mut Operation

fn print(&self, flags: &OpPrintingFlags) -> Document

fn as_operation_ref(&self) -> RawEntityRef<Operation, IntrusiveLink>

fn set_span(&mut self, span: SourceSpan)

fn parent(&self) -> Option<RawEntityRef<Block, IntrusiveLink>>

fn parent_region(&self) -> Option<RawEntityRef<Region, IntrusiveLink>>

fn parent_op(&self) -> Option<RawEntityRef<Operation, IntrusiveLink>>

fn num_regions(&self) -> usize

fn regions(&self) -> &EntityList<Region>

fn regions_mut(&mut self) -> &mut EntityList<Region>

fn region(&self, index: usize) -> EntityRef<'_, Region>

fn region_mut(&mut self, index: usize) -> EntityMut<'_, Region>

fn has_successors(&self) -> bool

fn num_successors(&self) -> usize

fn has_operands(&self) -> bool

fn num_operands(&self) -> usize

fn operands(&self) -> &EntityStorage<RawEntityRef<OpOperandImpl, IntrusiveLink>>

fn operands_mut( &mut self, ) -> &mut EntityStorage<RawEntityRef<OpOperandImpl, IntrusiveLink>>

fn has_results(&self) -> bool

fn num_results(&self) -> usize

fn results(&self) -> &EntityStorage<RawEntityRef<OpResult>>

fn results_mut(&mut self) -> &mut EntityStorage<RawEntityRef<OpResult>>

fn successors(&self) -> &EntityStorage<SuccessorInfo, 0>

fn successors_mut(&mut self) -> &mut EntityStorage<SuccessorInfo, 0>

impl OpParser for If

fn parse( state: &mut OperationState, parser: &mut dyn OpAsmParser<'_>, ) -> ParseResult

Parse the current operation into state using parser.

impl OpPrinter for If

fn print(&self, printer: &mut AsmPrinter<'_>)

Prints this operation with the given flags

impl OpRegistration for If

type Dialect = ScfDialect

fn name() -> Symbol

The name of the operation (i.e. its opcode)

fn attrs() -> Box<[AttrInfo]>

The set of statically known attributes for this op

fn traits() -> Box<[TraitInfo]>

The set of statically known traits for this op

fn alloc_uninit(context: Rc<Context>) -> OperationRef

Allocate a new, default-initialized instance of this op in context

fn dialect_name() -> Symbol

The name of the dialect this op is declared part of

fn full_name() -> Symbol

The fully-qualified name of the operation (i.e. <dialect>.<opcode>)

impl OpVerifier for If

Generated verifier implementation via #[operation] attribute

Traits verified by this implementation:

• SingleBlock
• NoRegionArguments
• HasRecursiveMemoryEffects
• RegionBranchOpInterface
• OpPrinter

Use cargo-expand to view the generated code if you suspect verification is broken.

fn verify(&self, context: &Context) -> Result<(), Report>

impl RegionBranchOpInterface for If

fn get_entry_successor_regions( &self, operands: &[Option<AttributeRef>], ) -> RegionSuccessorIter<'_>

Returns the potential region successors when first executing the op.

fn get_successor_regions( &self, point: RegionBranchPoint, ) -> RegionSuccessorIter<'_>

Returns the potential region successors when branching from point.

fn get_region_invocation_bounds( &self, operands: &[Option<AttributeRef>], ) -> SmallVec<[InvocationBounds; 1]>

Returns a set of invocation bounds, representing the minimum and maximum number of times this operation will invoke each attached region (assuming the regions yield normally, i.e. do not abort or invoke an infinite loop). The minimum number of invocations is at least 0. If the maximum number of invocations cannot be statically determined, then it will be set to InvocationBounds::Unknown.

fn is_repetitive_region(&self, _index: usize) -> bool

Returns true if control flow originating from the region at index may eventually branch back to the same region, either from itself, or after passing through other regions first.

fn has_loop(&self) -> bool

Returns true if there is a loop in the region branching graph.

fn get_entry_successor_operands( &self, point: RegionBranchPoint, ) -> SuccessorOperandRange<'_>

Returns the operands of this operation that are forwarded to the region successor’s block arguments or this operation’s results when branching to point. point is guaranteed to be among the successors that are returned by get_entry_succcessor_regions or get_successor_regions(parent_op()).

fn are_types_compatible(&self, lhs: &Type, rhs: &Type) -> bool

This function is called to compare types along control-flow edges.

impl SingleBlock for If

impl Spanned for If

fn span(&self) -> SourceSpan