pub struct ThreadSyncTimer {
    pub time: Instant,
    pub frame_duration: Duration,
}
Expand description

A tool for synchronizing emulation with a running thread.

Fields§

§time: Instant

The start time of a current synchronization period.

§frame_duration: Duration

The desired duration of a single synchronization period.

Implementations§

Pass the real time duration of a desired synchronization period (usually a duration of a video frame).

Sets ThreadSyncTimer::frame_duration from the provided frame_duration_nanos.

Restarts the synchronization period. Useful e.g. for resuming paused emulation.

Calculates the difference between the desired duration of a synchronization period and the real time that has passed from the start of the current period and levels the difference by calling std::thread::sleep.

This method may be called at the end of each iteration of an emulation loop to synchronize the running thread with a desired iteration period.

Returns Ok if the thread is in sync with the emulation. In this instance the value of ThreadSyncTimer::frame_duration is being added to ThreadSyncTimer::time to mark the beginning of a new period.

Returns Err(missed_periods) if the elapsed time exceeds the desired period duration. In this intance the start of a new period is set to Instant::now.

Returns Some(excess_duration) if the time elapsed from the beginning of the current period exceeds or is equal to the desired duration of a synchronization period. Otherwise returns None.

The value returned is the excess time that has elapsed above the desired duration. If the time elapsed equals to the frame_duration the returned value equals to zero.

In case Some variant is returned the value of ThreadSyncTimer::frame_duration is being added to ThreadSyncTimer::time to mark the beginning of a new period.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Converts self into T using Into<T>. Read more
Causes self to use its Binary implementation when Debug-formatted.
Causes self to use its Display implementation when Debug-formatted. Read more
Causes self to use its LowerExp implementation when Debug-formatted. Read more
Causes self to use its LowerHex implementation when Debug-formatted. Read more
Causes self to use its Octal implementation when Debug-formatted.
Causes self to use its Pointer implementation when Debug-formatted. Read more
Causes self to use its UpperExp implementation when Debug-formatted. Read more
Causes self to use its UpperHex implementation when Debug-formatted. Read more
Formats each item in a sequence. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Convert to S a sample type from self.
Pipes by value. This is generally the method you want to use. Read more
Borrows self and passes that borrow into the pipe function. Read more
Mutably borrows self and passes that borrow into the pipe function. Read more
Borrows self, then passes self.borrow() into the pipe function. Read more
Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Borrows self, then passes self.as_ref() into the pipe function.
Mutably borrows self, then passes self.as_mut() into the pipe function. Read more
Borrows self, then passes self.deref() into the pipe function.
Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more
Immutable access to a value. Read more
Mutable access to a value. Read more
Immutable access to the Borrow<B> of a value. Read more
Mutable access to the BorrowMut<B> of a value. Read more
Immutable access to the AsRef<R> view of a value. Read more
Mutable access to the AsMut<R> view of a value. Read more
Immutable access to the Deref::Target of a value. Read more
Mutable access to the Deref::Target of a value. Read more
Calls .tap() only in debug builds, and is erased in release builds.
Calls .tap_mut() only in debug builds, and is erased in release builds. Read more
Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more
Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more
Calls .tap_ref() only in debug builds, and is erased in release builds. Read more
Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more
Calls .tap_deref() only in debug builds, and is erased in release builds. Read more
Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more
Attempts to convert self into T using TryInto<T>. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.