Struct Clock 

pub struct Clock { /* private fields */ }

Defines the passage of time in a Universe.

See TickSchedule for details on what is possible and why.

---

TODO: Should paused be part of the clock’s state?

Implementations

impl Clock

pub const fn new(schedule: TickSchedule, phase: u16) -> Self

Creates a new Clock with the given state.

If the phase is out of range, it is reduced modulo schedule.divisor.

pub fn schedule(&self) -> TickSchedule

Returns the schedule which this clock obeys.

pub fn advance(&mut self, paused: bool) -> Tick

If paused is false, advances this clock to the next instant (as defined by the schedule) and returns the Tick defining the transition between those instants.

If paused is true, returns a paused Tick for the current instant. See Tick::paused for information on the meaning of pausing.

pub fn next_tick(&self, paused: bool) -> Tick

Returns the tick that will happen the next time Self::advance() is called, if the schedule is not changed before then.

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

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

Formats the value using the given formatter.

impl Hash for Clock

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Clock

fn eq(&self, other: &Clock) -> 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 Copy for Clock

impl Eq for Clock

impl Resource for Clock

where Self: Send + Sync + 'static,

impl StructuralPartialEq for Clock