Rust MIT

clipboard-rs

Cross-platform clipboard API (text | image | rich text | html | files | monitoring changes) | 跨平台剪贴板 API(文本|图片|富文本|html|文件|监听变化) Windows,MacOS,Linux

C

ChurchTao

Dernière activité 30 juin 2026
ChurchTao/clipboard-rs

181

étoiles

28

forks

5

issues ouvertes

clipboardcross-platformelectronrusttauri

Ce README est souvent en anglais.

clipboard-rs

Latest version Documentation GitHub Actions Workflow Status MSRV GitHub License

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 (In PNG format)
  • File (In file-uri-list format)
  • Any type (by specifying the type identifier) can be obtained through the available_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 your Cargo.toml:

[dependencies]
clipboard-rs = "0.3.5"

Examples

All Usage Examples

Examples

Simple Read and Write

use clipboard_rs::{Clipboard, ClipboardContext, ContentFormat};

fn main() {
	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};

const TMP_PATH: &str = "/tmp/";

fn main() {
	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};

fn main() {
    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};

struct Manager {
	ctx: ClipboardContext,
}

impl Manager {
	pub fn new() -> Self {
		let ctx = ClipboardContext::new().unwrap();
		Manager { ctx }
	}
}

impl ClipboardHandler for Manager {
	fn on_clipboard_change(&mut self) {
		println!(
			"on_clipboard_change, txt = {}",
			self.ctx.get_text().unwrap()
		);
	}
}

fn main() {
	let manager = Manager::new();

	let mut 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 creating ClipboardContext using new_with_options:

#[cfg(unix)]
fn setup_clipboard() -> ClipboardContext {
	ClipboardContext::new_with_options(ClipboardContextX11Options { read_timeout: None }).unwrap()
}

#[cfg(not(unix))]
fn setup_clipboard(ctx: &mut ClipboardContext) -> 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.

Thanks

Contract

if you have any questions, you can contact me by email: swkzymlyy@gmail.com

Chinese users can also contact me by wechatNo: uniq_idx_church_lynn

License

This project is licensed under the MIT License. See the LICENSE file for details.

Projets similaires

🎉跨平台的剪贴板管理工具 | Cross-platform clipboard management tool

Rustapplicationclipboardclipboard-manager
EEcoPasteHub
7,5 k étoiles392

QuickClipboard 是一款跨平台剪贴板增强工具(现支持Windows,Android),基于 Tauri 2 + Rust + React 构建。它在你复制的那一刻就开始工作——自动记录文本、图片、富文本、文件,让你随时找回曾经复制过的任何内容。不只是记录,QuickClipboard 还集成了贴图、OCR、局域网同步等能力,是日常办公效率的全面提升

Rust
Mmosheng1
2,1 k étoiles105

轻量化剪贴板管理工具,使用 Rust + GPUI 构建 | Lightweight clipboard manager built with Rust and GPUI.

Rustclipboardclipboard-managerclipboard-sync
RRuszero01
381 étoiles11