Struct wayland_backend::rs::client_impl::InnerReadEventsGuard

pub struct InnerReadEventsGuard {
    state: Arc<ConnectionState>,
    done: bool,
}

Fields

state: Arc<ConnectionState>

done: bool

Implementations

impl InnerReadEventsGuard

pub fn try_new(backend: InnerBackend) -> Option<Self>

Create a new reading guard

This call will not block, but event callbacks may be invoked in the process of preparing the guard.

pub fn connection_fd(&self) -> BorrowedFd<'_>

Access the Wayland socket FD for polling

pub fn read(self) -> Result<usize, WaylandError>

Attempt to read events from the Wayland socket

If multiple threads have a live reading guard, this method will block until all of them are either dropped or have their read() method invoked, at which point on of the threads will read events from the socket and invoke the callbacks for the received events. All threads will then resume their execution.

This returns the number of dispatched events, or 0 if an other thread handled the dispatching. If no events are available to read from the socket, this returns a WouldBlock IO error.

Trait Implementations

impl Debug for InnerReadEventsGuard

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

Formats the value using the given formatter.

impl Drop for InnerReadEventsGuard

fn drop(&mut self)

Executes the destructor for this type.