Struct wayland_client::event_queue::QueueHandle

pub struct QueueHandle<State> {
    pub(crate) inner: Arc<Mutex<EventQueueInner<State>>>,
}

A handle representing an EventQueue, used to assign objects upon creation.

Fields

inner: Arc<Mutex<EventQueueInner<State>>>

Implementations

impl<State: 'static> QueueHandle<State>

pub fn make_data<I: Proxy + 'static, U: Send + Sync + 'static>( &self, user_data: U, ) -> Arc<dyn ObjectData>

where State: Dispatch<I, U, State>,

Create an object data associated with this event queue

This creates an implementation of ObjectData fitting for direct use with wayland-backend APIs that forwards all events to the event queue associated with this token, integrating the object into the Dispatch-based logic of wayland-client.

pub fn freeze(&self) -> QueueFreezeGuard<'_, State>

Temporarily block processing on this queue.

This will cause the associated queue to block (or return NotReady to poll) until all QueueFreezeGuards associated with the queue are dropped.

Trait Implementations

impl<State> Clone for QueueHandle<State>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<State> Debug for QueueHandle<State>

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

Formats the value using the given formatter.