summaryrefslogtreecommitdiffstats
path: root/core/src/clipboard.rs
blob: ff2e31d0bd708b66aff5f1b873e21e97e10f8ed3 (plain) (blame)
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
//! Access the clipboard.

/// A buffer for short-term storage and transfer within and between
/// applications.
pub trait Clipboard {
    /// Reads the current content of the [`Clipboard`] as text.
    fn read(&self) -> Option<String>;

    /// Writes the given text contents to the [`Clipboard`].
    fn write(&mut self, contents: String);

    /// Reads the current content of Primary as text.
    fn read_primary(&self) -> Option<String>;

    /// Writes the given text contents to Primary.
    fn write_primary(&mut self, contents: String);
}

/// A null implementation of the [`Clipboard`] trait.
#[derive(Debug, Clone, Copy)]
pub struct Null;

impl Clipboard for Null {
    fn read(&self) -> Option<String> {
        None
    }

    fn write(&mut self, _contents: String) {}

    fn read_primary(&self) -> Option<String> {
        None
    }

    fn write_primary(&mut self, _contents: String) {}
}