Struct async_winit::event_loop::EventLoop

pub struct EventLoop { /* private fields */ }

Provides a way to retrieve events from the system and from the windows that were registered to the events loop.

The EventLoop is a “context” for the GUI system. More specifically, it represents a connection to the underlying GUI system. The EventLoop is the main object that you will use to drive the program. Most async functions in async-winit rely on the EventLoop to be currently running.

The EventLoop itself is !Send and !Sync due to underlying platform restrictions. However, EventLoopWindowTarget and [Window] are both not only SendandSync`, but also cheaply clonable. This means that you can create a window on one thread, and then send it to another thread to be used.

Implementations

impl EventLoop

pub fn new() -> EventLoop

Alias for EventLoopBuilder::new().build().

impl EventLoop

pub fn window_target(&self) -> &EventLoopWindowTarget

Manually get a reference to the event loop’s window target.

pub fn block_on(self, future: impl Future<Output = Infallible> + 'static) -> !

Block on a future forever.

Methods from Deref<Target = EventLoopWindowTarget>

pub fn set_exit(&self)

Request that the event loop exit as soon as possible.

pub fn set_exit_with_code(&self, code: i32)

Request that we exit as soon as possible with the given exit code.

pub async fn exit(&self) -> !

Exit the program.

pub async fn exit_with_code(&self, code: i32) -> !

Exit the program with the given exit code.

pub fn resumed(&self) -> &Handler<()>

Get the handler for the Resumed event.

pub fn suspended(&self) -> &Handler<()>

Get the handler for the Suspended event.

pub async fn primary_monitor(&self) -> Option<MonitorHandle>

Get the primary monitor.

pub async fn available_monitors(&self) -> impl Iterator<Item = MonitorHandle>

Get the available monitors.

pub async fn set_device_event_filter(&self, filter: DeviceEventFilter)

Set the device event filter.

Trait Implementations

impl Debug for EventLoop

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

Formats the value using the given formatter.

impl Default for EventLoop

fn default() -> Self

Returns the “default value” for a type.

impl Deref for EventLoop

type Target = EventLoopWindowTarget

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for EventLoop

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl EventLoopExtRunReturn for EventLoop

fn block_on_return<F>(&mut self, fut: F) -> ReturnOrFinish<i32, F::Output>where F: Future,

Initializes the winit event loop.