Struct Clock

pub struct Clock {
    pub shared_state: Rc<ClockState>,
    /* private fields */
}

State representing a clock.

Fields

shared_state: Rc<ClockState>

Implementations

impl Clock

pub fn new(freq_mhz: f64) -> Self

Create a new Clock at the specified frequency.

pub fn freq_mhz(&self) -> f64

Returns the clocks frequency in MHz.

pub fn tick_now(&self) -> ClockTick

Returns the current ClockTick.

pub fn time_now_ns(&self) -> f64

Returns the current time in ns.

pub fn time_of_next(&self) -> f64

Returns the time in ns of the next event registered with this clock.

pub fn to_ns(&self, clock_time: &ClockTick) -> f64

Convert the given ClockTick to a time in ns for this clock.

pub fn wait_ticks(&self, ticks: u64) -> ClockDelay

Returns a ClockDelay future which must be awaited to delay the specified number of ticks.

pub fn wait_ticks_or_exit(&self, ticks: u64) -> ClockDelay

Returns a ClockDelay future which must be awaited to delay the specified number of ticks. However, if the remainder of the simulation completes then this future is allowed to not complete. This allows the user to create tasks that can run continuously as long as the rest of the simulation continues to run.

pub fn next_tick_and_phase(&self, phase: u32) -> ClockDelay

pub fn wait_phase(&self, phase: u32) -> ClockDelay

pub fn advance_to(&self, time_ns: f64)

Advance to the next tick after the specified time.

Trait Implementations

impl Clone for Clock

fn clone(&self) -> Clock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Clock

The default clocks is simply to use a 1GHz clock so ticks are 1ns.

fn default() -> Self

Returns the “default value” for a type.

impl Ord for Clock

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Clock

The comparison operators for Clocks - use the next pending Waker time.

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Clock

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Resolver for Clock

fn add_resolve(&self, resolve: Rc<dyn Resolve + 'static>)

impl Eq for Clock