Struct WaylandClipboardContext

pub struct WaylandClipboardContext { /* private fields */ }

Interface to the clipboard for Wayland windowing systems.

Other users of the Wayland clipboard will only see the contents copied to the clipboard so long as the process copying to the clipboard exists. If you need the contents of the clipboard to remain after your application shuts down, consider daemonizing the clipboard components of your application.

WaylandClipboardContext automatically detects support for and uses the primary selection protocol.

Example

use cli_clipboard::ClipboardProvider;
let mut clipboard = cli_clipboard::wayland_clipboard::WaylandClipboardContext::new().unwrap();
clipboard.set_contents("foo bar baz".to_string()).unwrap();
let contents = clipboard.get_contents().unwrap();

assert_eq!(contents, "foo bar baz");

Trait Implementations

impl ClipboardProvider for WaylandClipboardContext

fn new() -> Result<WaylandClipboardContext, Box<dyn Error>>

Constructs a new WaylandClipboardContext that operates on all seats using the data-control clipboard protocol. This is intended for CLI applications that do not create Wayland windows.

Attempts to detect whether the primary selection is supported. Assumes no primary selection support if no seats are available. In addition to returning Err on communication errors (such as when operating in an X11 environment), will also return Err if the compositor does not support the data-control protocol.

fn get_contents(&mut self) -> Result<String, Box<dyn Error>>

Pastes from the Wayland clipboard.

If the Wayland environment supported the primary selection when this context was constructed, first checks the primary selection. If pasting from the primary selection raises an error or the primary selection is unsupported, falls back to the regular clipboard.

An empty clipboard is not considered an error, but the clipboard must indicate a text MIME type and the contained text must be valid UTF-8.

fn set_contents(&mut self, data: String) -> Result<(), Box<dyn Error>>

Copies to the Wayland clipboard.

If the Wayland environment supported the primary selection when this context was constructed, this will copy to both the primary selection and the regular clipboard. Otherwise, only the regular clipboard will be pasted to.

fn clear(&mut self) -> Result<(), Box<dyn Error>>

Method to clear the clipboard