Enum wry::application::event_loop::ControlFlow
source · [−]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 ExitWithCode
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 (Non-exhaustive)
This enum is marked as non-exhaustive
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.
ExitWithCode(i32)
Send a LoopDestroyed
event and stop the event loop. This variant is sticky - once set,
control_flow
cannot be changed from ExitWithCode
, and any future attempts to do so will
result in the control_flow
parameter being reset to ExitWithCode
.
The contained number will be used as exit code. The Exit
constant is a shortcut for this
with exit code 0.
Platform-specific
- Android / iOS / WASM: The supplied exit code is unused.
- Unix: On most Unix-like platforms, only the 8 least significant bits will be used,
which can cause surprises with negative exit values (
-42
would end up as214
). Seestd::process::exit
.
Implementations
sourceimpl ControlFlow
impl ControlFlow
sourcepub const Exit: ControlFlow
pub const Exit: ControlFlow
Alias for ExitWithCode
(0)
.
Trait Implementations
sourceimpl Clone for ControlFlow
impl Clone for ControlFlow
sourcepub fn clone(&self) -> ControlFlow
pub fn clone(&self) -> ControlFlow
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ControlFlow
impl Debug for ControlFlow
sourceimpl Default for ControlFlow
impl Default for ControlFlow
sourcepub fn default() -> ControlFlow
pub fn default() -> ControlFlow
Returns the “default value” for a type. Read more
sourceimpl PartialEq<ControlFlow> for ControlFlow
impl PartialEq<ControlFlow> for ControlFlow
sourcepub fn eq(&self, other: &ControlFlow) -> bool
pub fn eq(&self, other: &ControlFlow) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcepub fn ne(&self, other: &ControlFlow) -> bool
pub fn ne(&self, other: &ControlFlow) -> bool
This method tests for !=
.
impl Copy for ControlFlow
impl Eq for ControlFlow
impl StructuralEq for ControlFlow
impl StructuralPartialEq for ControlFlow
Auto Trait Implementations
impl RefUnwindSafe for ControlFlow
impl Send for ControlFlow
impl Sync for ControlFlow
impl Unpin for ControlFlow
impl UnwindSafe for ControlFlow
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more