#clipboard

clipboard

rust-clipboard is a cross-platform library for getting and setting the contents of the OS-level clipboard

13 releases

0.5.0 Sep 22, 2018
0.4.6 Feb 22, 2018
0.4.2 Sep 26, 2017
0.4.0 Jun 19, 2017
0.1.0 Nov 30, 2015

#2 in #clipboard

Download history 2487/week @ 2019-12-14 1975/week @ 2019-12-21 2649/week @ 2019-12-28 2895/week @ 2020-01-04 3143/week @ 2020-01-11 2906/week @ 2020-01-18 3852/week @ 2020-01-25 2649/week @ 2020-02-01 4148/week @ 2020-02-08 3533/week @ 2020-02-15 3746/week @ 2020-02-22 3784/week @ 2020-02-29 3133/week @ 2020-03-07 4039/week @ 2020-03-14 3421/week @ 2020-03-21 3785/week @ 2020-03-28

11,499 downloads per month
Used in 80 crates (52 directly)

MIT/Apache

14KB
188 lines

rust-clipboard

rust-clipboard is a cross-platform library for getting and setting the contents of the OS-level clipboard.
It has been tested on Windows, Mac OSX, GNU/Linux, and FreeBSD. It is used in Mozilla Servo.

Appveyor Build Status Travis Build Status

Prerequisites

On Linux you need the x11 library, install it with something like:

sudo apt-get install xorg-dev

Example

extern crate clipboard;

use clipboard::ClipboardProvider;
use clipboard::ClipboardContext;

fn example() {
    let mut ctx: ClipboardContext = ClipboardProvider::new().unwrap();
    println!("{:?}", ctx.get_contents());
    ctx.set_contents("some string".to_owned()).unwrap();
}

API

The ClipboardProvider trait has the following functions:

fn new() -> Result<Self, Box<Error>>;
fn get_contents(&mut self) -> Result<String, Box<Error>>;
fn set_contents(&mut self, String) -> Result<(), Box<Error>>;

ClipboardContext is a type alias for one of {WindowsClipboardContext, OSXClipboardContext, X11ClipboardContext, NopClipboardContext}, all of which implement ClipboardProvider. Which concrete type is chosen for ClipboardContext depends on the OS (via conditional compilation).

License

rust-clipboard is dual-licensed under MIT and Apache2.

Dependencies

~115KB