Struct cranelift_codegen::ir::entities::Inst

pub struct Inst(_);

An opaque reference to an instruction in a Function.

Most usage of Inst is internal. Instructions are returned by InstBuilder instructions that do not return a Value, such as control flow and trap instructions, as well as instructions that return a variable (potentially zero!) number of values, like call or call-indirect instructions. To get the Value of such instructions, use inst_results or its analogue in cranelift_frontend::FuncBuilder.

If you look around the API, you can find many inventive uses for Inst, such as annotating specific instructions with a comment or performing reflection at compile time on the type of instruction.

While the order is stable, it is arbitrary and does not necessarily resemble the layout order.

Implementations

impl Inst

pub fn from_u32(x: u32) -> Self

Create a new instance from a u32.

pub fn as_u32(self) -> u32

Return the underlying index value as a u32.

pub fn as_bits(self) -> u32

Return the raw bit encoding for this instance.

pub fn from_bits(x: u32) -> Self

Create a new instance from the raw bit encoding.

Trait Implementations

impl Clone for Inst

fn clone(&self) -> Inst

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Inst

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

Formats the value using the given formatter.

impl Display for Inst

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

Formats the value using the given formatter.

impl EntityRef for Inst

fn new(index: usize) -> Self

Create a new entity reference from a small integer. This should crash if the requested index is not representable.

fn index(self) -> usize

Get the index that was used to create this entity reference.

impl From<Inst> for AnyEntity

fn from(r: Inst) -> Self

Converts to this type from the input type.

impl From<Inst> for ExpandedProgramPoint

fn from(inst: Inst) -> Self

Converts to this type from the input type.

impl From<Inst> for ProgramPoint

fn from(inst: Inst) -> Self

Converts to this type from the input type.

impl Hash for Inst

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 Index<Inst> for DataFlowGraph

Allow immutable access to instructions via indexing.

type Output = InstructionData

The returned type after indexing.

fn index(&self, inst: Inst) -> &InstructionData

Performs the indexing (container[index]) operation.

impl IndexMut<Inst> for DataFlowGraph

Allow mutable access to instructions via indexing.

fn index_mut(&mut self, inst: Inst) -> &mut InstructionData

Performs the mutable indexing (container[index]) operation.

impl Ord for Inst

fn cmp(&self, other: &Inst) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Inst> for Inst

fn eq(&self, other: &Inst) -> 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 PartialOrd<Inst> for Inst

fn partial_cmp(&self, other: &Inst) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl ReservedValue for Inst

fn reserved_value() -> Inst

Create an instance of the reserved value.

fn is_reserved_value(&self) -> bool

Checks whether value is the reserved one.

impl Copy for Inst

impl Eq for Inst

impl StructuralEq for Inst

impl StructuralPartialEq for Inst