Struct Instruction 

pub struct Instruction {
    pub op: Opcode,
    pub rd: Reg,
    pub rs1: Reg,
    pub rs2: Reg,
    pub imm: Imm,
}

A decoded instruction.

Fields not used by the opcode’s Format are zero, both here and in the encoded word.

Fields

op: Opcode

The operation.

rd: Reg

Destination register, or Reg::ZERO if unused.

rs1: Reg

First source register, or Reg::ZERO if unused.

rs2: Reg

Second source register, or Reg::ZERO if unused.

imm: Imm

Immediate, or Imm::ZERO if unused.

Implementations

impl Instruction

pub const fn r(op: Opcode, rd: Reg, rs1: Reg, rs2: Reg) -> Instruction

An R-format instruction.

pub const fn i(op: Opcode, rd: Reg, rs1: Reg, imm: Imm) -> Instruction

An I-format instruction.

pub const fn u(op: Opcode, rd: Reg, rs1: Reg) -> Instruction

A U-format (unary) instruction.

pub const fn b(op: Opcode, rs1: Reg, imm: Imm) -> Instruction

A B-format (branch) instruction.

pub const fn j(op: Opcode, rd: Reg, imm: Imm) -> Instruction

A J-format instruction.

pub const fn n(op: Opcode) -> Instruction

An N-format (no operand) instruction.

pub fn encode(self) -> Word

Encodes to a 27-trit word.

Unused fields are written as zero regardless of what the struct holds, so the encoding is always canonical.

pub fn decode(word: Word) -> Result<Instruction, DecodeError>

Decodes a 27-trit word.

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

Prints only the operands the format uses.

impl Eq for Instruction

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 StructuralPartialEq for Instruction