Struct Coach 

pub struct Coach<S>
where
    S: 'static,
{ /* private fields */ }

The schedule of a set of hints over the signals S a host observes.

A host feeds it what the person did (Self::observe) and, every frame, what holds and whether now is a quiet moment (Self::tick). It answers which hint to show (Self::current) and what was learned or shown that the person’s own record should keep (Self::learned).

Implementations

impl<S> Coach<S>

where S: Copy + PartialEq + 'static,

pub fn new(specs: &'static [HintSpec<S>], learned: Learned) -> Coach<S>

pub fn specs(&self) -> &'static [HintSpec<S>]

The registered hints.

pub fn current(&self) -> Option<Current>

The hint on screen, if any.

pub fn learned(&self) -> &Learned

What the person’s record keeps: which hints are learned, how often each showed, and whether hints show at all.

pub fn take_changed(&mut self) -> Option<Learned>

The record, when it changed since the last call: the host writes it to the person’s own data.

pub fn merge(&mut self, other: &Learned, now: Instant)

Fold in the record as another device left it: a hint learned anywhere is learned here, and a hint on screen that the other device learned goes.

pub fn set_enabled(&mut self, enabled: bool, now: Instant)

Turn hints on or off (the person’s one setting).

pub fn observe(&mut self, signal: S, now: Instant)

The person did signal. Every hint it teaches is learned, shown or not: one on screen acknowledges it, one not yet shown never will. A hint whose moment it is (Cue::Saw) remembers that.

pub fn tick( &mut self, now: Instant, holds: &dyn Fn(S) -> bool, quiet: Option<Quiet>, anchored: &dyn Fn(usize) -> bool, timing: Timing, )

Advance to now. holds says whether a fact holds right now; quiet is why no hint may begin now, if anything; anchored whether the host can place a hint at all (its anchor is on screen); the phases’ lengths come from timing.

pub fn next_change(&self, timing: Timing) -> Option<Instant>

When the schedule next changes on its own, for a host that sleeps between frames: the hint on screen ending a phase, or a waiting Cue::After coming due.