Struct sway_ir::value::Value

pub struct Value(pub Index);

A wrapper around an ECS handle into the Context.

Tuple Fields

0: Index

Implementations

impl Value

pub fn new_argument(context: &mut Context, arg: BlockArgument) -> Value

Return a new argument Value.

pub fn new_constant(context: &mut Context, constant: Constant) -> Value

Return a new constant Value.

pub fn new_instruction(context: &mut Context, instruction: Instruction) -> Value

Return a new instruction Value.

pub fn add_metadatum(
    self,
    context: &mut Context,
    md_idx: Option<MetadataIndex>
) -> Self

Add some metadata to this value.

As a convenience the md_idx argument is an Option, in which case this function is a no-op.

If there is no existing metadata then the new metadata are added alone. Otherwise the new metadatum are added to the list of metadata.

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

Return this value’s metadata.

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

Return whether this is a constant value.

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

Return whether this value is an instruction, and specifically a ‘terminator’.

A terminator is always the last instruction in a block (and may not appear anywhere else) and is either a branch or return.

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

pub fn replace_instruction_values(
    &self,
    context: &mut Context,
    replace_map: &FxHashMap<Value, Value>
)

If this value is an instruction and if any of its parameters is old_val then replace them with new_val.

pub fn replace(&self, context: &mut Context, other: ValueDatum)

Replace this value with another one, in-place.

pub fn get_instruction<'a>(
    &self,
    context: &'a Context
) -> Option<&'a Instruction>

Get a reference to this value as an instruction, iff it is one.

pub fn get_instruction_mut<'a>(
    &self,
    context: &'a mut Context
) -> Option<&'a mut Instruction>

Get a mutable reference to this value as an instruction, iff it is one.

pub fn get_constant<'a>(&self, context: &'a Context) -> Option<&'a Constant>

Get a reference to this value as a constant, iff it is one.

pub fn get_argument_type(&self, context: &Context) -> Option<Type>

Iff this value is an argument, return its type.

pub fn get_type(&self, context: &Context) -> Option<Type>

Get the type for this value, if found.

Arguments and constants always have a type, but only some instructions do.

pub fn get_pointer(&self, context: &Context) -> Option<Pointer>

Get the pointer argument for this value if there is one. I.e., where get_ptr is essentially a Value wrapper around a Pointer, this function unwrap it.

pub fn get_stripped_ptr_type(&self, context: &Context) -> Option<Type>

Get the type for this value with any pointer stripped, if found.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl DebugWithContext for Value

fn fmt_with_context<'a, 'c>(
    &'a self,
    formatter: &mut Formatter<'_>,
    context: &'c Context
) -> Result

fn with_context<'a, 'c>(
    &'a self,
    context: &'c Context
) -> WithContext<'a, 'c, Self>

impl Hash for Value

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<Value> for Value

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

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

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 Value

impl Eq for Value

impl StructuralEq for Value

impl StructuralPartialEq for Value