clipboard-stream 0.2.1

//! 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`].
//!
//! # Example
//! The following example shows how to receive clipboard items:
//!
//! ```no_run
//! use clipboard_stream::{ClipboardEventListener, Kind};
//! use futures::stream::StreamExt;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     // Spawn a clipboard event listener
//!     let mut event_listener = ClipboardEventListener::spawn();
//!
//!     // Create a new stream for UTF-8 strings
//!     // This may return `Error::AlreadyExists` if the same kind of stream already exists
//!     let mut stream = event_listener.new_stream(Kind::Utf8String, 32)?;
//!
//!     while let Some(body) = stream.next().await {
//!         if let Ok(v) = body {
//!             println!("{:?}", v);
//!         }
//!     }
//!     Ok(())
//! }
//! ```
//!
//! # 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`](https://docs.rs/tokio), [`smol`](https://docs.rs/smol), or any runtime compatible with
//! [`futures`](https://docs.rs/futures).
//!
//! # Platforms
//! - macOS
//!
//! Currently supported on **macOS only**. Windows support is planned for a future release.
//!
//! [`Stream`]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
//! [`ClipboardStream`]: crate::stream::ClipboardStream
mod body;
mod driver;
mod error;
mod event_listener;
mod stream;
mod sys;

pub use crate::body::{Body, Kind};
pub use crate::error::Error;
pub use crate::event_listener::ClipboardEventListener;
pub use crate::stream::ClipboardStream;

pub(crate) type Msg = Result<Body, crate::error::Error>;