Struct arboard::Set

pub struct Set<'clipboard> { /* private fields */ }

A builder for an operation that sets a value to the 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

Trait Implementations

impl SetExtWindows for Set<'_>

fn exclude_from_monitoring(self) -> Self

Exclude the data which will be set on the clipboard from being processed at all, either in the local clipboard history or getting uploaded to the cloud.

fn exclude_from_cloud(self) -> Self

Excludes the data which will be set on the clipboard from being uploaded to the Windows 10/11 cloud clipboard.

fn exclude_from_history(self) -> Self

Excludes the data which will be set on the clipboard from being added to the system’s clipboard history list.