Struct dez80::instruction::Instruction

pub struct Instruction {
    pub ignored_prefixes: Vec<OpcodePrefix>,
    pub opcode: Opcode,
    pub type: InstructionType,
    pub source: Option<Operand>,
    pub destination: Option<Operand>,
}

Represents a single Z80 instruction.

Fields

ignored_prefixes: Vec<OpcodePrefix>

Collection of 0xDD and 0xFD opcodes (indexed instruction prefixes) that are ignored during the decoding process, due to the opcodes they precede not mapping to an actual indexed instruction. These ignored prefixes incur a runtime cost, but have no other effect on the decoded instruction.

opcode: Opcode

The actual opcode decoded for this instruction, including any prefix.

type: InstructionType

The instruction type for this instruction, which maps to a mnemonic.

source: Option<Operand>

The source operand for this instruction if any, indicating where data is read.

destination: Option<Operand>

The destination operand for this instruction if any, indicating where data is written.

Implementations

impl Instruction

pub fn to_bytes(&self) -> Vec<u8>

Provides the raw encoded representation of the instruction.

pub fn decode_one<R: Read>(source: &mut R) -> Result<Instruction, DecodingState>

Decodes a single instruction from a source, or None if one cannot be decoded. This is a thin wrapper around Instruction::decode(), which does not require the caller to convert its source to a Peekable<Bytes<R>>.

pub fn decode_all<R: Read>(source: &mut R) -> Vec<Instruction>

Decodes a sequence of instructions, until the end of the stream or an error is reached.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a copy 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 Default for Instruction

fn default() -> Self

Returns the "default value" for a type.

impl Display for Instruction

Formats instructions by disassembling their raw byte representation.

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

Formats the value using the given formatter.

impl PartialEq<Instruction> for Instruction

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

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

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

This method tests for !=.

impl StructuralPartialEq for Instruction