https://github.com/1Password/arboard

A clipboard for Rust
https://github.com/1Password/arboard

Last synced: 12 days ago
JSON representation

A clipboard for Rust

• Host: GitHub
• URL: https://github.com/1Password/arboard
• Owner: 1Password
• License: apache-2.0
• Created: 2020-07-04T10:15:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-17T18:42:32.000Z (3 months ago)
• Last Synced: 2024-08-23T09:20:05.778Z (3 months ago)
• Language: Rust
• Size: 432 KB
• Stars: 622
• Watchers: 14
• Forks: 69
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE.txt

Awesome Lists containing this project

README

        
# Arboard (Arthur's Clipboard)

[![Latest version](https://img.shields.io/crates/v/arboard?color=mediumvioletred)](https://crates.io/crates/arboard)

[![Documentation](https://docs.rs/arboard/badge.svg)](https://docs.rs/arboard)

![MSRV](https://img.shields.io/badge/rustc-1.67.1+-blue.svg)

## General

This is a cross-platform library for interacting with the clipboard. It allows

to copy and paste both text and image data in a platform independent way on

Linux, Mac, and Windows.

## GNU/Linux

The GNU/Linux implementation uses the X protocol by default for managing the

clipboard but *fear not*  because Wayland works with the X11 protocol just as

well. Furthermore this implementation uses the Clipboard selection (as opposed

to the primary selection) and it sends the data to the clipboard manager when

the application exits so that the data placed onto the clipboard with your

application remains to be available after exiting.

There's also an optional wayland data control backend through the

`wl-clipboard-rs` crate. This can be enabled using the `wayland-data-control`

feature. When enabled this will be prioritized over the X11 backend, but if the

initialization fails, the implementation falls back to using the X11 protocol

automatically. Note that in my tests the wayland backend did not keep the

clipboard contents after the process exited. (Although neither did the X11

backend on my Wayland setup).

## Example

```rust

use arboard::Clipboard;

fn main() {

    let mut clipboard = Clipboard::new().unwrap();

    println!("Clipboard text was: {}", clipboard.get_text().unwrap());

    let the_string = "Hello, world!";

    clipboard.set_text(the_string).unwrap();

    println!("But now the clipboard text should be: \"{}\"", the_string);

}

```

## Yet another clipboard crate

This is a fork of `rust-clipboard`. The reason for forking instead of making a

PR is that `rust-clipboard` is not being maintained any more. Furthermore note

that the API of this crate is considerably different from that of

`rust-clipboard`. There are already a ton of clipboard crates out there which

is a bit unfortunate; I don't know why this is happening but while it is, we

might as well just start naming the clipboard crates after ourselves. This one

is arboard which stands for Artur's clipboard.