Enum Idle 

#[non_exhaustive]
pub enum Idle {
    Block {
        wake: Option<Duration>,
    },
    Spin,
}

Whether Flow::Idle blocks the loop on input or keeps looping without presenting.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Block

Block on input (via Terminal::wait_for_input) instead of calling update again immediately. wake is the longest an idle loop blocks before calling update again anyway, even with no input: None blocks indefinitely, right for apps with nothing to redraw until input arrives; Some(d) additionally wakes the loop every d, for apps that need a periodic idle redraw (a blinking cursor, a clock) without paying full frame-rate cost.

Fields

wake: Option<Duration>

The longest an idle loop blocks before calling update again, or None to block indefinitely.

Spin

Keep Flow::Idle non-blocking: skip present, keep looping at whatever rate RunOptions::target_fps allows. Right for apps that animate from Frame::delta and only return Idle between animation-driven Continue frames, where blocking would freeze the animation until the next stray input event. See RunOptions::animated for that shape.

Trait Implementations

impl Clone for Idle

fn clone(&self) -> Idle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Idle

impl Debug for Idle

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

Formats the value using the given formatter.

impl Eq for Idle

impl PartialEq for Idle

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Idle