Struct DataControl 

pub struct DataControl { /* private fields */ }

A connection to the Wayland compositor’s clipboard.

Connecting spawns one thread that owns the Wayland connection. Dropping the handle stops and joins it.

use lamco_data_control::{Content, DataControl};

let clipboard = DataControl::connect()?;
clipboard.set_selection(Content::new().data("text/plain;charset=utf-8", "hello"))?;

Implementations

impl DataControl

pub fn connect() -> Result<Self>

Connect with the default Options.

Errors

See Error: no compositor, no data-control protocol, or no seat.

Examples found in repository

examples/paste.rs (line 6)

fn main() -> lamco_data_control::Result<()> {
    let clipboard = DataControl::connect()?;
    println!("protocol: {}", clipboard.protocol());
    println!("offered: {:?}", clipboard.selection_mime_types());
    match clipboard.read("text/plain;charset=utf-8")? {
        Some(bytes) => println!("{}", String::from_utf8_lossy(&bytes)),
        None => println!("no text on the clipboard"),
    }
    Ok(())
}

examples/copy.rs (line 9)

fn main() -> lamco_data_control::Result<()> {
    let text = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "hello".to_owned());
    let clipboard = DataControl::connect()?;
    clipboard.set_selection(
        Content::new()
            .data("text/plain;charset=utf-8", text.clone())
            .data("text/plain", text),
    )?;
    println!("clipboard set; press Ctrl-C to release it");
    std::thread::park();
    Ok(())
}

pub fn connect_with(options: &Options) -> Result<Self>

Connect with explicit options.

Errors

See Error: no compositor, no data-control protocol, or no seat.

pub fn protocol(&self) -> Protocol

The protocol the compositor is speaking.

Examples found in repository

examples/paste.rs (line 7)

fn main() -> lamco_data_control::Result<()> {
    let clipboard = DataControl::connect()?;
    println!("protocol: {}", clipboard.protocol());
    println!("offered: {:?}", clipboard.selection_mime_types());
    match clipboard.read("text/plain;charset=utf-8")? {
        Some(bytes) => println!("{}", String::from_utf8_lossy(&bytes)),
        None => println!("no text on the clipboard"),
    }
    Ok(())
}

pub fn selection_mime_types(&self) -> Vec<String>

MIME types the current selection offers; empty if there is none.

Examples found in repository

examples/paste.rs (line 8)

fn main() -> lamco_data_control::Result<()> {
    let clipboard = DataControl::connect()?;
    println!("protocol: {}", clipboard.protocol());
    println!("offered: {:?}", clipboard.selection_mime_types());
    match clipboard.read("text/plain;charset=utf-8")? {
        Some(bytes) => println!("{}", String::from_utf8_lossy(&bytes)),
        None => println!("no text on the clipboard"),
    }
    Ok(())
}

pub fn serial(&self) -> u32

A counter that increases on every selection change.

pub fn on_change(&self, callback: impl Fn(Vec<String>) + Send + Sync + 'static)

Call callback with the offered MIME types whenever another client changes the selection.

A selection this handle set itself is not reported; it still advances serial and updates selection_mime_types.

The callback runs on the worker thread and must not block.

pub fn on_transfer( &self, callback: impl Fn(TransferRequest) + Send + Sync + 'static, )

Call callback when something pastes a type that was advertised without data.

The callback runs on the worker thread and must not block; hand the request to another thread and answer it there.

pub fn set_selection(&self, content: Content) -> Result<()>

Become the clipboard owner and offer content.

Errors

Error::Stopped if the worker has shut down.

Examples found in repository

examples/copy.rs (lines 10-14)

fn main() -> lamco_data_control::Result<()> {
    let text = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "hello".to_owned());
    let clipboard = DataControl::connect()?;
    clipboard.set_selection(
        Content::new()
            .data("text/plain;charset=utf-8", text.clone())
            .data("text/plain", text),
    )?;
    println!("clipboard set; press Ctrl-C to release it");
    std::thread::park();
    Ok(())
}

pub fn update_data( &self, mime_type: impl Into<String>, data: impl Into<Vec<u8>>, ) -> Result<()>

Add data for a type after set_selection, without replacing the selection.

Errors

Error::Stopped if the worker has shut down.

pub fn clear_selection(&self) -> Result<()>

Give up the selection if this handle still owns it.

Errors

Error::Stopped if the worker has shut down.

pub fn read(&self, mime_type: &str) -> Result<Option<Vec<u8>>>

Read the current selection as mime_type.

Charset differences are tolerated, see find_mime_match. Returns Ok(None) when there is no selection or it does not offer the type.

Errors

Error::TooLarge past the size limit, Error::Timeout if the source stalls for five seconds, Error::Stopped if the worker has shut down, Error::Io for pipe failures.

Examples found in repository

examples/paste.rs (line 9)

fn main() -> lamco_data_control::Result<()> {
    let clipboard = DataControl::connect()?;
    println!("protocol: {}", clipboard.protocol());
    println!("offered: {:?}", clipboard.selection_mime_types());
    match clipboard.read("text/plain;charset=utf-8")? {
        Some(bytes) => println!("{}", String::from_utf8_lossy(&bytes)),
        None => println!("no text on the clipboard"),
    }
    Ok(())
}

Trait Implementations

impl Debug for DataControl

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

Formats the value using the given formatter.

impl Drop for DataControl

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.