Struct Instruction 

pub struct Instruction {
    pub opcode: Opcode,
    /* private fields */
}

A fully decoded bytecode instruction: an Opcode paired with its Operand list.

The number and types of operands are always determined by Opcode::operand_types.

Fields

opcode: Opcode

The operation to perform.

Implementations

impl Instruction

pub fn new( opcode: Opcode, operands: impl IntoIterator<Item = Operand>, ) -> StatorResult<Self>

Construct an instruction, verifying that the operand count matches the opcode’s declared operand list.

Returns an error if the wrong number of operands is supplied.

pub fn new_unchecked( opcode: Opcode, operands: impl IntoIterator<Item = Operand>, ) -> Self

Construct an instruction without operand-count validation.

Prefer Instruction::new unless you are certain the operand count is correct (e.g. inside the decoder).

pub fn operand_count(&self) -> usize

Return the number of operands carried by this instruction.

pub fn operands(&self) -> &[Operand]

Return the live operand slice for this instruction.

pub fn operand(&self, idx: usize) -> &Operand

Return the operand at idx.

Panics if idx is out of bounds for this instruction.

pub fn operand_at(&self, idx: usize) -> Option<&Operand>

Return the operand at idx, if present.

pub fn operand_mut(&mut self, idx: usize) -> &mut Operand

Return the operand at idx mutably.

Panics if idx is out of bounds for this instruction.

pub unsafe fn operand_unchecked(&self, idx: usize) -> &Operand

Return the operand at idx without bounds checks.

Safety

idx must be less than Instruction::operand_count.

pub fn reg(&self, idx: usize) -> u32

Return operand idx as a register index.

pub fn register_count(&self, idx: usize) -> u32

Return operand idx as a register-count operand.

pub fn immediate(&self, idx: usize) -> i32

Return operand idx as an immediate value.

pub fn constant_pool_idx(&self, idx: usize) -> u32

Return operand idx as a constant-pool index.

pub fn feedback_slot(&self, idx: usize) -> u32

Return operand idx as a feedback-slot index.

pub fn runtime_id(&self, idx: usize) -> u32

Return operand idx as a runtime identifier.

pub fn jump_offset(&self, idx: usize) -> i32

Return operand idx as a jump offset.

pub fn flag(&self, idx: usize) -> u8

Return operand idx as a flag value.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl PartialEq for Instruction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Instruction

impl StructuralPartialEq for Instruction