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
49

use std::{
    pin::Pin,
    task::{Context, Poll},
};

use futures::{Stream, channel::mpsc::Receiver};

use crate::{
    Msg,
    body::{Body, BodySendersDropHandle, Kind},
};

/// Asynchronous stream for fetching clipboard item.
///
/// When the clipboard is updated, the [`ClipboardStream`] polls for the yields the new data.
///
/// # Example
/// ```
/// # use clipboard_stream::{ClipboardStream};
/// # use futures::stream::StreamExt;
/// # async fn stream(mut stream: ClipboardStream) {
/// // stream: ClipboardStream
/// while let Some(body) = stream.next().await {
///     if let Ok(v) = body {
///         println!("{:?}", v);
///     }
/// }
/// # }
/// ```
#[derive(Debug)]
pub struct ClipboardStream {
    pub(crate) body_rx: Pin<Box<Receiver<Msg>>>,
    pub(crate) kind: Kind,
    pub(crate) drop_handle: BodySendersDropHandle,
}

impl Stream for ClipboardStream {
    type Item = Result<Body, crate::error::Error>;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        self.body_rx.as_mut().poll_next(cx)
    }
}

impl Drop for ClipboardStream {
    fn drop(&mut self) {
        self.drop_handle.drop(&self.kind);
    }
}