Struct wayland_server::EventLoopHandle

pub struct EventLoopHandle { /* fields omitted */ }

Handle to an event loop

This handle gives you access to methods on an event loop that are safe to do from within a callback.

They are also available on an EventLoop object via Deref.

Methods

impl EventLoopHandle

fn register<R: Resource, H: Handler<R> + Any + Send + 'static>(&mut self,
                                                               resource: &R,
                                                               handler_id: usize)

Register a resource to a handler of this event loop.

The H type must be provided and match the type of the targetted Handler, or it will panic.

This overwrites any precedently set Handler for this resource and removes its destructor if any.

fn register_with_destructor<R, H, D>(&mut self, resource: &R, handler_id: usize) where R: Resource,
        H: Handler<R> + Any + Send + 'static,
        D: Destroy<R> + 'static

Register a resource to a handler of this event loop with a destructor

The H type must be provided and match the type of the targetted Handler, or it will panic.

The D type is the one whose Destroy<R> impl will be used as destructor.

This overwrites any precedently set Handler and destructor for this resource.

fn add_handler<H: Any + Send + 'static>(&mut self, handler: H) -> usize

Insert a new handler to this EventLoop

Returns the index of this handler in the internal array, needed register proxies to it.

fn add_handler_with_init<H: Init + Any + Send + 'static>(&mut self,
                                                         handler: H)
                                                         -> usize

Insert a new handler with init

Allows you to insert handlers that require some interaction with the event loop in their initialization, like registering some objects to it.

The handler must implement the Init trait, and its init method will be called after its insertion.

fn stop_loop(&mut self)

Stop looping

If the event loop this handle belongs to is currently running its run() method, it'll stop and return as soon as the current dispatching session ends.