Struct ClipboardItem 

pub struct ClipboardItem {
    pub entries: Vec<ClipboardEntry>,
}

Something to put on the clipboard, or something read from it.

An item holds one or more ClipboardEntry values, such as text, an image or file paths. Use App::write_to_clipboard to copy an item, and App::read_from_clipboard to read one.

Examples

use gpui::{ClipboardEntry, ClipboardItem};

let item = ClipboardItem::new_string("hello".to_string());
assert_eq!(item.text().as_deref(), Some("hello"));
assert_eq!(item.metadata(), None);

let item = ClipboardItem::new_string_with_json_metadata("1, 2, 3".to_string(), vec![1, 2, 3]);
assert_eq!(item.metadata().map(String::as_str), Some("[1,2,3]"));

let ClipboardEntry::String(entry) = &item.entries()[0] else {
    panic!("expected a string entry");
};
assert_eq!(entry.metadata_json::<Vec<i32>>(), Some(vec![1, 2, 3]));

Fields

entries: Vec<ClipboardEntry>

The entries in this clipboard item.

Implementations

impl ClipboardItem

pub fn new_string(text: String) -> Self

Creates an item holding text, with no metadata.

pub fn new_string_with_metadata(text: String, metadata: String) -> Self

Creates an item holding text and a raw metadata string.

Use ClipboardItem::new_string_with_json_metadata to store structured data.

pub fn new_string_with_json_metadata<T: Serialize>( text: String, metadata: T, ) -> Self

Creates an item holding text and metadata, serialized as JSON.

Read the metadata back with ClipboardString::metadata_json.

Panics

Panics if metadata can’t be serialized to JSON, such as a map with non-string keys.

pub fn new_image(image: &Image) -> Self

Creates an item holding a copy of image.

pub fn text(&self) -> Option<String>

Returns the text of all string entries joined together, or None if the item has no text.

If the string entries contain no text, the file paths of any ClipboardEntry::ExternalPaths entries are joined with no separator instead. The result is None if there are no paths either.

pub fn metadata(&self) -> Option<&String>

Returns the metadata of the item’s string entry, or None.

Returns None unless the item has exactly one entry and that entry is a string.

pub fn entries(&self) -> &[ClipboardEntry]

Returns the item’s entries.

pub fn into_entries(self) -> impl Iterator<Item = ClipboardEntry>

Consumes the item and returns its entries.

Trait Implementations

impl Clone for ClipboardItem

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 ClipboardItem

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

Formats the value using the given formatter.

impl Eq for ClipboardItem

impl From<ClipboardEntry> for ClipboardItem

fn from(value: ClipboardEntry) -> Self

Converts to this type from the input type.

impl From<Image> for ClipboardItem

fn from(value: Image) -> Self

Converts to this type from the input type.

impl From<String> for ClipboardItem

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for ClipboardItem

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClipboardItem