Struct smithay_client_toolkit::WaylandSource

pub struct WaylandSource { /* fields omitted */ }

An adapter to insert a Wayland EventQueue into a calloop event loop

This is a struct that implements calloop::EventSource. It generates an event whenever events need to be dispatched. At this point your calloop callback will be given access to the EventQueue and you should call .dispatch_pending() and forward its return value, allowing you to handle orphan events as you prefer.

If you don't use orphan events, the quick_insert method will firectly insert the source into a provided LoopHandle with an adapter which will panic whenever an oprhan event is encountered.

Methods

impl WaylandSource

pub fn new(queue: EventQueue) -> WaylandSource

Wrap an EventQueue as a WaylandSource.

pub fn quick_insert<Data: 'static>(
    self,
    handle: LoopHandle<Data>
) -> Result<Source<WaylandSource>, InsertError<WaylandSource>>

Insert this source into given event loop with an adapter that panics on orphan events

Trait Implementations

impl EventSource for WaylandSource

type Event = ()

The type of events generated by your source.

type Metadata = EventQueue

Some metadata of your event source

type Ret = Result<u32>

The return type of the user callback

fn process_events<F>(
    &mut self,
    _: Readiness,
    _: Token,
    callback: F
) -> Result<()> where
    F: FnMut((), &mut EventQueue) -> Result<u32>, 

Process any relevant events

fn register(&mut self, poll: &mut Poll, token: Token) -> Result<()>

Register yourself to this poll instance

fn reregister(&mut self, poll: &mut Poll, token: Token) -> Result<()>

Re-register your file descriptors

fn unregister(&mut self, poll: &mut Poll) -> Result<()>

Unregister your file descriptors