Enum Flow 

#[non_exhaustive]
pub enum Flow {
    Continue,
    Idle,
    Exit,
}

Whether the game loop should continue or stop after a frame, and whether that frame renders.

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.

Continue

Run another frame, and present it.

Idle

Run another frame, but nothing changed: skip present and leave the previous frame on screen.

For turn-based apps that only need to redraw in response to player input, not on every tick of the driver’s loop. Returning Idle while a retroglyph_ui::animate::Tween- or FrameClock-driven animation is still in flight is an app bug, not a valid use: an in-progress animation has something new to show every frame, which is exactly what Idle tells the driver isn’t true.

Exit

Stop the loop. The driver returns and the terminal unwinds normally, so backend Drop logic (for example crossterm’s terminal restore) runs.

Trait Implementations

impl Clone for Flow

fn clone(&self) -> Flow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Flow

impl Debug for Flow

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

Formats the value using the given formatter.

impl Eq for Flow

impl Hash for Flow

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Flow

fn eq(&self, other: &Flow) -> 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 Flow