Struct macmatic::Bot

pub struct Bot {
    pub window: Option<Window>,
    /* private fields */
}

The Bot struct provides automation capabilities for interacting with a window.

Fields

window: Option<Window>

The Window that the Bot interacts with.

Implementations

impl Bot

pub fn new() -> Bot

Creates a new instance of Bot.

pub fn set_window_from_name(&mut self, name: &str)

Sets the window based on the specified name.

pub fn set_window_from_regex(&mut self, regex: &str)

Sets the window based on the specified regex.

pub fn set_window_from_id(&mut self, id: i64)

Sets the window based on the specified id.

pub fn set_controller(&mut self, controller: Enigo)

Sets the Enigo controller.

pub fn set_high_dpi_ratio(&mut self, ratio: u32)

Sets High DPI mode (for standard screen: 1, for Retina-like: 2).

pub fn set_wait_time(&mut self, duration: Duration)

Sets the delay between mouse move and mouse down and up.

pub fn set_capture_frequency(&mut self, value: f32)

Sets the number of captures per seconds.

pub fn sleep(&mut self, millis: u64)

Waits for the specified duration in milliseconds.

pub fn click(&mut self, relative_x: u32, relative_y: u32) -> Result<(), Error>

Clicks the mouse button at the specified coordinates relative to the window.

pub fn mouse_down_on( &mut self, relative_x: u32, relative_y: u32 ) -> Result<(), Error>

Pushes down the mouse button at the specified coordinates relative to the window.

pub fn mouse_up_on( &mut self, relative_x: u32, relative_y: u32 ) -> Result<(), Error>

Releases the mouse button at the specified coordinates relative to the window.

pub fn activate_window(&mut self) -> Result<(), Error>

Clicks at the top of the bottom to activate the window.

pub fn find(&mut self, template: &Path) -> Result<Rect, Error>

Searches for a a specified image within the window and returns the Rect coordinates.

pub fn click_on_image( &mut self, template: &Path, time_out: u64 ) -> Result<(u32, u32), Error>

Searches for a specified image within the window and clicks at its center.

pub fn key_down(&mut self, key: Key) -> Result<(), Error>

Presses down the given key.

pub fn key_up(&mut self, key: Key) -> Result<(), Error>

Releases the given key.

pub fn key_click(&mut self, key: Key) -> Result<(), Error>

Presses and release the key.

pub fn key_sequence(&mut self, text: &str) -> Result<(), Error>

Types a string.

pub fn write(&mut self, text: &str) -> Result<(), Error>

Types a string (alias to key_sequence).

pub fn writeln(&mut self, text: &str) -> Result<(), Error>

Types a string followed by return.

Trait Implementations

impl Debug for Bot

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

Formats the value using the given formatter.