Struct spectrusty_core::chip::Ula128MemFlags
source · pub struct Ula128MemFlags { /* private fields */ }
Expand description
ZX Spectrum 128K / +2 memory control flags and +2A / +3 primary control flags.
Implementations§
source§impl Ula128MemFlags
impl Ula128MemFlags
pub const RAM_BANK_MASK: Self = _
pub const SCREEN_BANK: Self = _
pub const ROM_BANK: Self = _
pub const LOCK_MMU: Self = _
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
source§impl Ula128MemFlags
impl Ula128MemFlags
sourcepub fn with_last_ram_page_bank(self, bank: usize) -> Self
pub fn with_last_ram_page_bank(self, bank: usize) -> Self
Returns modified flags with the last memory page RAM bank index set to bank
.
sourcepub fn last_ram_page_bank(self) -> usize
pub fn last_ram_page_bank(self) -> usize
Returns a RAM bank index mapped at the last memory page.
sourcepub fn rom_page_bank(self) -> usize
pub fn rom_page_bank(self) -> usize
Returns a ROM bank index mapped at the first memory page.
sourcepub fn is_shadow_screen(self) -> bool
pub fn is_shadow_screen(self) -> bool
Returns true
if a shadow screen bank bit is 1. Otherwise returns false
.
sourcepub fn is_mmu_locked(self) -> bool
pub fn is_mmu_locked(self) -> bool
Returns true
if a mmu lock bit is 1. Otherwise returns false
.
Trait Implementations§
source§impl Binary for Ula128MemFlags
impl Binary for Ula128MemFlags
source§impl BitAnd<Ula128MemFlags> for Ula128MemFlags
impl BitAnd<Ula128MemFlags> for Ula128MemFlags
source§impl BitAndAssign<Ula128MemFlags> for Ula128MemFlags
impl BitAndAssign<Ula128MemFlags> for Ula128MemFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<Ula128MemFlags> for Ula128MemFlags
impl BitOr<Ula128MemFlags> for Ula128MemFlags
source§fn bitor(self, other: Ula128MemFlags) -> Self
fn bitor(self, other: Ula128MemFlags) -> Self
Returns the union of the two sets of flags.
§type Output = Ula128MemFlags
type Output = Ula128MemFlags
|
operator.source§impl BitOrAssign<Ula128MemFlags> for Ula128MemFlags
impl BitOrAssign<Ula128MemFlags> for Ula128MemFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<Ula128MemFlags> for Ula128MemFlags
impl BitXor<Ula128MemFlags> for Ula128MemFlags
source§impl BitXorAssign<Ula128MemFlags> for Ula128MemFlags
impl BitXorAssign<Ula128MemFlags> for Ula128MemFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for Ula128MemFlags
impl Clone for Ula128MemFlags
source§fn clone(&self) -> Ula128MemFlags
fn clone(&self) -> Ula128MemFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Ula128MemFlags
impl Debug for Ula128MemFlags
source§impl Default for Ula128MemFlags
impl Default for Ula128MemFlags
source§fn default() -> Ula128MemFlags
fn default() -> Ula128MemFlags
source§impl Extend<Ula128MemFlags> for Ula128MemFlags
impl Extend<Ula128MemFlags> for Ula128MemFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<Ula128MemFlags> for Ula128MemFlags
impl FromIterator<Ula128MemFlags> for Ula128MemFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for Ula128MemFlags
impl Hash for Ula128MemFlags
source§impl LowerHex for Ula128MemFlags
impl LowerHex for Ula128MemFlags
source§impl Not for Ula128MemFlags
impl Not for Ula128MemFlags
source§impl Octal for Ula128MemFlags
impl Octal for Ula128MemFlags
source§impl Ord for Ula128MemFlags
impl Ord for Ula128MemFlags
source§fn cmp(&self, other: &Ula128MemFlags) -> Ordering
fn cmp(&self, other: &Ula128MemFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<Ula128MemFlags> for Ula128MemFlags
impl PartialEq<Ula128MemFlags> for Ula128MemFlags
source§fn eq(&self, other: &Ula128MemFlags) -> bool
fn eq(&self, other: &Ula128MemFlags) -> bool
source§impl PartialOrd<Ula128MemFlags> for Ula128MemFlags
impl PartialOrd<Ula128MemFlags> for Ula128MemFlags
source§fn partial_cmp(&self, other: &Ula128MemFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &Ula128MemFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<Ula128MemFlags> for Ula128MemFlags
impl Sub<Ula128MemFlags> for Ula128MemFlags
source§impl SubAssign<Ula128MemFlags> for Ula128MemFlags
impl SubAssign<Ula128MemFlags> for Ula128MemFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.