Struct Every 

pub struct Every { /* private fields */ }

A timer that fires every period steps or turns.

A period of 0 acts as 1, whether given to new or read from a file.

Implementations

impl Every

pub const fn new(period: u32) -> Self

One that first fires after a whole period.

pub fn advance(&mut self, n: u32) -> u32

Moves it on by n, and says how many times it fired: (since + n) / period times, keeping the remainder. The count saturates at u32::MAX.

pub fn period(&self) -> u32

How often it fires, at least 1.

pub fn until_next(&self) -> u32

How far it is to its next firing: the period less how far it has come, and 1 if that’s out of range, because the next advance(1) fires then.

pub const fn reset(&mut self)

Back to a whole period before its next firing.

Trait Implementations

impl Clone for Every

fn clone(&self) -> Every

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Every

impl Debug for Every

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Every

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Every

impl Hash for Every

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 Every

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Every

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Every