Struct enigo::Enigo

pub struct Enigo { /* fields omitted */ }

The main struct for handling the event emitting

Methods

impl Enigo

pub fn delay(&self) -> u64

Get the delay per keypress. Default value is 12000. This is Linux-specific.

pub fn set_delay(&mut self, delay: u64)

Set the delay per keypress. This is Linux-specific.

impl Enigo

pub fn new() -> Self

Constructs a new Enigo instance.

Example

use enigo::*;
let mut enigo = Enigo::new();

Trait Implementations

impl MouseControllable for Enigo

fn mouse_move_to(&mut self, x: i32, y: i32)

Lets the mouse cursor move to the specified x and y coordinates.

fn mouse_move_relative(&mut self, x: i32, y: i32)

Lets the mouse cursor move the specified amount in the x and y direction.

fn mouse_down(&mut self, button: MouseButton)

Push down one of the mouse buttons

fn mouse_up(&mut self, button: MouseButton)

Lift up a pushed down mouse button

fn mouse_click(&mut self, button: MouseButton)

Click a mouse button

fn mouse_scroll_x(&mut self, length: i32)

Scroll the mouse (wheel) left or right

fn mouse_scroll_y(&mut self, length: i32)

Scroll the mouse (wheel) up or down

impl KeyboardControllable for Enigo

fn key_sequence(&mut self, sequence: &str)

Types the string

fn key_down(&mut self, key: Key)

presses a given key down

fn key_up(&mut self, key: Key)

release a given key formally pressed down by key_down

fn key_click(&mut self, key: Key)

Much like the key_down and key_up function they're just invoked consecutively

fn key_sequence_parse(&mut self, sequence: &str) where
    Self: Sized, 

Types the string parsed with DSL.

fn key_sequence_parse_try(&mut self, sequence: &str) -> Result<(), ParseError> where
    Self: Sized, 

Same as key_sequence_parse except returns any errors

impl Drop for Enigo

fn drop(&mut self)

Executes the destructor for this type.

impl Default for Enigo

fn default() -> Self

Create a new Enigo instance

impl Send for Enigo

impl Debug for Enigo

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

Formats the value using the given formatter.