Struct z80emu::CpuFlags

pub struct CpuFlags { /* fields omitted */ }

Z80 Cpu Flags.

Implementations

impl CpuFlags

pub const S: CpuFlags

Sign Flag.

pub const Z: CpuFlags

Zero Flag.

pub const Y: CpuFlags

Undocumented bit 5 of the Flag.

pub const H: CpuFlags

Half Carry Flag.

pub const X: CpuFlags

Undocumented bit 3 of the Flag.

pub const PV: CpuFlags

Parity/Overflow Flag.

pub const N: CpuFlags

Add/Subtract Flag.

pub const C: CpuFlags

Carry Flag.

pub const P: CpuFlags

An alias of CpuFlags::PV.

pub const V: CpuFlags

An alias of CpuFlags::PV.

pub const XY: CpuFlags

A mask of both undocumented Flag's bits 3 and 5. CpuFlags::X | CpuFlags::Y.

pub const HMASK: CpuFlags

A mask over bits 0 to 3 being used to detect half-byte carry.

pub const fn empty() -> CpuFlags

Returns an empty set of flags

pub const fn all() -> CpuFlags

Returns the set containing all flags.

pub const 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 const fn from_bits_truncate(bits: u8) -> CpuFlags

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

pub const unsafe fn from_bits_unchecked(bits: u8) -> CpuFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

pub const 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.

impl CpuFlags

pub fn reset(&mut self)

Resets all CpuFlags to false.

pub fn sf(self) -> bool

Returns a value of the Sign Flag.

pub fn zf(self) -> bool

Returns a value of the Zero Flag.

pub fn hf(self) -> bool

Returns a value of the Half Carry Flag.

pub fn pvf(self) -> bool

Returns a value of the Parity/Overflow Flag.

pub fn nf(self) -> bool

Returns a value of the Add/Subtract Flag.

pub fn cf(self) -> bool

Returns a value of the Carry Flag.

pub fn mask_cvz(cf: bool, vf: bool, zf: bool) -> Self

Returns a new instance of CpuFlags with Flags C | V | Z where each Flag is set depending on the value being given in the arguments.

pub fn mask_sign(res: u8) -> Self

Returns a new instance of CpuFlags with the S Flag being set depending on the top-most bit of the given 8-bit unsigned value being set.

pub fn mask_zero(res: u8) -> Self

Returns a new instance of CpuFlags with the Z Flag being set depending on the given value being equal to 0 (zero).

pub fn mask_carry(cf: bool) -> Self

Returns a new instance of CpuFlags with the C Flag being set depending on the given value.

pub fn mask_nf(nf: bool) -> Self

Returns a new instance of CpuFlags with the N Flag being set depending on the given value.

pub fn mask_hf(hf: bool) -> Self

Returns a new instance of CpuFlags with the H Flag being set depending on the given value.

pub fn mask_hcf(hcf: bool) -> Self

Returns a new instance of CpuFlags with Flags C | H being set depending on the given value.

pub fn mask_pvf(pvf: bool) -> Self

Returns a new instance of CpuFlags with the PV Flag being set depending on the given value.

pub fn parity(res: u8) -> Self

Returns a new instance of CpuFlags with the PV Flag being set if the number of bits equal to 1 is even in the given value.

pub fn mask_xy(res: u8) -> Self

Returns a new instance of CpuFlags with Flags X | Y being set depending on the bit value 3 for X and 5 for Y in the given argument.

pub fn mask_sxy(res: u8) -> Self

Returns a new instance of CpuFlags with Flags S | X | Y being set depending on the bit value 7 for S, 3 for X and 5 for Y in the given argument.

Trait Implementations

impl Binary for CpuFlags

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

Formats the value using the given formatter.

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

fn bitand_assign(&mut self, other: CpuFlags)

Disables all flags disabled in the set.

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

fn bitor_assign(&mut self, other: CpuFlags)

Adds the set 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 BitXorAssign<CpuFlags> for CpuFlags

fn bitxor_assign(&mut self, other: CpuFlags)

Toggles the set of flags.

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

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

Formats the value using the given formatter.

impl Default for CpuFlags

fn default() -> CpuFlags

Returns the "default value" for a type.

impl Eq for CpuFlags

impl Extend<CpuFlags> for CpuFlags

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<CpuFlags> for CpuFlags

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

Creates a value from an iterator.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl Ord for CpuFlags

fn cmp(&self, other: &CpuFlags) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]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 StructuralEq for CpuFlags

impl StructuralPartialEq for CpuFlags

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

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

Formats the value using the given formatter.