cli_clipboard/common.rs
1/*
2Copyright 2016 Avraham Weinstock
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15*/
16
17use crate::Result;
18
19/// Trait for clipboard access
20pub trait ClipboardProvider: Sized {
21 /// Create a context with which to access the clipboard
22 fn new() -> Result<Self>;
23 /// Method to get the clipboard contents as a String
24 fn get_contents(&mut self) -> Result<String>;
25 /// Method to set the clipboard contents as a String
26 fn set_contents(&mut self, content: String) -> Result<()>;
27 // TODO: come up with some platform-agnostic API for richer types
28 // than just strings (c.f. issue #31)
29 /// Method to clear the clipboard
30 fn clear(&mut self) -> Result<()>;
31}