Skip to main content

ClipboardSource

Struct ClipboardSource 

Source
pub struct ClipboardSource<R: ClipboardReader = RealClipboard> { /* private fields */ }
Expand description

Collect input from the system clipboard.

This source reads text from the system clipboard. It is available when the clipboard contains non-empty text content.

§Platform Support

  • macOS: Uses pbpaste
  • Linux: Uses xclip -selection clipboard -o
  • Other: Returns an error

§Example

use standout_input::{InputChain, ArgSource, ClipboardSource};

let chain = InputChain::<String>::new()
    .try_source(ArgSource::new("content"))
    .try_source(ClipboardSource::new());

§Testing

Use ClipboardSource::with_reader to inject a mock for testing:

use standout_input::{ClipboardSource, MockClipboard};

let source = ClipboardSource::with_reader(MockClipboard::with_content("clipboard text"));

Implementations§

Source§

impl ClipboardSource<RealClipboard>

Source

pub fn new() -> Self

Create a new clipboard source using real system clipboard.

Source§

impl<R: ClipboardReader> ClipboardSource<R>

Source

pub fn with_reader(reader: R) -> Self

Create a clipboard source with a custom reader.

This is primarily used for testing to inject mock clipboard.

Source

pub fn trim(self, trim: bool) -> Self

Control whether to trim whitespace from the clipboard content.

Default is true.

Trait Implementations§

Source§

impl<R: Clone + ClipboardReader> Clone for ClipboardSource<R>

Source§

fn clone(&self) -> ClipboardSource<R>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ClipboardSource<RealClipboard>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<R: ClipboardReader + 'static> InputCollector<String> for ClipboardSource<R>

Source§

fn name(&self) -> &'static str

Human-readable name for this collector. Read more
Source§

fn is_available(&self, _matches: &ArgMatches) -> bool

Check if this collector can provide input in the current environment. Read more
Source§

fn collect(&self, _matches: &ArgMatches) -> Result<Option<String>, InputError>

Attempt to collect input from this source. Read more
Source§

fn validate(&self, _value: &T) -> Result<(), String>

Validate the collected value. Read more
Source§

fn can_retry(&self) -> bool

Whether this collector supports retry on validation failure. Read more

Auto Trait Implementations§

§

impl<R> Freeze for ClipboardSource<R>

§

impl<R> RefUnwindSafe for ClipboardSource<R>
where R: RefUnwindSafe,

§

impl<R> Send for ClipboardSource<R>

§

impl<R> Sync for ClipboardSource<R>

§

impl<R> Unpin for ClipboardSource<R>

§

impl<R> UnsafeUnpin for ClipboardSource<R>

§

impl<R> UnwindSafe for ClipboardSource<R>
where R: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.