Struct melior::dialect::ods::memref::AllocaScopeOperation

pub struct AllocaScopeOperation<'c> { /* private fields */ }

An alloca_scope operation. Explicitly delimited scope for stack allocation.

The memref.alloca_scope operation represents an explicitly-delimited scope for the alloca allocations. Any memref.alloca operations that are used within this scope are going to be cleaned up automatically once the control-flow exits the nested region. For example:

memref.alloca_scope {
  %myalloca = memref.alloca(): memref<4x3xf32>
  ...
}

Here, %myalloca memref is valid within the explicitly delimited scope and is automatically deallocated at the end of the given region. Conceptually, memref.alloca_scope is a passthrough operation with AutomaticAllocationScope that spans the body of the region within the operation.

memref.alloca_scope may also return results that are defined in the nested region. To return a value, one should use memref.alloca_scope.return operation:

%result = memref.alloca_scope {
  ...
  memref.alloca_scope.return %value
}

If memref.alloca_scope returns no value, the memref.alloca_scope.return can be left out, and will be inserted implicitly.

Implementations

impl<'c> AllocaScopeOperation<'c>

pub fn name() -> &'static str

Returns a name.

pub fn as_operation(&self) -> &Operation<'c>

Returns a generic operation.

pub fn builder( context: &'c Context, location: Location<'c> ) -> AllocaScopeOperationBuilder<'c, Unset, Unset>

Creates a builder.

pub fn results(&self) -> impl Iterator<Item = OperationResult<'c, '_>>

pub fn body_region(&self) -> Result<RegionRef<'c, '_>, Error>

Trait Implementations

impl<'c> From<AllocaScopeOperation<'c>> for Operation<'c>

fn from(operation: AllocaScopeOperation<'c>) -> Self

Converts to this type from the input type.

impl<'c> TryFrom<Operation<'c>> for AllocaScopeOperation<'c>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(operation: Operation<'c>) -> Result<Self, Self::Error>

Performs the conversion.