Struct lochnes::nes::cpu::CpuFlags

pub struct CpuFlags { /* fields omitted */ }

Methods

impl CpuFlags

pub const C: CpuFlags

Carry flag: set when an arithmetic operation resulted in a carry.

pub const Z: CpuFlags

Zero flag: set when an operation results in 0.

pub const I: CpuFlags

Interrupt disable flag: set to disable CPU interrupts.

pub const D: CpuFlags

Decimal mode flag: exists for compatibility with the 6502 (which used it for decimal arithmetic), but ignored by the Rioch 2A03/2A07 processors used in the NES/Famicom.

pub const B: CpuFlags

Break flag: set when BRK or PHP are called, cleared when the /IRQ or /NMI interrupts are called. When PLP or RTI are called, this flag is unaffected.

In other words, this flag isn't exactly "set" or "cleared"-- when an interrupt happens, the status register is pushed to the stack. If the interrupt was an /IRQ or /NMI interrupt, the value pushed to the stack will have this bit cleared; if the interrupt was caused by BRK (or if the PHP instruction is used), then the value pushed to the stack will have this bit set.

pub const U: CpuFlags

Unused: this flag is always set to 1

pub const V: CpuFlags

Overflow flag: set when an operation resulted in a signed overflow.

pub const N: CpuFlags

Negative flag: set when an operation resulted in a negative value, i.e. when the most significant bit (bit 7) is set.

pub fn empty() -> CpuFlags

Returns an empty set of flags.

pub fn all() -> CpuFlags

Returns the set containing all flags.

pub fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<CpuFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub fn from_bits_truncate(bits: u8) -> CpuFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub fn intersects(&self, other: CpuFlags) -> bool

Returns true if there are flags common to both self and other.

pub fn contains(&self, other: CpuFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: CpuFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: CpuFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: CpuFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: CpuFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Extend<CpuFlags> for CpuFlags

fn extend<T: IntoIterator<Item = CpuFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl Clone for CpuFlags

fn clone(&self) -> CpuFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CpuFlags

impl Eq for CpuFlags

impl Ord for CpuFlags

fn cmp(&self, other: &CpuFlags) -> 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 PartialEq<CpuFlags> for CpuFlags

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

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

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

This method tests for !=.

impl PartialOrd<CpuFlags> for CpuFlags

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

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

fn lt(&self, other: &CpuFlags) -> bool

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

fn le(&self, other: &CpuFlags) -> bool

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

fn gt(&self, other: &CpuFlags) -> bool

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

fn ge(&self, other: &CpuFlags) -> bool

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

impl Debug for CpuFlags

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

Formats the value using the given formatter.

impl Sub<CpuFlags> for CpuFlags

type Output = CpuFlags

The resulting type after applying the - operator.

fn sub(self, other: CpuFlags) -> CpuFlags

Returns the set difference of the two sets of flags.

impl SubAssign<CpuFlags> for CpuFlags

fn sub_assign(&mut self, other: CpuFlags)

Disables all flags enabled in the set.

impl Not for CpuFlags

type Output = CpuFlags

The resulting type after applying the ! operator.

fn not(self) -> CpuFlags

Returns the complement of this set of flags.

impl BitAnd<CpuFlags> for CpuFlags

type Output = CpuFlags

The resulting type after applying the & operator.

fn bitand(self, other: CpuFlags) -> CpuFlags

Returns the intersection between the two sets of flags.

impl BitOr<CpuFlags> for CpuFlags

type Output = CpuFlags

The resulting type after applying the | operator.

fn bitor(self, other: CpuFlags) -> CpuFlags

Returns the union of the two sets of flags.

impl BitXor<CpuFlags> for CpuFlags

type Output = CpuFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: CpuFlags) -> CpuFlags

Returns the left flags, but with all the right flags toggled.

impl BitAndAssign<CpuFlags> for CpuFlags

fn bitand_assign(&mut self, other: CpuFlags)

Disables all flags disabled in the set.

impl BitOrAssign<CpuFlags> for CpuFlags

fn bitor_assign(&mut self, other: CpuFlags)

Adds the set of flags.

impl BitXorAssign<CpuFlags> for CpuFlags

fn bitxor_assign(&mut self, other: CpuFlags)

Toggles the set of flags.

impl Hash for CpuFlags

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 FromIterator<CpuFlags> for CpuFlags

fn from_iter<T: IntoIterator<Item = CpuFlags>>(iterator: T) -> CpuFlags

Creates a value from an iterator.

impl Octal for CpuFlags

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

Formats the value using the given formatter.

impl Binary for CpuFlags

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

Formats the value using the given formatter.

impl LowerHex for CpuFlags

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

Formats the value using the given formatter.

impl UpperHex for CpuFlags

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

Formats the value using the given formatter.