Struct Instruction 

pub struct Instruction { /* private fields */ }

A decoded instruction.

Create one with decode, decode_bytes, or by iterating over disassemble. Its Display output follows GNU objdump’s for a raw binary, such as addi gp,gp,256 or beqz a0,0x1040.

Implementations

impl Instruction

pub fn isa(&self) -> Isa

The base ISA the instruction was decoded for.

pub fn pc(&self) -> u64

The address of the instruction.

pub fn raw(&self) -> u64

The instruction encoding, in the low length bytes.

pub fn length(&self) -> usize

The length of the encoding in bytes: 2, 4, 6 or 8.

Encodings with a reserved length (10 bytes or more) are decoded as a 2-byte illegal instruction.

pub fn mnemonic(&self) -> &'static str

The mnemonic, such as "addi", "li" or "amoadd.w".

An encoding that is not a valid instruction is shown as objdump shows it, as an .insn directive (.insn 4, 0x0911003b), or as a .2byte directive for a parcel of a reserved-length encoding. Use is_illegal to check for these.

Compressed instructions are shown as the instruction they expand to, and aliases (pseudoinstructions) are used where objdump uses them. without_aliases gives the instruction as encoded. The mnemonic does not include the .aq/.rl ordering suffixes of atomic instructions, which Display adds.

pub fn operands(&self) -> Operands<'_>

The operands, without the mnemonic, such as a0,8(sp).

pub fn is_illegal(&self) -> bool

Whether the encoding is not a valid instruction. This includes the all-zeros 16-bit encoding, which the ISA defines to be illegal and which is shown as unimp.

pub fn without_aliases(&self) -> Instruction

The same instruction, shown as encoded: compressed instructions keep their c. names and pseudoinstructions are not used. This matches objdump -M no-aliases.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Instruction

impl Debug for Instruction

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

Formats the value using the given formatter.

impl Display for Instruction

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

Formats the instruction as objdump does, with a single space between the mnemonic and the operands: lw a0,8(sp).

impl Eq for Instruction

impl PartialEq for Instruction

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Instruction