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

/*
Copyright 2016 Avraham Weinstock

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

use crate::Result;

/// Trait for clipboard access
pub trait ClipboardProvider: Sized {
    /// Create a context with which to access the clipboard
    fn new() -> Result<Self>;
    /// Method to get the clipboard contents as a String
    fn get_contents(&mut self) -> Result<String>;
    /// Method to set the clipboard contents as a String
    fn set_contents(&mut self, content: String) -> Result<()>;
    // TODO: come up with some platform-agnostic API for richer types
    // than just strings (c.f. issue #31)
    /// Method to clear the clipboard
    fn clear(&mut self) -> Result<()>;
}