Struct Set

pub struct Set<'clipboard> {
    pub(crate) platform: Set<'clipboard>,
}

A builder for an operation that sets a value to the clipboard.

Fields

platform: Set<'clipboard>

Implementations

impl Set<'_>

pub fn text<'a, T: Into<Cow<'a, str>>>(self, text: T) -> Result<(), Error>

Completes the “set” operation by placing text onto the clipboard. Any valid UTF-8 string is accepted.

pub fn html<'a, T: Into<Cow<'a, str>>>( self, html: T, alt_text: Option<T>, ) -> Result<(), Error>

Completes the “set” operation by placing HTML as well as a plain-text alternative onto the clipboard.

Any valid UTF-8 string is accepted.

pub fn image(self, image: ImageData<'_>) -> Result<(), Error>

Completes the “set” operation by placing an image onto the clipboard.

The chosen output format, depending on the platform is the following:

• On macOS: NSImage object
• On Linux: PNG, under the atom image/png
• On Windows: In order of priority CF_DIB and CF_BITMAP

pub fn file_list(self, file_list: &[impl AsRef<Path>]) -> Result<(), Error>

Completes the “set” operation by placing a list of file paths onto the clipboard.

Trait Implementations

impl SetExtLinux for Set<'_>

fn wait(self) -> Self

Whether to wait for the clipboard’s contents to be replaced after setting it.

fn clipboard(self, selection: LinuxClipboardKind) -> Self

Sets the clipboard the operation will store its data to.

fn wait_until(self, deadline: Instant) -> Self

Whether or not to wait for the clipboard’s content to be replaced after setting it. This waits until the deadline has exceeded.

fn exclude_from_history(self) -> Self

Excludes the data which will be set on the clipboard from being added to the desktop clipboard managers’ histories by adding the MIME-Type x-kde-passwordMangagerHint to the clipboard’s selection data.

impl Sealed for Set<'_>