Enum azul_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
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[src]

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

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for ControlFlow[src]

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

Formats the value using the given formatter. Read more

impl Default for ControlFlow[src]

fn default() -> ControlFlow[src]

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

impl PartialEq<ControlFlow> for ControlFlow[src]

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

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

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

This method tests for !=.

impl Copy for ControlFlow[src]

impl Eq for ControlFlow[src]

impl StructuralEq for ControlFlow[src]

impl StructuralPartialEq for ControlFlow[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.