Skip to main content

InputSimulator

Struct InputSimulator 

Source
pub struct InputSimulator { /* private fields */ }
Expand description

Platform-independent input simulator.

Construct with InputSimulator::new; on unsupported platforms it returns crate::error::RdesktopError::UnsupportedPlatform. The simulator holds no threads and is cheap to keep around — create one and reuse it.

Implementations§

Source§

impl InputSimulator

Source

pub fn new() -> Result<Self>

Create a platform simulator. Errors on unsupported platforms.

Source

pub fn press_key(&self, key: Key) -> Result<()>

Hold a key down (no auto release).

Source

pub fn release_key(&self, key: Key) -> Result<()>

Release a held key.

Source

pub fn tap_key(&self, key: Key) -> Result<()>

Press then immediately release a key.

Source

pub fn tap_combo(&self, keys: &[Key]) -> Result<()>

Press every key in keys, then release them in reverse order. Use this for chords such as Ctrl+C: pass [Key::Letter('c')] after holding Ctrl via InputSimulator::press_key, or build the whole chord from raw keys and let this method do press/release ordering.

Source

pub fn type_text(&self, text: &str) -> Result<()>

Type arbitrary text as if entered on the keyboard. Uses Unicode input events, so it works for any character (including non-ASCII).

Source

pub fn move_mouse(&self, x: i32, y: i32, absolute: bool) -> Result<()>

Move the mouse. When absolute is true, (x, y) are screen coordinates; otherwise they are relative mickeys (pixels).

Source

pub fn press_mouse(&self, button: MouseButton) -> Result<()>

Hold a mouse button down.

Source

pub fn release_mouse(&self, button: MouseButton) -> Result<()>

Release a held mouse button.

Source

pub fn click(&self, button: MouseButton) -> Result<()>

Click (press + release) a mouse button at the current position.

Source

pub fn scroll(&self, delta: i32) -> Result<()>

Scroll the wheel by delta units (positive = away from the user).

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more