Struct melior::dialect::ods::func::FuncOperation

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

A func operation. An operation with a name containing a single SSACFG region.

Operations within the function cannot implicitly capture values defined outside of the function, i.e. Functions are IsolatedFromAbove. All external references must use function arguments or attributes that establish a symbolic connection (e.g. symbols referenced by name via a string attribute like SymbolRefAttr). An external function declaration (used when referring to a function declared in some other module) has no body. While the MLIR textual form provides a nice inline syntax for function arguments, they are internally represented as “block arguments” to the first block in the region.

Only dialect attribute names may be specified in the attribute dictionaries for function arguments, results, or the function itself.

Example:

// External function definitions.
func.func @abort()
func.func @scribble(i32, i64, memref<? x 128 x f32, #layout_map0>) -> f64

// A function that returns its argument twice:
func.func @count(%x: i64) -> (i64, i64)
  attributes {fruit: "banana"} {
  return %x, %x: i64, i64
}

// A function with an argument attribute
func.func @example_fn_arg(%x: i32 {swift.self = unit})

// A function with a result attribute
func.func @example_fn_result() -> (f64 {dialectName.attrName = 0 : i64})

// A function with an attribute
func.func @example_fn_attr() attributes {dialectName.attrName = false}

Implementations

impl<'c> FuncOperation<'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> ) -> FuncOperationBuilder<'c, Unset, Unset, Unset>

Creates a builder.

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

pub fn sym_name(&self) -> Result<StringAttribute<'c>, Error>

pub fn set_sym_name(&mut self, value: StringAttribute<'c>)

pub fn function_type(&self) -> Result<TypeAttribute<'c>, Error>

pub fn set_function_type(&mut self, value: TypeAttribute<'c>)

pub fn sym_visibility(&self) -> Result<StringAttribute<'c>, Error>

pub fn set_sym_visibility(&mut self, value: StringAttribute<'c>)

pub fn remove_sym_visibility(&mut self) -> Result<(), Error>

pub fn arg_attrs(&self) -> Result<ArrayAttribute<'c>, Error>

pub fn set_arg_attrs(&mut self, value: ArrayAttribute<'c>)

pub fn remove_arg_attrs(&mut self) -> Result<(), Error>

pub fn res_attrs(&self) -> Result<ArrayAttribute<'c>, Error>

pub fn set_res_attrs(&mut self, value: ArrayAttribute<'c>)

pub fn remove_res_attrs(&mut self) -> Result<(), Error>

Trait Implementations

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

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

Converts to this type from the input type.

impl<'c> TryFrom<Operation<'c>> for FuncOperation<'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.