Trait WaitNotice

Source

pub trait WaitNotice {
    // Required method
    fn waiting(&mut self);

    // Provided methods
    fn slow(&mut self, _waited: Duration) { ... }
    fn announces_at_start(&self) -> bool { ... }
}

Expand description

What: Something told once that an acquirer has to wait, such as a stderr notice. A trait is an interface a type implements. Why: A waiter may tell the user whose lock it waits for; the lock module stays silent.

In TS you’d write (pseudocode):

type OnWait = () => void;

Required Methods§

Source

fn waiting(&mut self)

Called once, when the first attempt finds the lock held.

Provided Methods§

Source

fn slow(&mut self, _waited: Duration)

Called when the wait has lasted the cadence’s grace, and again at every interval after it, with how long the wait has lasted. Brief contention never reaches it; a notice that only needs the first moment ignores it.

Source