Struct Args

#[non_exhaustive]
pub struct Args<'a, A: Application> {
    pub window: &'a mut MainWindowWithRenderer,
    pub event_loop: &'a ActiveEventLoop,
    pub event_proxy: &'a EventLoopProxy<AppEvent<A>>,
    pub data: &'a mut A::Data,
}

This type is an aggregate of values retured by AppHandler.

With this you don’t need to have a buch of use that you probably don’t care about.

Since this is not Send it is always used from the main loop, and it can be used to send non Send callbacks to the idle loop.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

window: &'a mut MainWindowWithRenderer

The main window.

event_loop: &'a ActiveEventLoop

The event loop.

event_proxy: &'a EventLoopProxy<AppEvent<A>>

A proxy to send messages to the main loop.

data: &'a mut A::Data

The custom application data.

Implementations

impl<A: Application> Args<'_, A>

pub fn local_proxy(&self) -> LocalProxy<A>

Creates a LocalProxy that is Clone but not Send.

pub fn ping_user_input(&mut self)

Helper function to call ping_user_input in the main window.

pub fn spawn_idle<T: 'static, F: Future<Output = T> + 'static>( &self, f: F, ) -> FutureHandle<T>

Registers a future to be run during the idle step of the main loop.

pub fn run_idle<F: FnOnce(&mut A, Args<'_, A>) + 'static>( &self, f: F, ) -> Result<(), EventLoopClosed<()>>

Registers a callback to be called during the idle step of the main loop.

pub fn future_back(&self) -> FutureBackCaller<A>

Creates a FutureBackCaller for this application.