Struct Countdown 

pub struct Countdown { /* private fields */ }

A timer that fires once, after length steps or turns, and waits to be restarted.

It is the cooldown too. Advance it by 1 each step or turn, and:

use shuyi_core::timer::Countdown;

// Ready for its first use, then two turns' wait.
let mut cooldown = Countdown::new_ready(2);
let mut uses = 0;
for used in [true, true, false, true] {
    if used && cooldown.ready() {
        uses += 1;
        cooldown.restart();
    }
    cooldown.advance(1);
}
assert_eq!(uses, 2);

The default has a length of 0 and is ready.

Implementations

impl Countdown

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

One started: it fires after length.

pub const fn new_ready(length: u32) -> Self

One done already, for a cooldown whose first use goes through.

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

Takes n off what is left, stopping at 0. true only on the call that takes it from above 0 to 0, so it fires once however far n overshoots, and advance(0) never fires. A length of 0 is ready at once and never fires.

pub const fn ready(&self) -> bool

Whether nothing is left.

pub const fn remaining(&self) -> u32

What is left of it.

pub const fn elapsed(&self) -> u32

How much of it has passed, for a bar that fills: its length less what is left, stopping at 0.

pub const fn length(&self) -> u32

The whole of it.

pub const fn restart(&mut self)

Starts it again from its length.

Trait Implementations

impl Clone for Countdown

fn clone(&self) -> Countdown

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Countdown

impl Debug for Countdown

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

Formats the value using the given formatter.

impl Default for Countdown

fn default() -> Countdown

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Countdown

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Countdown

impl Hash for Countdown

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 Countdown

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Countdown

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 Countdown