Enum winit::event_loop::ControlFlow

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

[−] Expand description

Set by the user callback given to the EventLoop::run method.

Indicates the desired behavior of the event loop after Event::RedrawEventsCleared is emitted. Defaults to Poll.

Persistency

Almost every change is persistent between multiple calls to the event loop closure within a given run loop. The only exception to this is Exit which, once set, cannot be unset. Changes are not persistent between multiple calls to run_return - issuing a new call will reset the control flow to Poll.

Variants

Poll

[−] Expand description

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

Platform-specific

• Web: Events are queued and usually sent when requestAnimationFrame fires but sometimes the events in the queue may be sent before the next requestAnimationFrame callback, for example when the scaling of the page has changed. This should be treated as an implementation detail which should not be relied on.

Wait

[−] Expand description

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

WaitUntil(Instant)

[−] Expand description

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

Exit

[−] Expand description

Send a LoopDestroyed event and stop the event loop. This variant is sticky - once set, control_flow cannot be changed from Exit, and any future attempts to do so will result in the control_flow parameter being reset to Exit.

Trait Implementations

impl Clone for ControlFlow[+]

[+] Show hidden undocumented items

fn clone(&self) -> ControlFlow[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for ControlFlow

impl Debug for ControlFlow[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for ControlFlow[+]

[+] Show hidden undocumented items

fn default() -> ControlFlow[−]

Returns the “default value” for a type.

impl Eq for ControlFlow

impl PartialEq<ControlFlow> for ControlFlow[+]

[+] Show hidden undocumented items

fn eq(&self, other: &ControlFlow) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ControlFlow) -> bool[−]

This method tests for !=.

impl StructuralEq for ControlFlow

impl StructuralPartialEq for ControlFlow