Enum ControlFlow

pub enum ControlFlow {
    Poll,
    Wait,
    WaitUntil(Instant),
}

Set through ActiveEventLoop::set_control_flow().

Indicates the desired behavior of the event loop after about_to_wait is called.

Defaults to Wait.

Variants

Poll

When the current loop iteration finishes, immediately begin a new iteration regardless of whether or not new events are available to process.

Wait

When the current loop iteration finishes, suspend the thread until another event arrives.

WaitUntil(Instant)

When the current loop iteration finishes, suspend the thread until either another event arrives or the given time is reached.

Useful for implementing efficient timers. Applications which want to render at the display’s native refresh rate should instead use Poll and the VSync functionality of a graphics API to reduce odds of missed frames.

Implementations

impl ControlFlow

pub fn wait_duration(timeout: Duration) -> ControlFlow

Creates a ControlFlow that waits until a timeout has expired.

In most cases, this is set to WaitUntil. However, if the timeout overflows, it is instead set to Wait.

Trait Implementations

impl Clone for ControlFlow

fn clone(&self) -> ControlFlow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ControlFlow

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

Formats the value using the given formatter.

impl Default for ControlFlow

fn default() -> ControlFlow

Returns the “default value” for a type.

impl Hash for ControlFlow

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 ControlFlow

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

impl Eq for ControlFlow

impl StructuralPartialEq for ControlFlow