Struct DataFormat 

pub struct DataFormat { /* private fields */ }

Represents a format usable with the clipboard and drag-and-drop.

A format is a value: two formats are equal when their kind and their identifier are equal. The typed counterpart, which also carries the type of the data, is DataFormatOf; it dereferences to DataFormat.

Implementations

impl DataFormat

pub fn data_type(&self) -> Option<TypeId>

The type of the values of the format (String for a format of strings, Rc<[u8]> for a format of bytes), when the format was created with one: the counterpart of asking whether a format of the managed original is a DataFormat<string> or a DataFormat<byte[]>, which a platform backend does to decide how to read data the system does not describe. Two formats that differ in it alone are equal.

pub fn kind(&self) -> DataFormatKind

The kind of the data format.

pub fn identifier(&self) -> &str

The identifier of the data format.

pub fn text() -> DataFormatOf<String>

A data format representing plain text. Its data type is String.

pub fn bitmap() -> DataFormatOf<Rc<Bitmap>>

A data format representing a bitmap. Its data type is a shared Bitmap.

pub fn file() -> DataFormatOf<Rc<dyn IStorageItem>>

A data format representing a single file. Its data type is a shared IStorageItem.

pub fn to_system_name(&self, application_prefix: &str) -> String

Creates a name for this format, usable by the underlying platform.

application_prefix is the system prefix used to recognize the name as an application format.

Panics

This method can only be called if kind is DataFormatKind::Application or DataFormatKind::Platform.

pub fn create_bytes_application_format( identifier: &str, ) -> DataFormatOf<Rc<[u8]>>

Creates a new format specific to the application that returns an array of bytes.

To avoid conflicts with system identifiers, identifier isn’t passed to the underlying platform directly. However, two different applications using the same identifier with create_bytes_application_format or create_string_application_format are able to share data using this format.

Panics

Only ASCII letters (A-Z, a-z), digits (0-9), the dot (.) and the hyphen (-) are accepted in the identifier, which must not be empty.

pub fn create_string_application_format( identifier: &str, ) -> DataFormatOf<String>

Creates a new format specific to the application that returns a String.

See create_bytes_application_format for the identifier.

pub fn create_in_process_format<T: 'static>(identifier: &str) -> DataFormatOf<T>

Creates a new format that stays within the current process and is never serialized to a platform clipboard or drag-and-drop operation.

T is the data type. identifier is only used for equality comparisons within the process and is never passed to the underlying platform.

Panics

Panics if the identifier is empty.

pub fn create_bytes_platform_format(identifier: &str) -> DataFormatOf<Rc<[u8]>>

Creates a new format for the current platform that returns an array of bytes.

identifier is not validated and is passed as is to the underlying platform. Most systems use mime types, but macOS requires Uniform Type Identifiers (UTI).

Panics

Panics if the identifier is empty.

pub fn create_string_platform_format(identifier: &str) -> DataFormatOf<String>

Creates a new format for the current platform that returns a String.

See create_bytes_platform_format for the identifier.

pub fn from_system_name<T: 'static>( system_name: &str, application_prefix: &str, ) -> DataFormatOf<T>

Creates a format from a name coming from the underlying platform.

application_prefix is the system prefix used to recognize the name as an application format. This is an implementation detail of the platform backends.

Trait Implementations

impl Clone for DataFormat

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataFormat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for DataFormat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for DataFormat

impl<T> From<DataFormatOf<T>> for DataFormat

fn from(value: DataFormatOf<T>) -> DataFormat

Converts to this type from the input type.

impl Hash for DataFormat

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DataFormat

fn eq(&self, other: &DataFormat) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T> PartialEq<DataFormat> for DataFormatOf<T>

fn eq(&self, other: &DataFormat) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T> PartialEq<DataFormatOf<T>> for DataFormat

fn eq(&self, other: &DataFormatOf<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.