Struct pir_8_emu::isa::SpecialPurposeRegister

pub struct SpecialPurposeRegister<T: Num + Unsigned + PrimInt> { /* fields omitted */ }

There are some special purpose registers that you cannot directly read/write from, these are used by the CPU for its internal state.

All the registers will start with an initial value of 0.

There are three 16-bit registers for holding significant memory addresses and a single 8-bit register.

Name	Short	Bits	Description
Program Counter	PC	16	Address of the next instruction to be fetched
Stack Pointer	SP	16	Current address of the stack (detailed later)
Memory Address	ADR	16	Address saved for use during certain instructions
Instruction	INS	8	Instruction currently being executed

The address bus is controlled by either PC, SP or ADR.

As the CPU is reading an instruction from system memory, the value of the PC will be used, for some instructions though, such as JUMP or STACK, it is value of ADR or SP (respectively) that is used.

Methods

impl<T: Num + Unsigned + PrimInt> SpecialPurposeRegister<T>

pub fn new(name: &'static str, short: &'static str) -> SpecialPurposeRegister<T>

Create a new, empty register named as specified.

Examples

let pc = SpecialPurposeRegister::<u16>::new("Program Counter", "PC");
assert_eq!(*pc, 0);
assert_eq!(pc.name(), "Program Counter");
assert_eq!(pc.short_name(), "PC");

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

The full name of this register

E.g. "Program Counter"

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

The short/mnemonical name of this register

E.g. "PC"

Trait Implementations

impl<T: Clone + Num + Unsigned + PrimInt> Clone for SpecialPurposeRegister<T>

fn clone(&self) -> SpecialPurposeRegister<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy + Num + Unsigned + PrimInt> Copy for SpecialPurposeRegister<T>

impl<T: Debug + Num + Unsigned + PrimInt> Debug for SpecialPurposeRegister<T>

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

Formats the value using the given formatter.

impl<T: Num + Unsigned + PrimInt> Deref for SpecialPurposeRegister<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Num + Unsigned + PrimInt> DerefMut for SpecialPurposeRegister<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Num + Unsigned + PrimInt + Display + UpperHex> Display for SpecialPurposeRegister<T>

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

Formats the value using the given formatter.

impl<T: Eq + Num + Unsigned + PrimInt> Eq for SpecialPurposeRegister<T>

impl<T: Hash + Num + Unsigned + PrimInt> Hash for SpecialPurposeRegister<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T: Ord + Num + Unsigned + PrimInt> Ord for SpecialPurposeRegister<T>

fn cmp(&self, other: &SpecialPurposeRegister<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq + Num + Unsigned + PrimInt> PartialEq<SpecialPurposeRegister<T>> for SpecialPurposeRegister<T>

fn eq(&self, other: &SpecialPurposeRegister<T>) -> bool

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

fn ne(&self, other: &SpecialPurposeRegister<T>) -> bool

This method tests for !=.

impl<T: PartialOrd + Num + Unsigned + PrimInt> PartialOrd<SpecialPurposeRegister<T>> for SpecialPurposeRegister<T>

fn partial_cmp(&self, other: &SpecialPurposeRegister<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SpecialPurposeRegister<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SpecialPurposeRegister<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SpecialPurposeRegister<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SpecialPurposeRegister<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Num + Unsigned + PrimInt> ReadWritable for SpecialPurposeRegister<T>

fn was_read(&self) -> bool

Check if this object was read from.

fn was_written(&self) -> bool

Check if this object was written to.

fn reset_rw(&mut self)

Reset the R/W marking of this object.

impl<T: Num + Unsigned + PrimInt> StructuralEq for SpecialPurposeRegister<T>

impl<T: Num + Unsigned + PrimInt> StructuralPartialEq for SpecialPurposeRegister<T>