Struct ClipboardString 

pub struct ClipboardString {
    pub text: String,
    pub metadata: Option<String>,
}

A string on the clipboard, with optional metadata.

Metadata lets an application record more about copied text, such as where it came from. The metadata is stored with the text and read back with ClipboardString::metadata_json.

Fields

text: String

The text content.

metadata: Option<String>

Optional metadata associated with this clipboard string.

Implementations

impl ClipboardString

pub fn new(text: String) -> Self

Creates a clipboard string with text and no metadata.

pub fn with_json_metadata<T: Serialize>(self, metadata: T) -> Self

Sets the metadata to metadata, serialized as JSON. Returns the updated string.

Panics

Panics if metadata can’t be serialized to JSON.

pub fn text(&self) -> &String

Returns the text.

pub fn into_text(self) -> String

Consumes the string and returns its text.

pub fn metadata_json<T>(&self) -> Option<T>

where T: for<'a> Deserialize<'a>,

Returns the metadata deserialized as T.

Returns None if there is no metadata or it doesn’t deserialize as T.

pub fn text_hash(text: &str) -> u64

Returns a hash of text. Use it to detect whether the clipboard text has changed.

Trait Implementations

impl Clone for ClipboardString

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 ClipboardString

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

Formats the value using the given formatter.

impl Eq for ClipboardString

impl From<ClipboardString> for ClipboardEntry

fn from(value: ClipboardString) -> Self

Converts to this type from the input type.

impl From<String> for ClipboardString

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for ClipboardString

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClipboardString