Struct DataTransferItem 

pub struct DataTransferItem { /* private fields */ }

A mutable implementation of IDataTransferItem and IAsyncDataTransferItem. This type also provides several functions to easily create a DataTransferItem for common usages.

While it also implements IAsyncDataTransferItem, this type always returns data synchronously. For advanced usages, consider implementing IAsyncDataTransferItem directly.

Implementations

impl DataTransferItem

pub fn new() -> Rc<DataTransferItem>

Creates an item without any format.

pub fn formats(&self) -> Rc<[DataFormat]>

Gets the formats supported by this item.

pub fn contains(&self, format: &DataFormat) -> bool

Gets whether the item supports a specific format.

pub fn try_get_raw(&self, format: &DataFormat) -> Option<Rc<dyn Any>>

Tries to get a value for a given format. Returns None if the format is not supported.

pub fn try_get_value<T: Clone + 'static>( &self, format: &DataFormatOf<T>, ) -> Option<T>

Tries to get a typed value for a given format.

pub fn set<T: 'static>(&self, format: &DataFormatOf<T>, value: Option<T>)

Sets the value for a given format.

If value is None, the format won’t be part of the item.

pub fn set_with<T: 'static>( &self, format: &DataFormatOf<T>, get_value: impl Fn() -> Option<T> + 'static, )

Sets a value created on demand for a given format.

pub fn set_text(&self, value: Option<&str>)

Sets the value for the DataFormat::text format.

If value is None, the format won’t be part of the item.

pub fn set_file(&self, value: Option<Rc<dyn IStorageItem>>)

Sets the value for the DataFormat::file format.

If value is None, the format won’t be part of the item.

pub fn set_bitmap(&self, value: Option<Rc<Bitmap>>)

Sets the value for the DataFormat::bitmap format.

If value is None, the format won’t be part of the item.

pub fn create<T: 'static>( format: &DataFormatOf<T>, value: Option<T>, ) -> Rc<DataTransferItem>

Creates a new item for a single format with a given value.

If value is None, the format won’t be part of the item.

pub fn create_with<T: 'static>( format: &DataFormatOf<T>, get_value: impl Fn() -> Option<T> + 'static, ) -> Rc<DataTransferItem>

Creates a new item for a single format with a given value created on demand.

pub fn create_text(value: Option<&str>) -> Rc<DataTransferItem>

Creates a new item with DataFormat::text as a single format.

If value is None, the format won’t be part of the item.

pub fn create_file(value: Option<Rc<dyn IStorageItem>>) -> Rc<DataTransferItem>

Creates a new item with DataFormat::file as a single format.

If value is None, the format won’t be part of the item.

Trait Implementations

impl IAsyncDataTransferItem for DataTransferItem

fn formats(&self) -> Rc<[DataFormat]>

Gets the formats supported by this item.

fn try_get_raw_async( &self, format: &DataFormat, ) -> LocalBoxFuture<Result<Option<Rc<dyn Any>>, ClipboardError>>

Tries to get a value for a given format. The future resolves to None if the format is not supported, and to an error if the platform providing the value fails.

fn try_formats(&self) -> Result<Rc<[DataFormat]>, ClipboardError>

Gets the formats supported by this item, or the failure of the platform that provides them.

impl IDataTransferItem for DataTransferItem

fn formats(&self) -> Rc<[DataFormat]>

Gets the formats supported by this item.

fn try_get_raw(&self, format: &DataFormat) -> Option<Rc<dyn Any>>

Tries to get a value for a given format. Returns None if the format is not supported.