Struct EventLoopProxy

pub struct EventLoopProxy<T: 'static> { /* private fields */ }

Used to send custom events to EventLoop.

Implementations

impl<T: 'static> EventLoopProxy<T>

pub fn send_event(&self, event: T) -> Result<(), EventLoopClosed<T>>

Send an event to the EventLoop from which this proxy was created. This emits a UserEvent(event) event in the event loop, where event is the value passed to this function.

Returns an Err if the associated EventLoop no longer exists.

Examples found in repository

examples/window.rs (line 62)

fn main() -> Result<(), Box<dyn Error>> {
    #[cfg(web_platform)]
    console_error_panic_hook::set_once();

    tracing::init();

    let event_loop = EventLoop::<UserEvent>::with_user_event().build()?;
    let _event_loop_proxy = event_loop.create_proxy();

    // Wire the user event from another thread.
    #[cfg(not(web_platform))]
    std::thread::spawn(move || {
        // Wake up the `event_loop` once every second and dispatch a custom event
        // from a different thread.
        info!("Starting to send user event every second");
        loop {
            let _ = _event_loop_proxy.send_event(UserEvent::WakeUp);
            std::thread::sleep(std::time::Duration::from_secs(1));
        }
    });

    let mut state = Application::new(&event_loop);

    event_loop.run_app(&mut state).map_err(Into::into)
}

Trait Implementations

impl<T: 'static> Clone for EventLoopProxy<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: 'static> Debug for EventLoopProxy<T>

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

Formats the value using the given formatter.