Struct wayland_client::ReadEventsGuard

pub struct ReadEventsGuard {
    inner: Rc<EventQueueInner>,
    done: bool,
}

A guard over a read intention.

See EventQueue::prepare_read() for details about its use.

Fields

inner: Rc<EventQueueInner>

done: bool

Implementations

impl ReadEventsGuard

pub fn read_events(self) -> Result<()>

Read events

Reads events from the server socket. If other ReadEventsGuard exists, will block until they are all consumed or destroyed.

pub fn cancel(self)

Cancel the read

Will cancel the read intention associated with this guard. Never blocks.

Has the same effect as letting the guard go out of scope.

Trait Implementations

impl Debug for ReadEventsGuard

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

Formats the value using the given formatter.

impl Drop for ReadEventsGuard

fn drop(&mut self)

Executes the destructor for this type.