Struct Watcher 

pub struct Watcher {
    queue: EventQueue<State>,
    state: State,
    clipboard: ClipboardType,
    watched: WlSeat,
    cancel_read: PipeReader,
    cancel_write: Arc<PipeWriter>,
}

Watches the clipboard for selection changes.

Construct one with Watcher::new, then drive it by calling Watcher::next_event in a loop. The first call reports the current selection state; subsequent calls block until the selection changes again.

Seats are resolved when the watcher starts, so passing Seat::Unspecified will use the first seat found on construction rather than re-enumerating seats as offers come in.

Fields

queue: EventQueue<State>

state: State

clipboard: ClipboardType

watched: WlSeat

cancel_read: PipeReader

cancel_write: Arc<PipeWriter>

Implementations

impl Watcher

pub fn new(clipboard: ClipboardType, seat: Seat<'_>) -> Result<Self, Error>

Starts watching the clipboard.

Returns an error immediately if there are no seats, the requested seat or protocol is missing, or primary selection was requested but is unsupported.

pub(crate) fn with_socket( clipboard: ClipboardType, seat: Seat<'_>, socket_name: Option<OsString>, ) -> Result<Self, Error>

pub fn cancel_handle(&self) -> CancelHandle

Returns a handle that stops this watcher when CancelHandle::cancel is called.

The handle can be cloned and sent to another thread to interrupt a Watcher::next_event call that is blocked waiting for the next selection change.

pub fn next_event<'a>(&'a mut self) -> Result<Option<ClipboardEvent<'a>>, Error>

Blocks until the next selection event for the watched clipboard and seat.

On success yields the ClipboardEvent and an Offer to read its contents from. Returns Ok(None) if cancelled via CancelHandle::cancel, or Err on a Wayland communication failure.

fn front_matches(&mut self) -> bool

fn take_front_event<'a>(&'a mut self) -> ClipboardEvent<'a>

fn wait(&mut self) -> Result<bool, Error>