Struct clipboard_win::Clipboard

pub struct Clipboard { /* fields omitted */ }

Clipboard accessor.

Note:

You can have only one such accessor across your program.

Warning:

In Windows Clipboard opens globally and only one application can set data onto format at the time.

Therefore as soon as operations are finished, user is advised to close Clipboard.

Implementations

impl Clipboard

pub fn new() -> Result<Clipboard>

Initializes new clipboard accessor.

Attempts to open clipboard.

pub fn new_attempts(num: usize) -> Result<Clipboard>

Attempts to initialize clipboard num times before giving up.

pub fn empty(&self) -> Result<&Clipboard>

Empties clipboard.

pub fn size(&self, format: u32) -> Option<usize>

Retrieves size of clipboard content.

pub fn set(&self, format: u32, data: &[u8]) -> Result<()>

Sets data onto clipboard with specified format.

Wraps raw::set()

pub fn set_string(&self, text: &str) -> Result<()>

Sets str or String onto clipboard as Unicode format.

Under hood it transforms Rust UTF-8 String into UTF-16

pub fn get(&self, format: u32, data: &mut [u8]) -> Result<usize>

Retrieves data of specified format from clipboard.

Wraps raw::get()

pub fn get_string(&self, storage: &mut String) -> Result<()>

Retrieves String of CF_UNICODETEXT format from clipboard.

Wraps raw::get_string()

pub fn get_file_list(&self) -> Result<Vec<PathBuf>>

Retrieves a list of file paths from the CF_HDROP format from the clipboard.

Wraps raw::get_file_list()

pub fn get_dib(&self) -> Result<Image>

Retrieves Bitmap of CF_DIB

pub fn get_bitmap(&self) -> Result<Image>

Retrieves Bitmap of CF_BITMAP

pub fn set_bitmap(&self, image: &Image) -> Result<()>

Sets bitmap image onto clipboard as CF_BITMAP

pub fn enum_formats(&self) -> EnumFormats

Enumerator over all formats on clipboard..

pub fn seq_num() -> Option<u32>

Returns Clipboard sequence number.

pub fn is_format_avail(format: u32) -> bool

Determines whenever provided clipboard format is available on clipboard or not.

pub fn count_formats() -> Result<i32>

Retrieves number of currently available formats on clipboard.

Trait Implementations

impl Drop for Clipboard

fn drop(&mut self)

Executes the destructor for this type.