Struct WaylandClipboard 

pub struct WaylandClipboard { /* private fields */ }

wl_data_device + zwp_primary_selection_device_v1 on the app’s own Wayland connection.

Built on smithay-clipboard, which runs the selection protocol on a dedicated event queue over the existing connection. Sharing the connection is the point: the compositor gates set_selection on keyboard focus, and only the connection that owns the focused surface has it. A second, separate connection would be a different client, would never hold focus, and every copy from it would be refused.

Implementations

impl WaylandClipboard

pub unsafe fn new(display_ptr: *mut c_void) -> WaylandClipboard

Attach to the wl_display behind display_ptr.

Safety

display_ptr must be a live wl_display * that outlives the returned value. In practice it comes from winit’s display handle and lives as long as the event loop, which outlives every widget that could copy.

Trait Implementations

impl ClipboardBackend for WaylandClipboard

fn request_text(&self, target: ClipboardTarget) -> Receiver<Option<String>>

Request text for an explicit paste. A native transfer may finish after this call returns; the backend must wake its owner when it answers. No answer may substitute text from an older selection or focus owner.

fn set_text(&self, target: ClipboardTarget, text: &str) -> bool

Take ownership of target and offer text on it. Returns false if the backend could not.

fn text(&self, target: ClipboardTarget) -> Option<String>

Read target as UTF-8. None when it is empty, unavailable, or holds something that is not text.

fn set_image(&self, width: usize, height: usize, rgba: &[u8]) -> bool

Offer an RGBA8 image on the clipboard. Optional: the default refuses, which is appropriate for backends that only carry text.

fn rich_text(&self) -> Option<RichTextOffer>

Read HTML and its plain fallback from one Ctrl+V clipboard offer. Optional: unsupported backends return None without reading plain text. A successful read consumes event-scoped offers; use the captured plain fallback if decoding refuses the HTML. Never reread to recover a stale selection, a permission refusal, or an active composition.

fn image(&self) -> Option<ClipboardImage>

The image on the Ctrl+V clipboard, when it holds one: a screenshot, an image copied in a viewer or a browser. Optional: the default reads none, which is right for backends that only carry text.

fn name(&self) -> &'static str

Short name for diagnostics, e.g. "compositor-mirror".

fn set_shared_text(&self, target: ClipboardTarget, text: &str) -> bool

Offer text only where other processes can read it. Returns false rather than keeping it in a buffer private to this process, so a secret is never reported as copied when it was not. The default is set_text, right for a backend that only reaches a shared clipboard.

impl Drop for WaylandClipboard

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.