Struct EventReceiver

pub struct EventReceiver(/* private fields */);

Handle for receiving events from the main event loop.

Unlike a raw std::sync::mpsc::Receiver, this never returns error on disconnection, because disconnection can only occur for a brief moment between the main event loop beginning to shut down, and the process as a whole exiting. Therefore, when this receives a disconnection error from the underlying receiver, it enters an infinite sleep cycle as it waits for the OS to kill the process.

Implementations

impl EventReceiver

pub fn recv(&self) -> Event<'static, Blocker>

Receive an event, blocking until one is available.

pub fn recv_timeout(&self, timeout: Duration) -> Option<Event<'static, Blocker>>

Attempt to receive an event, blocking until one is available, or the timeout duration has passed.

pub fn try_recv(&self) -> Option<Event<'static, Blocker>>

Try to receive an event immediately, never blocking.

pub fn iter<'a>(&'a self) -> impl Iterator<Item = Event<'static, Blocker>> + 'a

Iterator form of self.recv(). Blocking iterator that never ends.

Examples found in repository

examples/winit_readme.rs (line 41)

fn main() {
    winit_main::run(|event_loop, events| {
        let window = event_loop
            .create_window(WindowAttributes::default())
            .unwrap();

        for event in events.iter() {
            if matches!(
                event,
                Event::WindowEvent {
                    event: WindowEvent::CloseRequested,
                    window_id,
                } if window_id == window.id()
            ) {
                break;
            }
        }
    });
}

pub fn try_iter<'a>( &'a self, ) -> impl Iterator<Item = Event<'static, Blocker>> + 'a

Iterator form of self.try_recv(). Non-blocking iterator that drains the events currently in the queue.