Struct spectrusty::clock::VFrameTsCounter

pub struct VFrameTsCounter<V, C> {
    pub vts: VFrameTs<V>,
    pub contention: C,
}

A generic VideoTs based T-states counter.

Implements [Clock] for counting T-states when code is being executed by [z80emu::Cpu].

Counts additional T-states according to contention specified by generic parameters: V: VideoFrame and C: MemoryContention.

Fields

vts: VFrameTs<V>

The current timestamp value of this counter.

contention: C

An instance implementing a MemoryContention trait.

Implementations

impl<V, C> VFrameTsCounter<V, C> where
    C: MemoryContention,
    V: VideoFrame, 

pub fn new(vc: i16, hc: i16, contention: C) -> VFrameTsCounter<V, C>

Constructs a new and normalized VFrameTsCounter from the given vertical and horizontal counter values.

Panics

Panics when the given values lead to an overflow of the capacity of VideoTs.

pub fn from_tstates(ts: i32, contention: C) -> VFrameTsCounter<V, C>

Builds a normalized VFrameTsCounter from the given count of T-states.

Panics

Panics when the given ts overflows the capacity of VideoTs.

pub fn from_video_ts(vts: VideoTs, contention: C) -> VFrameTsCounter<V, C>

Builds a normalized VFrameTsCounter from the given count of T-states.

Panics

Panics when the given ts overflows the capacity of VideoTs.

pub fn from_vframe_ts(vfts: VFrameTs<V>, contention: C) -> VFrameTsCounter<V, C>

Builds a normalized VFrameTsCounter from the given count of T-states.

Panics

Panics when the given ts overflows the capacity of VideoTs.

pub fn is_contended_address(self, address: u16) -> bool

Methods from Deref<Target = VFrameTs<V>>

Trait Implementations

impl<V, C> AddAssign<u32> for VFrameTsCounter<V, C> where
    V: VideoFrame, 

fn add_assign(&mut self, delta: u32)

Performs the += operation.

impl<V, C> Clock for VFrameTsCounter<V, C> where
    C: MemoryContention,
    V: VideoFrame, 

type Limit = i16

This type is being used for an arbitrary representation of the limit argument when executing instructions. See Cpu::execute_with_limit for an explanation.

type Timestamp = VideoTs

This type is being used for timestamping the interactions between Cpu, [Io] and [Memory] implementations.

fn is_past_limit(&self, limit: <VFrameTsCounter<V, C> as Clock>::Limit) -> bool

Should return true if the [Clock] has reached the given limit otherwise should return false.

fn add_irq(&mut self, _pc: u16) -> <VFrameTsCounter<V, C> as Clock>::Timestamp

This method should increase the counter by at least [IRQ_ACK_CYCLE_TS] 6 T-states. The method should return the timestamp that may be passed to [Io::irq_data]. It's being used at the beginning of the maskable interrupt request/acknowledge cycle. The pc is a value of the program counter when the interrupt was accepted.

fn add_no_mreq(&mut self, address: u16, add_ts: NonZeroU8)

This method should increase the counter by at least the value given in add_ts. It's being used by internal operations of the Cpu without any external access. The address given here is whatever was put on the address bus before.

fn add_m1(
    &mut self,
    address: u16
) -> <VFrameTsCounter<V, C> as Clock>::Timestamp

This method should increase the counter by at least [M1_CYCLE_TS] 4 and should return the timestamp that may be passed to [Memory::read_opcode]. This method is also being used when the non-maskable interrupt is being accepted and while the Cpu is wasting cycles in the halted state.

fn add_mreq(
    &mut self,
    address: u16
) -> <VFrameTsCounter<V, C> as Clock>::Timestamp

This method should increase the counter by at least the value given in [MEMRW_CYCLE_TS] 3 and should return the timestamp that may be passed to [Memory::read_mem],

fn add_io(&mut self, port: u16) -> <VFrameTsCounter<V, C> as Clock>::Timestamp

This method should increase the counter by at least [IO_CYCLE_TS] 4 T-states and should return the timestamp that may be passed to [Io::read_io] or [Io::write_io].

fn add_wait_states(&mut self, _bus: u16, wait_states: NonZeroU16)

This method should increase the counter by the value given in wait_states. A call to one of [Io::read_io], [Io::write_io] or [Io::irq_data] may request such additional number of wait states to be added.

fn as_timestamp(&self) -> <VFrameTsCounter<V, C> as Clock>::Timestamp

Should return the current state of the [Clock] as a timestamp.

impl<V, C> Clone for VFrameTsCounter<V, C> where
    C: Clone,
    V: Clone, 

fn clone(&self) -> VFrameTsCounter<V, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V, C> Copy for VFrameTsCounter<V, C> where
    C: Copy,
    V: Copy, 

impl<V, C> Debug for VFrameTsCounter<V, C> where
    C: Debug,
    V: Debug, 

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

Formats the value using the given formatter.

impl<V, C> Deref for VFrameTsCounter<V, C>

type Target = VFrameTs<V>

The resulting type after dereferencing.

fn deref(&self) -> &<VFrameTsCounter<V, C> as Deref>::Target

Dereferences the value.

impl<V, C> DerefMut for VFrameTsCounter<V, C>

fn deref_mut(&mut self) -> &mut <VFrameTsCounter<V, C> as Deref>::Target

Mutably dereferences the value.

impl<V, C> Eq for VFrameTsCounter<V, C> where
    C: Eq,
    V: Eq, 

impl<V, C> From<VFrameTsCounter<V, C>> for VFrameTs<V>

fn from(vftsc: VFrameTsCounter<V, C>) -> VFrameTs<V>

Performs the conversion.

impl<V, C> From<VFrameTsCounter<V, C>> for VideoTs

fn from(vftsc: VFrameTsCounter<V, C>) -> VideoTs

Performs the conversion.

impl<V, C> Hash for VFrameTsCounter<V, C> where
    C: Hash,
    V: Hash, 

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

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<V, C> Ord for VFrameTsCounter<V, C> where
    C: Ord,
    V: Ord, 

fn cmp(&self, other: &VFrameTsCounter<V, C>) -> 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<V, C> PartialEq<VFrameTsCounter<V, C>> for VFrameTsCounter<V, C> where
    C: PartialEq<C>,
    V: PartialEq<V>, 

fn eq(&self, other: &VFrameTsCounter<V, C>) -> bool

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

fn ne(&self, other: &VFrameTsCounter<V, C>) -> bool

This method tests for !=.

impl<V, C> PartialOrd<VFrameTsCounter<V, C>> for VFrameTsCounter<V, C> where
    C: PartialOrd<C>,
    V: PartialOrd<V>, 

fn partial_cmp(&self, other: &VFrameTsCounter<V, C>) -> Option<Ordering>

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

fn lt(&self, other: &VFrameTsCounter<V, C>) -> bool

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

fn le(&self, other: &VFrameTsCounter<V, C>) -> bool

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

fn gt(&self, other: &VFrameTsCounter<V, C>) -> bool

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

fn ge(&self, other: &VFrameTsCounter<V, C>) -> bool

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

impl<V, C> StructuralEq for VFrameTsCounter<V, C>

impl<V, C> StructuralPartialEq for VFrameTsCounter<V, C>

impl<V, C> SubAssign<u32> for VFrameTsCounter<V, C> where
    V: VideoFrame, 

fn sub_assign(&mut self, delta: u32)

Performs the -= operation.