Struct InstructionBuilder 

pub struct InstructionBuilder {
    pub opcode: OpCode,
    pub cdcode: CondCode,
    pub update: bool,
    pub args: Vec<Argument>,
}

A builder pattern for Instructions that ensures they are always valid when instantiated.

Fields

opcode: OpCode

A code representing the instruction executed on the processor.

cdcode: CondCode

A code which specifies under which conditions to execute.

update: bool

Whether the status register should be updated.

args: Vec<Argument>

Arguments provided to the instruction, interpreted as specified in OpCode

Implementations

impl InstructionBuilder

pub fn new(opcode: OpCode) -> Self

Constructs a new instruction builder with default values for condition, arguments, and s-bit from an opcode. Should be used in conjunction with chained methods like condition and argument when manually constructing a valid instruction.

pub fn condition(self, cond: CondCode) -> Self

Sets the condition of an existing instruction to the chosen condition code. Can be chained with other methods.

pub fn argument(self, arg: Argument) -> Self

Appends an argument to an existing instruction. Can be chained with other methods operating on InstructionBuilder.

pub fn update(self) -> Self

Sets the s-bit of an existing instruction. Can be chained with other methods.

pub fn replace(&mut self, label: &str, value: Argument)

Replaces any labels with the same name as the value provided with a copy of the argument provided.

pub fn build(self) -> Result<Instruction, InstructionError>

Attempts to build a valid, encodable instruction from the arguments in the InstructionBuilder. Will return an InstructionError on invalid instructions.

use cfd16_lib::prelude::*;

let wrong = InstructionBuilder::new(OpCode::Ret)
    .argument(Argument::Reg(Register::B))
    .build();

assert!(wrong.is_err());

Trait Implementations

impl Clone for InstructionBuilder

fn clone(&self) -> InstructionBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstructionBuilder

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

Formats the value using the given formatter.

impl Default for InstructionBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Display for InstructionBuilder

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

Formats the value using the given formatter.

impl PartialEq for InstructionBuilder

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

impl StructuralPartialEq for InstructionBuilder