clipboard-stream 0.2.1

Async stream of clipboard change events
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# clipboard-stream
[![crates.io](https://img.shields.io/crates/v/clipboard-stream.svg)](https://crates.io/crates/clipboard-stream)
[![docs.rs](https://img.shields.io/docsrs/clipboard-stream/latest)](https://docs.rs/clipboard-stream)
![GitHub License](https://img.shields.io/github/license/nakaryo716/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:
```rust
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](LICENSE)