Struct enigo::Enigo

pub struct Enigo { /* private fields */ }

Implementations

impl Enigo

pub fn new(settings: &Settings) -> Result<Self, NewConError>

Create a new Enigo struct to establish the connection to simulate input with the specified settings

Errors

Have a look at the documentation of NewConError to see under which conditions an error will be returned.

pub fn delay(&self) -> u32

Get the delay per keypress

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

Set the delay per keypress

pub fn held(&mut self) -> (Vec<Key>, Vec<u16>)

Returns a list of all currently pressed keys

Trait Implementations

impl Agent for Enigo

fn execute(&mut self, token: &Token) -> InputResult<()>

Execute the action associated with the token. A Token::Text will enter text, a Token::Scroll will scroll and so forth. Have a look at the documentation of the Token enum for more information.

impl Debug for Enigo

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

Formats the value using the given formatter.

impl Drop for Enigo

fn drop(&mut self)

Executes the destructor for this type.

impl Keyboard for Enigo

fn key(&mut self, key: Key, direction: Direction) -> InputResult<()>

Sends an individual key event. It will enter the keysym (virtual key). Have a look at the Keyboard::raw function, if you want to enter a keycode.

fn raw(&mut self, keycode: u16, direction: Direction) -> InputResult<()>

Sends a raw keycode. The keycode may or may not be mapped on the current layout. You have to make sure of that yourself. This can be useful if you want to simulate a press regardless of the layout (WASD on video games). Have a look at the Keyboard::key function, if you just want to enter a specific key and don’t want to worry about the layout/keymap. Windows only: If you want to enter the keycode (scancode) of an extended key, you need to set extra bits. You can for example do: enigo.raw(45 | EXT, Direction::Click)

fn text(&mut self, text: &str) -> InputResult<()>

Enter the text Use a fast method to enter the text, if it is available. You can use unicode here like: ❤️. This works regardless of the current keyboard layout. You cannot use this function for entering shortcuts or something similar. For shortcuts, use the Keyboard::key method instead.

impl Mouse for Enigo

fn button(&mut self, button: Button, direction: Direction) -> InputResult<()>

Sends an individual mouse button event. You can use this for example to simulate a click of the left mouse key. Some of the buttons are specific to a platform.

fn move_mouse( &mut self, x: i32, y: i32, coordinate: Coordinate ) -> InputResult<()>

Move the mouse cursor to the specified x and y coordinates.

fn scroll(&mut self, length: i32, axis: Axis) -> InputResult<()>

Send a mouse scroll event

fn main_display(&self) -> InputResult<(i32, i32)>

Get the (width, height) of the main display in pixels. This currently only works on the main display

fn location(&self) -> InputResult<(i32, i32)>

Get the location of the mouse in pixels