Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 143 Commits
.github		.github
.vscode		.vscode
examples		examples
src		src
tests		tests
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
Cargo.toml		Cargo.toml
LICENSE		LICENSE
README.md		README.md
README_ZH.md		README_ZH.md
rustfmt.toml		rustfmt.toml

Repository files navigation

clipboard-rs

clipboard-rs is a cross-platform library written in Rust for getting and setting the system-level clipboard content. It supports Linux, Windows, and MacOS.

简体中文

Function Support

Plain text
Html
Rich text
Image (InPNG format)
File (Infile-uri-list format)
Any type (by specifying the type identifier) can be obtained through theavailable_formats method

Platform Support Type Comparison Table

Type	Windows	macOS	Linux(X11)	iOS(Beta)	Android(WIP)
Plain Text	✅	✅	✅	✅	🚧
HTML	✅	✅	✅	✅	🚧
RTF	✅	✅	✅	✅	🚧
Image	PNG(preferred)/DIBV5	PNG(preferred)/TIFF	PNG	PNG	🚧
File List	✅	✅	✅	❌	🚧
Custom Type	✅	✅	✅	✅	🚧
Watch Changes	✅	✅	✅	✅	🚧

Development Plan

MacOS Support
Linux Support (x11)
Windows Support
iOS Support (Beta)
Android Support (🚧)

Usage

Add the following content to yourCargo.toml:

[dependencies]clipboard-rs ="0.3.0"

CHANGELOG

Examples

All Usage Examples

Examples

Simple Read and Write

use clipboard_rs::{Clipboard,ClipboardContext,ContentFormat};fnmain(){let ctx =ClipboardContext::new().unwrap();let types = ctx.available_formats().unwrap();println!("{:?}", types);let has_rtf = ctx.has(ContentFormat::Rtf);println!("has_rtf={}", has_rtf);let rtf = ctx.get_rich_text().unwrap_or("".to_string());println!("rtf={}", rtf);let has_html = ctx.has(ContentFormat::Html);println!("has_html={}", has_html);let html = ctx.get_html().unwrap_or("".to_string());println!("html={}", html);let content = ctx.get_text().unwrap_or("".to_string());println!("txt={}", content);}

Reading Images

use clipboard_rs::{common::RustImage,Clipboard,ClipboardContext};constTMP_PATH:&str ="/tmp/";fnmain(){let ctx =ClipboardContext::new().unwrap();let types = ctx.available_formats().unwrap();println!("{:?}", types);let img = ctx.get_image();match img{Ok(img) =>{img.save_to_path(format!("{}test.png",TMP_PATH).as_str()).unwrap();let resize_img = img.thumbnail(300,300).unwrap();resize_img.save_to_path(format!("{}test_thumbnail.png",TMP_PATH).as_str()).unwrap();}Err(err) =>{println!("err={}", err);}}}

Reading Any Format

use clipboard_rs::{Clipboard,ClipboardContext};fnmain(){let ctx =ClipboardContext::new().unwrap();let types = ctx.available_formats().unwrap();println!("{:?}", types);let buffer = ctx.get_buffer("public.html").unwrap();let string =String::from_utf8(buffer).unwrap();println!("{}", string);}

Listening to Clipboard Changes

use clipboard_rs::{Clipboard,ClipboardContext,ClipboardHandler,ClipboardWatcher,ClipboardWatcherContext,};use std::{thread, time::Duration};structManager{ctx:ClipboardContext,}implManager{pubfnnew() ->Self{let ctx =ClipboardContext::new().unwrap();Manager{ ctx}}}implClipboardHandlerforManager{fnon_clipboard_change(&mutself){println!("on_clipboard_change, txt = {}",self.ctx.get_text().unwrap());}}fnmain(){let manager =Manager::new();letmut watcher =ClipboardWatcherContext::new().unwrap();let watcher_shutdown = watcher.add_handler(manager).get_shutdown_channel();thread::spawn(move ||{thread::sleep(Duration::from_secs(5));println!("stop watch!");watcher_shutdown.stop();});println!("start watch!");watcher.start_watch();}

X11 - Clipboard Read Timeout

By default, in X11 clipboard-rs implements a read timeout of 500 ms. You can override or disable this timeout by creatingClipboardContext usingnew_with_options:

#[cfg(unix)]fnsetup_clipboard() ->ClipboardContext{ClipboardContext::new_with_options(ClipboardContextX11Options{read_timeout:None}).unwrap()}#[cfg(not(unix))]fnsetup_clipboard(ctx:&mutClipboardContext) ->ClipboardContext{ClipboardContext::new().unwrap()}

Contributing

You are welcome to submit PRs and issues and contribute your code or ideas to the project. Due to my limited level, the library may also have bugs. You are welcome to point them out and I will modify them as soon as possible.