Struct Timer

pub struct Timer {
    pub config: TimerConfig,
    pub state: TimerState,
    pub cycle: TimerCycle,
    pub cycles_count: TimerLoop,
    pub started_at: Option<Instant>,
    pub elapsed: usize,
}

The main timer struct.

Fields

config: TimerConfig

The current timer configuration.

state: TimerState

The current timer state.

cycle: TimerCycle

The current timer cycle.

cycles_count: TimerLoop

The current cycles counter.

started_at: Option<Instant>

Available on crate feature server only.

elapsed: usize

Available on crate feature server only.

Implementations

impl Timer

pub fn elapsed(&self) -> usize

Available on crate feature server only.

pub async fn update(&mut self)

Available on crate feature server only.

pub async fn fire_event(&self, event: TimerEvent)

Available on crate feature server only.

pub async fn fire_events(&self, events: impl IntoIterator<Item = TimerEvent>)

Available on crate feature server only.

pub async fn start(&mut self) -> Result<()>

Available on crate feature server only.

pub async fn set(&mut self, duration: usize) -> Result<()>

Available on crate feature server only.

pub async fn pause(&mut self) -> Result<()>

Available on crate feature server only.

pub async fn resume(&mut self) -> Result<()>

Available on crate feature server only.

pub async fn stop(&mut self) -> Result<()>

Available on crate feature server only.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timer

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

Formats the value using the given formatter.

impl Default for Timer

fn default() -> Timer

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Timer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Timer

Available on crate feature server only.

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 Serialize for Timer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Timer