clipboard-stream

Async stream of clipboard change events. Provides real-time clipboard monitoring through an async Stream interface.

The main part of this crate is ClipboardStream. This struct implements Stream Trait.

Example

The following example shows how to receive clipboard items:

use clipboard_stream::{Body, ClipboardEventListener, Kind};
use futures::StreamExt;

#[tokio::main]
async fn main() {
    // Spawn a clipboard event listener
    let mut event_listener = ClipboardEventListener::spawn();

    // Create a new stream for UTF-8 strings with 32 buffers
    // This may return `Error::AlreadyExists` if the same kind of stream already exists
    let mut stream = event_listener.new_stream(Kind::Utf8String, 32).unwrap();

    // Text is printed when the clipboard is updated(Copy operation)
    while let Some(content) = stream.next().await {
        match content {
            Ok(v) => match v {
                Body::Utf8String(v) => println!("got string: {}", v),
            },
            Err(e) => eprintln!("{}", e),
        }
    }
}

Runtime

Internally, this crate spawns a small dedicated OS thread to listen for clipboard events. The API itself is Future-based and does not depend on any specific async runtime, so it works with tokio, smol, or any runtime compatible with futures.

Platforms

• macOS

Currently supported on macOS only. Windows support is planned for a future release.

License

clipboard-stream is provided under the MIT license.See LICENSE