Struct Options

pub struct Options { /* private fields */ }

Options and flags that are used to customize the copying.

Implementations

impl Options

pub fn new() -> Self

Creates a blank new set of options ready for configuration.

pub fn clipboard(&mut self, clipboard: ClipboardType) -> &mut Self

Sets the clipboard to work with.

pub fn seat(&mut self, seat: Seat) -> &mut Self

Sets the seat to use for copying.

pub fn trim_newline(&mut self, trim_newline: bool) -> &mut Self

Sets the flag for trimming the trailing newline.

This flag is only applied for text MIME types.

pub fn foreground(&mut self, foreground: bool) -> &mut Self

Sets the flag for not spawning a separate thread for serving copy requests.

Setting this flag will result in the call to copy() blocking until all data sources it creates are destroyed, e.g. until someone else copies something into the clipboard.

pub fn serve_requests(&mut self, serve_requests: ServeRequests) -> &mut Self

Sets the number of requests to serve.

Limiting the number of requests to one effectively clears the clipboard after the first paste. It can be used when copying e.g. sensitive data, like passwords. Note however that certain apps may have issues pasting when this option is used, in particular XWayland clients are known to suffer from this.

pub fn omit_additional_text_mime_types( &mut self, omit_additional_text_mime_types: bool, ) -> &mut Self

Sets the flag for omitting additional text mime types which are offered by default if at least one text mime type is provided.

Omits additionally offered text/plain;charset=utf-8, text/plain, STRING, UTF8_STRING and TEXT mime types which are offered by default if at least one text mime type is provided.

pub fn copy(self, source: Source, mime_type: MimeType) -> Result<(), Error>

Invokes the copy operation. See copy().

Examples

use wl_clipboard_rs::copy::{MimeType, Options, Source};

let opts = Options::new();
opts.copy(Source::Bytes([1, 2, 3][..].into()), MimeType::Autodetect)?;

pub fn copy_multi(self, sources: Vec<MimeSource>) -> Result<(), Error>

Invokes the copy_multi operation. See copy_multi().

Examples

use wl_clipboard_rs::copy::{MimeSource, MimeType, Options, Source};

let opts = Options::new();
opts.copy_multi(vec![MimeSource { source: Source::Bytes([1, 2, 3][..].into()),
                                  mime_type: MimeType::Autodetect },
                     MimeSource { source: Source::Bytes([7, 8, 9][..].into()),
                                  mime_type: MimeType::Text }])?;

pub fn prepare_copy( self, source: Source, mime_type: MimeType, ) -> Result<PreparedCopy, Error>

Invokes the prepare_copy operation. See prepare_copy().

Panics

Panics if foreground is false.

Examples

use wl_clipboard_rs::copy::{MimeSource, MimeType, Options, Source};

let mut opts = Options::new();
opts.foreground(true);
let prepared_copy = opts.prepare_copy(Source::Bytes([1, 2, 3][..].into()),
                                      MimeType::Autodetect)?;
prepared_copy.serve()?;

pub fn prepare_copy_multi( self, sources: Vec<MimeSource>, ) -> Result<PreparedCopy, Error>

Invokes the prepare_copy_multi operation. See prepare_copy_multi().

Panics

Panics if foreground is false.

Examples

use wl_clipboard_rs::copy::{MimeSource, MimeType, Options, Source};

let mut opts = Options::new();
opts.foreground(true);
let prepared_copy =
    opts.prepare_copy_multi(vec![MimeSource { source: Source::Bytes([1, 2, 3][..].into()),
                                              mime_type: MimeType::Autodetect },
                                 MimeSource { source: Source::Bytes([7, 8, 9][..].into()),
                                              mime_type: MimeType::Text }])?;
prepared_copy.serve()?;

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl Hash for Options

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 Ord for Options

fn cmp(&self, other: &Options) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Options

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Options

fn partial_cmp(&self, other: &Options) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Options

impl StructuralPartialEq for Options