Struct Droid 

pub struct Droid { /* private fields */ }

The main entry point for interacting with an Android device.

The Droid struct holds the connection to a device and provides methods for performing actions like tapping, swiping, and image recognition.

Implementations

impl Droid

pub fn new(config: DroidConfig) -> Result<Self>

Creates a new Droid instance and connects to a device.

pub fn touch(&mut self, target: Target) -> TouchBuilder<'_>

Initiates a touch action on a target.

Returns a TouchBuilder to configure and execute the action.

Example

// Tap an image target twice.
droid.touch(target).times(2).execute()?;

pub fn swipe(&mut self, start: Target, end: Target) -> SwipeBuilder<'_>

Initiates a swipe action between two targets.

Returns a SwipeBuilder to configure and execute the action.

pub fn wait_for(&mut self, target: Target) -> WaitBuilder<'_>

Waits for a target to appear on the screen.

Returns a WaitBuilder to configure timeouts and execute the wait operation. The operation succeeds by returning the Point where the target was found.

pub fn text(&mut self, text: &str) -> TextBuilder<'_>

Initiates a text input action.

Returns a TextBuilder to execute the action.

pub fn sleep(&self, duration: Duration)

Pauses the script execution for a specified duration.

pub fn screenshot(&mut self) -> Result<DynamicImage>

Takes a screenshot of the current device screen and returns it as an image object.

This is the programmatic alternative to snapshot, which saves the image to a file.

Returns

A Result containing an image::DynamicImage on success.

pub fn snapshot<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Takes a screenshot of the current device screen and saves it to a file.

Arguments

• path - The path where the screenshot image will be saved.

pub fn keyevent(&mut self, key_code: KeyCode) -> KeyeventBuilder<'_>

Initiates a key event action (e.g., pressing Home or Back).

Returns a KeyeventBuilder to configure and execute the action.