Enum winit::event_loop::ControlFlow[][src]

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

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

Platform-specific

Wait

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

WaitUntil

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

Tuple Fields of WaitUntil

0: Instant
Exit

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.