Struct sway_ir::function::Function

pub struct Function(pub Index);

A wrapper around an ECS handle into the Context.

Tuple Fields

0: Index

Implementations

impl Function

pub fn new(
    context: &mut Context,
    module: Module,
    name: String,
    args: Vec<(String, Type, Option<MetadataIndex>)>,
    return_type: Type,
    selector: Option<[u8; 4]>,
    is_public: bool,
    metadata: Option<MetadataIndex>
) -> Function

Return a new Function handle.

Creates a Function in the context within module and returns a handle.

name, args, return_type and is_public are the usual suspects. selector is a special value used for Sway contract calls; much like name is unique and not particularly used elsewhere in the IR.

pub fn create_block(&self, context: &mut Context, label: Option<Label>) -> Block

Create and append a new Block to this function.

pub fn create_block_before(
    &self,
    context: &mut Context,
    other: &Block,
    label: Option<Label>
) -> Result<Block, IrError>

Create and insert a new Block into this function.

The new block is inserted before other.

pub fn create_block_after(
    &self,
    context: &mut Context,
    other: &Block,
    label: Option<Label>
) -> Result<Block, IrError>

Create and insert a new Block into this function.

The new block is inserted after other.

pub fn remove_block(
    &self,
    context: &mut Context,
    block: &Block
) -> Result<(), IrError>

Remove a Block from this function.

Care must be taken to ensure the block has no predecessors otherwise the function will be made invalid.

pub fn get_unique_label(
    &self,
    context: &mut Context,
    hint: Option<String>
) -> String

Get a new unique block label.

If hint is None then the label will be in the form "blockN" where N is an incrementing decimal.

Otherwise if the hint is already unique to this function it will be returned. If not already unique it will have N appended to it until it is unique.

pub fn num_blocks(&self, context: &Context) -> usize

Return the number of blocks in this function.

pub fn num_instructions(&self, context: &Context) -> usize

Return the number of instructions in this function.

pub fn get_name<'a>(&self, context: &'a Context) -> &'a str

Return the function name.

pub fn get_entry_block(&self, context: &Context) -> Block

Return the function entry (i.e., the first) block.

pub fn get_metadata(&self, context: &Context) -> Option<MetadataIndex>

Return the attached metadata.

pub fn has_selector(&self, context: &Context) -> bool

Whether this function has a valid selector.

pub fn get_selector(&self, context: &Context) -> Option<[u8; 4]>

Return the function selector, if it has one.

pub fn get_return_type(&self, context: &Context) -> Type

pub fn num_args(&self, context: &Context) -> usize

Get the number of args.

pub fn get_arg(&self, context: &Context, name: &str) -> Option<Value>

Get an arg value by name, if found.

pub fn lookup_arg_name<'a>(
    &self,
    context: &'a Context,
    value: &Value
) -> Option<&'a String>

Find the name of an arg by value.

pub fn args_iter<'a>(
    &self,
    context: &'a Context
) -> impl Iterator<Item = &'a (String, Value)>

Return an iterator for each of the function arguments.

pub fn get_local_ptr(&self, context: &Context, name: &str) -> Option<Pointer>

Get a pointer to a local value by name, if found.

pub fn lookup_local_name<'a>(
    &self,
    context: &'a Context,
    ptr: &Pointer
) -> Option<&'a String>

Find the name of a local value by pointer.

pub fn new_local_ptr(
    &self,
    context: &mut Context,
    name: String,
    local_type: Type,
    is_mutable: bool,
    initializer: Option<Constant>
) -> Result<Pointer, IrError>

Add a value to the function local storage.

The name must be unique to this function else an error is returned.

pub fn new_unique_local_ptr(
    &self,
    context: &mut Context,
    name: String,
    local_type: Type,
    is_mutable: bool,
    initializer: Option<Constant>
) -> Pointer

Add a value to the function local storage, by forcing the name to be unique if needed.

Will use the provided name as a hint and rename to guarantee insertion.

pub fn locals_iter<'a>(
    &self,
    context: &'a Context
) -> impl Iterator<Item = (&'a String, &'a Pointer)>

Return an iterator to all of the values in this function’s local storage.

pub fn merge_locals_from(
    &self,
    context: &mut Context,
    other: Function
) -> Result<HashMap<Pointer, Pointer>, IrError>

Merge values from another Function into this one.

The names of the merged values are guaranteed to be unique via the use of Function::new_unique_local_ptr.

Returns a map from the original pointers to the newly merged pointers.

XXX This function returns a Result but can’t actually fail?

pub fn block_iter(&self, context: &Context) -> BlockIterator

Return an iterator to each block in this function.

pub fn instruction_iter<'a>(
    &self,
    context: &'a Context
) -> impl Iterator<Item = (Block, Value)> + 'a

Return an iterator to each instruction in each block in this function.

This is a convenience method for when all instructions in a function need to be inspected. The instruction value is returned from the iterator along with the block it belongs to.

pub fn replace_value(
    &self,
    context: &mut Context,
    old_val: Value,
    new_val: Value,
    starting_block: Option<Block>
)

Replace a value with another within this function.

This is a convenience method which iterates over this function’s blocks and calls Block::replace_value in turn.

starting_block is an optimisation for when the first possible reference to old_val is known.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Hash for Function

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Function> for Function

fn eq(&self, other: &Function) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Function

impl Eq for Function

impl StructuralEq for Function

impl StructuralPartialEq for Function