Struct Cadence 

pub struct Cadence {
    pub grace: Duration,
    pub interval: Duration,
}

What: When a wait’s notices are due: the grace before the first and the interval between the rest. Why: One value travels from the production entry to the wait loop, and tests choose short ones instead of waiting out the defaults.

In TS you’d write (pseudocode):

type Cadence = { graceMs: number; intervalMs: number };

Fields

grace: Duration

Silence before the first notice.

interval: Duration

Time between two notices.

Implementations

impl Cadence

pub fn from_interval(interval: Duration) -> Self

The cadence for an interval: the standard grace, but never longer than the interval itself.

In TS you’d write (pseudocode):

{ graceMs: Math.min(GRACE_MS, intervalMs), intervalMs }

pub fn standard() -> Self

The cadence when nothing configures it.

pub fn from_value(value: Option<&OsStr>) -> Self

The cadence for a value of the variable; a missing, zero or malformed value falls back to the standard one.

In TS you’d write (pseudocode):

Cadence.fromInterval(positiveSeconds(value) ?? DEFAULT_INTERVAL)

pub fn from_environment() -> Self

The cadence this process runs under: the variable in its environment, or the standard one.

Trait Implementations

impl Clone for Cadence

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Cadence

impl Debug for Cadence

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

Formats the value using the given formatter.

impl Eq for Cadence

impl PartialEq for Cadence

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Cadence