Skip to main content

Resource

Struct Resource 

Source
pub struct Resource { /* private fields */ }

Implementations§

Source§

impl Resource

Source

pub fn register_custom_action( &self, name: &str, action: Box<dyn CustomAction>, ) -> MaaResult<()>

Register a custom action implementation.

The action will be kept alive as long as it is registered in the Resource. Re-registering with the same name will drop the previous implementation.

Examples found in repository?
examples/main.rs (line 334)
201fn main() -> Result<(), Box<dyn std::error::Error>> {
202    println!("=== MaaFramework Rust SDK Demo ===\n");
203
204    // -------------------------------------------------------------------------
205    // 1. Initialize Toolkit
206    // -------------------------------------------------------------------------
207    let user_path = "./";
208    Toolkit::init_option(user_path, "{}")?;
209    println!("[1] Toolkit initialized with user_path: {}", user_path);
210
211    // -------------------------------------------------------------------------
212    // 2. Device Discovery
213    // -------------------------------------------------------------------------
214
215    // ADB devices
216    println!("\n[2] Scanning for ADB devices...");
217    let adb_devices = Toolkit::find_adb_devices()?;
218    if adb_devices.is_empty() {
219        println!("    No ADB device found.");
220    } else {
221        for device in &adb_devices {
222            println!("    Found: {} ({})", device.name, device.address);
223        }
224    }
225
226    // Win32 windows (Windows only)
227    #[cfg(target_os = "windows")]
228    {
229        println!("\n    Scanning for desktop windows...");
230        match Toolkit::find_desktop_windows() {
231            Ok(windows) => {
232                if windows.is_empty() {
233                    println!("    No window found.");
234                } else {
235                    for (i, win) in windows.iter().take(3).enumerate() {
236                        println!("    [{}] hwnd={:?}, class={}", i, win.hwnd, win.class_name);
237                    }
238                    if windows.len() > 3 {
239                        println!("    ... and {} more", windows.len() - 3);
240                    }
241                }
242            }
243            Err(e) => println!("    Failed to find windows: {}", e),
244        }
245    }
246
247    // -------------------------------------------------------------------------
248    // 3. Create Controller (choose one)
249    // -------------------------------------------------------------------------
250    println!("\n[3] Creating controller...");
251
252    let controller: Option<Controller>;
253
254    // Option A: ADB Controller
255    #[cfg(feature = "adb")]
256    if let Some(device) = adb_devices.first() {
257        println!("    Using ADB device: {}", device.name);
258        let config_str = serde_json::to_string(&device.config)?;
259        controller = Some(Controller::new_adb(
260            device.adb_path.to_str().unwrap(),
261            &device.address,
262            &config_str,
263            None,
264        )?);
265    } else {
266        controller = None;
267    }
268
269    #[cfg(not(feature = "adb"))]
270    {
271        controller = None;
272    }
273
274    // Option B: Win32 Controller (uncomment to use)
275    // #[cfg(target_os = "windows")]
276    // if let Some(window) = windows.first() {
277    //     controller = Some(Controller::new_win32(
278    //         window.hwnd as isize,
279    //         common::Win32ScreencapMethod::FramePool as i32,
280    //         common::Win32InputMethod::PostMessage as i32,
281    //         common::Win32InputMethod::PostMessage as i32,
282    //     )?);
283    // }
284
285    // -------------------------------------------------------------------------
286    // 4. Controller Operations
287    // -------------------------------------------------------------------------
288    if let Some(ref ctrl) = controller {
289        println!("\n[4] Controller operations...");
290
291        // Connect
292        let conn_id = ctrl.post_connection()?;
293        ctrl.wait(conn_id);
294        println!("    Connected: {}", ctrl.connected());
295
296        // Screenshot
297        let cap_id = ctrl.post_screencap()?;
298        ctrl.wait(cap_id);
299        println!("    Screenshot captured");
300
301        // Click (sync)
302        let click_id = ctrl.post_click(114, 514)?;
303        ctrl.wait(click_id);
304        println!("    Clicked at (114, 514)");
305
306        // Click (async) - post now, wait later
307        let click_id2 = ctrl.post_click(514, 114)?;
308        // ... do other work here ...
309        ctrl.wait(click_id2);
310        println!("    Async click completed");
311
312        // Input text
313        let input_id = ctrl.post_input_text("Hello MAA!")?;
314        ctrl.wait(input_id);
315        println!("    Text input sent");
316
317        // Get resolution
318        if let Ok((w, h)) = ctrl.resolution() {
319            println!("    Resolution: {}x{}", w, h);
320        }
321    } else {
322        println!("\n[4] Skipping controller operations (no device available)");
323    }
324
325    // -------------------------------------------------------------------------
326    // 5. Resource Setup
327    // -------------------------------------------------------------------------
328    println!("\n[5] Setting up resource...");
329
330    let resource = Resource::new()?;
331
332    // Register custom recognition and action
333    resource.register_custom_recognition("MyRecognition", Box::new(MyRecognition))?;
334    resource.register_custom_action("MyAction", Box::new(MyAction))?;
335    println!("    Registered: MyRecognition, MyAction");
336
337    // List registered components
338    let reco_list = resource.custom_recognition_list()?;
339    let action_list = resource.custom_action_list()?;
340    println!("    Recognition list: {:?}", reco_list);
341    println!("    Action list: {:?}", action_list);
342
343    // Load resource bundle
344    let resource_path = "sample/resource";
345    println!("    Loading resource from: {}", resource_path);
346    match resource.post_bundle(resource_path) {
347        Ok(job) => {
348            let status = job.wait();
349            println!("    Load status: {:?}", status);
350        }
351        Err(e) => println!("    Load failed: {} (OK for demo)", e),
352    }
353
354    // Add event sink
355    resource.add_sink(|msg, details| {
356        println!(
357            "    [ResourceEvent] {}: {}",
358            msg,
359            &details[..details.len().min(50)]
360        );
361    })?;
362
363    // -------------------------------------------------------------------------
364    // 6. Tasker Setup and Execution
365    // -------------------------------------------------------------------------
366    println!("\n[6] Setting up tasker...");
367
368    let tasker = Tasker::new()?;
369
370    // Bind resource
371    tasker.bind_resource(&resource)?;
372    println!("    Resource bound");
373
374    // Bind controller (if available)
375    if let Some(ref ctrl) = controller {
376        tasker.bind_controller(ctrl)?;
377        println!("    Controller bound");
378    }
379
380    // Check initialization
381    if tasker.inited() {
382        println!("    Tasker initialized successfully!");
383
384        // Add event sink
385        tasker.add_sink(|msg, details| {
386            println!(
387                "    [TaskerEvent] {}: {}",
388                msg,
389                &details[..details.len().min(50)]
390            );
391        })?;
392
393        // Execute task with pipeline override
394        let pipeline_override = r#"{
395            "MyCustomEntry": {
396                "recognition": "Custom",
397                "custom_recognition": "MyRecognition",
398                "action": "Custom",
399                "custom_action": "MyAction"
400            }
401        }"#;
402
403        println!("\n[7] Executing task...");
404        match tasker.post_task("MyCustomEntry", pipeline_override) {
405            Ok(job) => {
406                let status = job.wait();
407                println!("    Task status: {:?}", status);
408
409                if let Ok(Some(detail)) = job.get(false) {
410                    println!("    Entry: {}", detail.entry);
411                    println!("    Nodes executed: {}", detail.nodes.len());
412
413                    for node_opt in detail.nodes {
414                        if let Some(node) = node_opt {
415                            if let Some(reco) = node.recognition {
416                                println!(
417                                    "      Node: {}, Algo: {:?}",
418                                    node.node_name, reco.algorithm
419                                );
420                            }
421                        }
422                    }
423                }
424            }
425            Err(e) => println!("    Task failed: {}", e),
426        }
427    } else {
428        println!("    Tasker not fully initialized (missing controller binding)");
429    }
430
431    // -------------------------------------------------------------------------
432    // 8. Cleanup
433    // -------------------------------------------------------------------------
434    println!("\n[8] Demo completed!");
435    println!("    - Toolkit, Controller, Resource, Tasker all demonstrated");
436    println!("    - Custom Recognition and Action registered and explained");
437    println!("    - Context API documented in custom component implementations");
438
439    Ok(())
440}
Source

pub fn register_custom_recognition( &self, name: &str, reco: Box<dyn CustomRecognition>, ) -> MaaResult<()>

Register a custom recognition implementation.

The recognizer will be kept alive as long as it is registered in the Resource. Re-registering with the same name will drop the previous implementation.

Examples found in repository?
examples/main.rs (line 333)
201fn main() -> Result<(), Box<dyn std::error::Error>> {
202    println!("=== MaaFramework Rust SDK Demo ===\n");
203
204    // -------------------------------------------------------------------------
205    // 1. Initialize Toolkit
206    // -------------------------------------------------------------------------
207    let user_path = "./";
208    Toolkit::init_option(user_path, "{}")?;
209    println!("[1] Toolkit initialized with user_path: {}", user_path);
210
211    // -------------------------------------------------------------------------
212    // 2. Device Discovery
213    // -------------------------------------------------------------------------
214
215    // ADB devices
216    println!("\n[2] Scanning for ADB devices...");
217    let adb_devices = Toolkit::find_adb_devices()?;
218    if adb_devices.is_empty() {
219        println!("    No ADB device found.");
220    } else {
221        for device in &adb_devices {
222            println!("    Found: {} ({})", device.name, device.address);
223        }
224    }
225
226    // Win32 windows (Windows only)
227    #[cfg(target_os = "windows")]
228    {
229        println!("\n    Scanning for desktop windows...");
230        match Toolkit::find_desktop_windows() {
231            Ok(windows) => {
232                if windows.is_empty() {
233                    println!("    No window found.");
234                } else {
235                    for (i, win) in windows.iter().take(3).enumerate() {
236                        println!("    [{}] hwnd={:?}, class={}", i, win.hwnd, win.class_name);
237                    }
238                    if windows.len() > 3 {
239                        println!("    ... and {} more", windows.len() - 3);
240                    }
241                }
242            }
243            Err(e) => println!("    Failed to find windows: {}", e),
244        }
245    }
246
247    // -------------------------------------------------------------------------
248    // 3. Create Controller (choose one)
249    // -------------------------------------------------------------------------
250    println!("\n[3] Creating controller...");
251
252    let controller: Option<Controller>;
253
254    // Option A: ADB Controller
255    #[cfg(feature = "adb")]
256    if let Some(device) = adb_devices.first() {
257        println!("    Using ADB device: {}", device.name);
258        let config_str = serde_json::to_string(&device.config)?;
259        controller = Some(Controller::new_adb(
260            device.adb_path.to_str().unwrap(),
261            &device.address,
262            &config_str,
263            None,
264        )?);
265    } else {
266        controller = None;
267    }
268
269    #[cfg(not(feature = "adb"))]
270    {
271        controller = None;
272    }
273
274    // Option B: Win32 Controller (uncomment to use)
275    // #[cfg(target_os = "windows")]
276    // if let Some(window) = windows.first() {
277    //     controller = Some(Controller::new_win32(
278    //         window.hwnd as isize,
279    //         common::Win32ScreencapMethod::FramePool as i32,
280    //         common::Win32InputMethod::PostMessage as i32,
281    //         common::Win32InputMethod::PostMessage as i32,
282    //     )?);
283    // }
284
285    // -------------------------------------------------------------------------
286    // 4. Controller Operations
287    // -------------------------------------------------------------------------
288    if let Some(ref ctrl) = controller {
289        println!("\n[4] Controller operations...");
290
291        // Connect
292        let conn_id = ctrl.post_connection()?;
293        ctrl.wait(conn_id);
294        println!("    Connected: {}", ctrl.connected());
295
296        // Screenshot
297        let cap_id = ctrl.post_screencap()?;
298        ctrl.wait(cap_id);
299        println!("    Screenshot captured");
300
301        // Click (sync)
302        let click_id = ctrl.post_click(114, 514)?;
303        ctrl.wait(click_id);
304        println!("    Clicked at (114, 514)");
305
306        // Click (async) - post now, wait later
307        let click_id2 = ctrl.post_click(514, 114)?;
308        // ... do other work here ...
309        ctrl.wait(click_id2);
310        println!("    Async click completed");
311
312        // Input text
313        let input_id = ctrl.post_input_text("Hello MAA!")?;
314        ctrl.wait(input_id);
315        println!("    Text input sent");
316
317        // Get resolution
318        if let Ok((w, h)) = ctrl.resolution() {
319            println!("    Resolution: {}x{}", w, h);
320        }
321    } else {
322        println!("\n[4] Skipping controller operations (no device available)");
323    }
324
325    // -------------------------------------------------------------------------
326    // 5. Resource Setup
327    // -------------------------------------------------------------------------
328    println!("\n[5] Setting up resource...");
329
330    let resource = Resource::new()?;
331
332    // Register custom recognition and action
333    resource.register_custom_recognition("MyRecognition", Box::new(MyRecognition))?;
334    resource.register_custom_action("MyAction", Box::new(MyAction))?;
335    println!("    Registered: MyRecognition, MyAction");
336
337    // List registered components
338    let reco_list = resource.custom_recognition_list()?;
339    let action_list = resource.custom_action_list()?;
340    println!("    Recognition list: {:?}", reco_list);
341    println!("    Action list: {:?}", action_list);
342
343    // Load resource bundle
344    let resource_path = "sample/resource";
345    println!("    Loading resource from: {}", resource_path);
346    match resource.post_bundle(resource_path) {
347        Ok(job) => {
348            let status = job.wait();
349            println!("    Load status: {:?}", status);
350        }
351        Err(e) => println!("    Load failed: {} (OK for demo)", e),
352    }
353
354    // Add event sink
355    resource.add_sink(|msg, details| {
356        println!(
357            "    [ResourceEvent] {}: {}",
358            msg,
359            &details[..details.len().min(50)]
360        );
361    })?;
362
363    // -------------------------------------------------------------------------
364    // 6. Tasker Setup and Execution
365    // -------------------------------------------------------------------------
366    println!("\n[6] Setting up tasker...");
367
368    let tasker = Tasker::new()?;
369
370    // Bind resource
371    tasker.bind_resource(&resource)?;
372    println!("    Resource bound");
373
374    // Bind controller (if available)
375    if let Some(ref ctrl) = controller {
376        tasker.bind_controller(ctrl)?;
377        println!("    Controller bound");
378    }
379
380    // Check initialization
381    if tasker.inited() {
382        println!("    Tasker initialized successfully!");
383
384        // Add event sink
385        tasker.add_sink(|msg, details| {
386            println!(
387                "    [TaskerEvent] {}: {}",
388                msg,
389                &details[..details.len().min(50)]
390            );
391        })?;
392
393        // Execute task with pipeline override
394        let pipeline_override = r#"{
395            "MyCustomEntry": {
396                "recognition": "Custom",
397                "custom_recognition": "MyRecognition",
398                "action": "Custom",
399                "custom_action": "MyAction"
400            }
401        }"#;
402
403        println!("\n[7] Executing task...");
404        match tasker.post_task("MyCustomEntry", pipeline_override) {
405            Ok(job) => {
406                let status = job.wait();
407                println!("    Task status: {:?}", status);
408
409                if let Ok(Some(detail)) = job.get(false) {
410                    println!("    Entry: {}", detail.entry);
411                    println!("    Nodes executed: {}", detail.nodes.len());
412
413                    for node_opt in detail.nodes {
414                        if let Some(node) = node_opt {
415                            if let Some(reco) = node.recognition {
416                                println!(
417                                    "      Node: {}, Algo: {:?}",
418                                    node.node_name, reco.algorithm
419                                );
420                            }
421                        }
422                    }
423                }
424            }
425            Err(e) => println!("    Task failed: {}", e),
426        }
427    } else {
428        println!("    Tasker not fully initialized (missing controller binding)");
429    }
430
431    // -------------------------------------------------------------------------
432    // 8. Cleanup
433    // -------------------------------------------------------------------------
434    println!("\n[8] Demo completed!");
435    println!("    - Toolkit, Controller, Resource, Tasker all demonstrated");
436    println!("    - Custom Recognition and Action registered and explained");
437    println!("    - Context API documented in custom component implementations");
438
439    Ok(())
440}
Source§

impl Resource

Source

pub fn new() -> MaaResult<Self>

Create a new resource manager.

Examples found in repository?
examples/main.rs (line 330)
201fn main() -> Result<(), Box<dyn std::error::Error>> {
202    println!("=== MaaFramework Rust SDK Demo ===\n");
203
204    // -------------------------------------------------------------------------
205    // 1. Initialize Toolkit
206    // -------------------------------------------------------------------------
207    let user_path = "./";
208    Toolkit::init_option(user_path, "{}")?;
209    println!("[1] Toolkit initialized with user_path: {}", user_path);
210
211    // -------------------------------------------------------------------------
212    // 2. Device Discovery
213    // -------------------------------------------------------------------------
214
215    // ADB devices
216    println!("\n[2] Scanning for ADB devices...");
217    let adb_devices = Toolkit::find_adb_devices()?;
218    if adb_devices.is_empty() {
219        println!("    No ADB device found.");
220    } else {
221        for device in &adb_devices {
222            println!("    Found: {} ({})", device.name, device.address);
223        }
224    }
225
226    // Win32 windows (Windows only)
227    #[cfg(target_os = "windows")]
228    {
229        println!("\n    Scanning for desktop windows...");
230        match Toolkit::find_desktop_windows() {
231            Ok(windows) => {
232                if windows.is_empty() {
233                    println!("    No window found.");
234                } else {
235                    for (i, win) in windows.iter().take(3).enumerate() {
236                        println!("    [{}] hwnd={:?}, class={}", i, win.hwnd, win.class_name);
237                    }
238                    if windows.len() > 3 {
239                        println!("    ... and {} more", windows.len() - 3);
240                    }
241                }
242            }
243            Err(e) => println!("    Failed to find windows: {}", e),
244        }
245    }
246
247    // -------------------------------------------------------------------------
248    // 3. Create Controller (choose one)
249    // -------------------------------------------------------------------------
250    println!("\n[3] Creating controller...");
251
252    let controller: Option<Controller>;
253
254    // Option A: ADB Controller
255    #[cfg(feature = "adb")]
256    if let Some(device) = adb_devices.first() {
257        println!("    Using ADB device: {}", device.name);
258        let config_str = serde_json::to_string(&device.config)?;
259        controller = Some(Controller::new_adb(
260            device.adb_path.to_str().unwrap(),
261            &device.address,
262            &config_str,
263            None,
264        )?);
265    } else {
266        controller = None;
267    }
268
269    #[cfg(not(feature = "adb"))]
270    {
271        controller = None;
272    }
273
274    // Option B: Win32 Controller (uncomment to use)
275    // #[cfg(target_os = "windows")]
276    // if let Some(window) = windows.first() {
277    //     controller = Some(Controller::new_win32(
278    //         window.hwnd as isize,
279    //         common::Win32ScreencapMethod::FramePool as i32,
280    //         common::Win32InputMethod::PostMessage as i32,
281    //         common::Win32InputMethod::PostMessage as i32,
282    //     )?);
283    // }
284
285    // -------------------------------------------------------------------------
286    // 4. Controller Operations
287    // -------------------------------------------------------------------------
288    if let Some(ref ctrl) = controller {
289        println!("\n[4] Controller operations...");
290
291        // Connect
292        let conn_id = ctrl.post_connection()?;
293        ctrl.wait(conn_id);
294        println!("    Connected: {}", ctrl.connected());
295
296        // Screenshot
297        let cap_id = ctrl.post_screencap()?;
298        ctrl.wait(cap_id);
299        println!("    Screenshot captured");
300
301        // Click (sync)
302        let click_id = ctrl.post_click(114, 514)?;
303        ctrl.wait(click_id);
304        println!("    Clicked at (114, 514)");
305
306        // Click (async) - post now, wait later
307        let click_id2 = ctrl.post_click(514, 114)?;
308        // ... do other work here ...
309        ctrl.wait(click_id2);
310        println!("    Async click completed");
311
312        // Input text
313        let input_id = ctrl.post_input_text("Hello MAA!")?;
314        ctrl.wait(input_id);
315        println!("    Text input sent");
316
317        // Get resolution
318        if let Ok((w, h)) = ctrl.resolution() {
319            println!("    Resolution: {}x{}", w, h);
320        }
321    } else {
322        println!("\n[4] Skipping controller operations (no device available)");
323    }
324
325    // -------------------------------------------------------------------------
326    // 5. Resource Setup
327    // -------------------------------------------------------------------------
328    println!("\n[5] Setting up resource...");
329
330    let resource = Resource::new()?;
331
332    // Register custom recognition and action
333    resource.register_custom_recognition("MyRecognition", Box::new(MyRecognition))?;
334    resource.register_custom_action("MyAction", Box::new(MyAction))?;
335    println!("    Registered: MyRecognition, MyAction");
336
337    // List registered components
338    let reco_list = resource.custom_recognition_list()?;
339    let action_list = resource.custom_action_list()?;
340    println!("    Recognition list: {:?}", reco_list);
341    println!("    Action list: {:?}", action_list);
342
343    // Load resource bundle
344    let resource_path = "sample/resource";
345    println!("    Loading resource from: {}", resource_path);
346    match resource.post_bundle(resource_path) {
347        Ok(job) => {
348            let status = job.wait();
349            println!("    Load status: {:?}", status);
350        }
351        Err(e) => println!("    Load failed: {} (OK for demo)", e),
352    }
353
354    // Add event sink
355    resource.add_sink(|msg, details| {
356        println!(
357            "    [ResourceEvent] {}: {}",
358            msg,
359            &details[..details.len().min(50)]
360        );
361    })?;
362
363    // -------------------------------------------------------------------------
364    // 6. Tasker Setup and Execution
365    // -------------------------------------------------------------------------
366    println!("\n[6] Setting up tasker...");
367
368    let tasker = Tasker::new()?;
369
370    // Bind resource
371    tasker.bind_resource(&resource)?;
372    println!("    Resource bound");
373
374    // Bind controller (if available)
375    if let Some(ref ctrl) = controller {
376        tasker.bind_controller(ctrl)?;
377        println!("    Controller bound");
378    }
379
380    // Check initialization
381    if tasker.inited() {
382        println!("    Tasker initialized successfully!");
383
384        // Add event sink
385        tasker.add_sink(|msg, details| {
386            println!(
387                "    [TaskerEvent] {}: {}",
388                msg,
389                &details[..details.len().min(50)]
390            );
391        })?;
392
393        // Execute task with pipeline override
394        let pipeline_override = r#"{
395            "MyCustomEntry": {
396                "recognition": "Custom",
397                "custom_recognition": "MyRecognition",
398                "action": "Custom",
399                "custom_action": "MyAction"
400            }
401        }"#;
402
403        println!("\n[7] Executing task...");
404        match tasker.post_task("MyCustomEntry", pipeline_override) {
405            Ok(job) => {
406                let status = job.wait();
407                println!("    Task status: {:?}", status);
408
409                if let Ok(Some(detail)) = job.get(false) {
410                    println!("    Entry: {}", detail.entry);
411                    println!("    Nodes executed: {}", detail.nodes.len());
412
413                    for node_opt in detail.nodes {
414                        if let Some(node) = node_opt {
415                            if let Some(reco) = node.recognition {
416                                println!(
417                                    "      Node: {}, Algo: {:?}",
418                                    node.node_name, reco.algorithm
419                                );
420                            }
421                        }
422                    }
423                }
424            }
425            Err(e) => println!("    Task failed: {}", e),
426        }
427    } else {
428        println!("    Tasker not fully initialized (missing controller binding)");
429    }
430
431    // -------------------------------------------------------------------------
432    // 8. Cleanup
433    // -------------------------------------------------------------------------
434    println!("\n[8] Demo completed!");
435    println!("    - Toolkit, Controller, Resource, Tasker all demonstrated");
436    println!("    - Custom Recognition and Action registered and explained");
437    println!("    - Context API documented in custom component implementations");
438
439    Ok(())
440}
Source

pub unsafe fn from_raw(ptr: *mut MaaResource) -> MaaResult<Self>

Create a Resource from a raw pointer, taking ownership.

§Safety

The pointer must be valid and the caller transfers ownership to the Resource. The Resource will call MaaResourceDestroy when dropped.

Source

pub fn post_bundle(&self, path: &str) -> MaaResult<ResJob>

Load a resource bundle from the specified directory.

The bundle should contain pipeline definitions, images, and models.

Examples found in repository?
examples/main.rs (line 346)
201fn main() -> Result<(), Box<dyn std::error::Error>> {
202    println!("=== MaaFramework Rust SDK Demo ===\n");
203
204    // -------------------------------------------------------------------------
205    // 1. Initialize Toolkit
206    // -------------------------------------------------------------------------
207    let user_path = "./";
208    Toolkit::init_option(user_path, "{}")?;
209    println!("[1] Toolkit initialized with user_path: {}", user_path);
210
211    // -------------------------------------------------------------------------
212    // 2. Device Discovery
213    // -------------------------------------------------------------------------
214
215    // ADB devices
216    println!("\n[2] Scanning for ADB devices...");
217    let adb_devices = Toolkit::find_adb_devices()?;
218    if adb_devices.is_empty() {
219        println!("    No ADB device found.");
220    } else {
221        for device in &adb_devices {
222            println!("    Found: {} ({})", device.name, device.address);
223        }
224    }
225
226    // Win32 windows (Windows only)
227    #[cfg(target_os = "windows")]
228    {
229        println!("\n    Scanning for desktop windows...");
230        match Toolkit::find_desktop_windows() {
231            Ok(windows) => {
232                if windows.is_empty() {
233                    println!("    No window found.");
234                } else {
235                    for (i, win) in windows.iter().take(3).enumerate() {
236                        println!("    [{}] hwnd={:?}, class={}", i, win.hwnd, win.class_name);
237                    }
238                    if windows.len() > 3 {
239                        println!("    ... and {} more", windows.len() - 3);
240                    }
241                }
242            }
243            Err(e) => println!("    Failed to find windows: {}", e),
244        }
245    }
246
247    // -------------------------------------------------------------------------
248    // 3. Create Controller (choose one)
249    // -------------------------------------------------------------------------
250    println!("\n[3] Creating controller...");
251
252    let controller: Option<Controller>;
253
254    // Option A: ADB Controller
255    #[cfg(feature = "adb")]
256    if let Some(device) = adb_devices.first() {
257        println!("    Using ADB device: {}", device.name);
258        let config_str = serde_json::to_string(&device.config)?;
259        controller = Some(Controller::new_adb(
260            device.adb_path.to_str().unwrap(),
261            &device.address,
262            &config_str,
263            None,
264        )?);
265    } else {
266        controller = None;
267    }
268
269    #[cfg(not(feature = "adb"))]
270    {
271        controller = None;
272    }
273
274    // Option B: Win32 Controller (uncomment to use)
275    // #[cfg(target_os = "windows")]
276    // if let Some(window) = windows.first() {
277    //     controller = Some(Controller::new_win32(
278    //         window.hwnd as isize,
279    //         common::Win32ScreencapMethod::FramePool as i32,
280    //         common::Win32InputMethod::PostMessage as i32,
281    //         common::Win32InputMethod::PostMessage as i32,
282    //     )?);
283    // }
284
285    // -------------------------------------------------------------------------
286    // 4. Controller Operations
287    // -------------------------------------------------------------------------
288    if let Some(ref ctrl) = controller {
289        println!("\n[4] Controller operations...");
290
291        // Connect
292        let conn_id = ctrl.post_connection()?;
293        ctrl.wait(conn_id);
294        println!("    Connected: {}", ctrl.connected());
295
296        // Screenshot
297        let cap_id = ctrl.post_screencap()?;
298        ctrl.wait(cap_id);
299        println!("    Screenshot captured");
300
301        // Click (sync)
302        let click_id = ctrl.post_click(114, 514)?;
303        ctrl.wait(click_id);
304        println!("    Clicked at (114, 514)");
305
306        // Click (async) - post now, wait later
307        let click_id2 = ctrl.post_click(514, 114)?;
308        // ... do other work here ...
309        ctrl.wait(click_id2);
310        println!("    Async click completed");
311
312        // Input text
313        let input_id = ctrl.post_input_text("Hello MAA!")?;
314        ctrl.wait(input_id);
315        println!("    Text input sent");
316
317        // Get resolution
318        if let Ok((w, h)) = ctrl.resolution() {
319            println!("    Resolution: {}x{}", w, h);
320        }
321    } else {
322        println!("\n[4] Skipping controller operations (no device available)");
323    }
324
325    // -------------------------------------------------------------------------
326    // 5. Resource Setup
327    // -------------------------------------------------------------------------
328    println!("\n[5] Setting up resource...");
329
330    let resource = Resource::new()?;
331
332    // Register custom recognition and action
333    resource.register_custom_recognition("MyRecognition", Box::new(MyRecognition))?;
334    resource.register_custom_action("MyAction", Box::new(MyAction))?;
335    println!("    Registered: MyRecognition, MyAction");
336
337    // List registered components
338    let reco_list = resource.custom_recognition_list()?;
339    let action_list = resource.custom_action_list()?;
340    println!("    Recognition list: {:?}", reco_list);
341    println!("    Action list: {:?}", action_list);
342
343    // Load resource bundle
344    let resource_path = "sample/resource";
345    println!("    Loading resource from: {}", resource_path);
346    match resource.post_bundle(resource_path) {
347        Ok(job) => {
348            let status = job.wait();
349            println!("    Load status: {:?}", status);
350        }
351        Err(e) => println!("    Load failed: {} (OK for demo)", e),
352    }
353
354    // Add event sink
355    resource.add_sink(|msg, details| {
356        println!(
357            "    [ResourceEvent] {}: {}",
358            msg,
359            &details[..details.len().min(50)]
360        );
361    })?;
362
363    // -------------------------------------------------------------------------
364    // 6. Tasker Setup and Execution
365    // -------------------------------------------------------------------------
366    println!("\n[6] Setting up tasker...");
367
368    let tasker = Tasker::new()?;
369
370    // Bind resource
371    tasker.bind_resource(&resource)?;
372    println!("    Resource bound");
373
374    // Bind controller (if available)
375    if let Some(ref ctrl) = controller {
376        tasker.bind_controller(ctrl)?;
377        println!("    Controller bound");
378    }
379
380    // Check initialization
381    if tasker.inited() {
382        println!("    Tasker initialized successfully!");
383
384        // Add event sink
385        tasker.add_sink(|msg, details| {
386            println!(
387                "    [TaskerEvent] {}: {}",
388                msg,
389                &details[..details.len().min(50)]
390            );
391        })?;
392
393        // Execute task with pipeline override
394        let pipeline_override = r#"{
395            "MyCustomEntry": {
396                "recognition": "Custom",
397                "custom_recognition": "MyRecognition",
398                "action": "Custom",
399                "custom_action": "MyAction"
400            }
401        }"#;
402
403        println!("\n[7] Executing task...");
404        match tasker.post_task("MyCustomEntry", pipeline_override) {
405            Ok(job) => {
406                let status = job.wait();
407                println!("    Task status: {:?}", status);
408
409                if let Ok(Some(detail)) = job.get(false) {
410                    println!("    Entry: {}", detail.entry);
411                    println!("    Nodes executed: {}", detail.nodes.len());
412
413                    for node_opt in detail.nodes {
414                        if let Some(node) = node_opt {
415                            if let Some(reco) = node.recognition {
416                                println!(
417                                    "      Node: {}, Algo: {:?}",
418                                    node.node_name, reco.algorithm
419                                );
420                            }
421                        }
422                    }
423                }
424            }
425            Err(e) => println!("    Task failed: {}", e),
426        }
427    } else {
428        println!("    Tasker not fully initialized (missing controller binding)");
429    }
430
431    // -------------------------------------------------------------------------
432    // 8. Cleanup
433    // -------------------------------------------------------------------------
434    println!("\n[8] Demo completed!");
435    println!("    - Toolkit, Controller, Resource, Tasker all demonstrated");
436    println!("    - Custom Recognition and Action registered and explained");
437    println!("    - Context API documented in custom component implementations");
438
439    Ok(())
440}
Source

pub fn loaded(&self) -> bool

Check if resources have been loaded.

Source

pub fn clear(&self) -> MaaResult<()>

Clear all loaded resources.

Source

pub fn status(&self, id: MaaId) -> MaaStatus

Get the status of a loading operation.

Source

pub fn wait(&self, id: MaaId) -> MaaStatus

Wait for a loading operation to complete.

Source

pub fn raw(&self) -> *mut MaaResource

Get the raw resource handle.

Source

pub fn post_ocr_model(&self, path: &str) -> MaaResult<ResJob>

Load an OCR model from the specified directory.

Source

pub fn post_pipeline(&self, path: &str) -> MaaResult<ResJob>

Load additional pipeline definitions from the specified directory.

Source

pub fn post_image(&self, path: &str) -> MaaResult<ResJob>

Load image resources from the specified directory.

Source

pub fn override_pipeline(&self, pipeline_override: &str) -> MaaResult<()>

Override pipeline parameters with a JSON string.

Source

pub fn override_pipeline_json(&self, pipeline_override: &Value) -> MaaResult<()>

Override pipeline with JSON value.

Convenience method that accepts serde_json::Value for pipeline overrides.

§Example
use serde_json::json;
resource.override_pipeline_json(&json!({
    "MyNode": { "enabled": false }
}))?;
Source

pub fn override_next( &self, node_name: &str, next_list: &[&str], ) -> MaaResult<()>

Override the next node list for a specific node.

§Arguments
  • node_name - The name of the node to modify
  • next_list - The new list of next nodes
Source

pub fn get_node_data(&self, node_name: &str) -> MaaResult<Option<String>>

Get node data as a JSON string.

Source

pub fn get_node_object( &self, node_name: &str, ) -> MaaResult<Option<PipelineData>>

Get node data as a deserialized PipelineData object.

Source

pub fn node_list(&self) -> MaaResult<Vec<String>>

Get a list of all node names in the loaded pipelines.

Source

pub fn hash(&self) -> MaaResult<String>

Get a hash of the loaded resources for cache validation.

Source

pub fn get_default_recognition_param( &self, reco_type: &str, ) -> MaaResult<Option<Value>>

Get valid default parameters for a recognition type as JSON.

§Arguments
  • reco_type - The recognition type (e.g. “TemplateMatch”, “OCR”).
Source

pub fn get_default_action_param( &self, action_type: &str, ) -> MaaResult<Option<Value>>

Get valid default parameters for an action type as JSON.

§Arguments
  • action_type - The action type (e.g. “Click”, “Swipe”).
Source

pub fn use_cpu(&self) -> MaaResult<()>

Use CPU for inference (default).

Source

pub fn use_directml(&self, device_id: i32) -> MaaResult<()>

Use DirectML for GPU-accelerated inference (Windows only).

§Arguments
  • device_id - GPU device index (0 for first GPU)
Source

pub fn add_sink<F>(&self, callback: F) -> MaaResult<MaaSinkId>
where F: Fn(&str, &str) + Send + Sync + 'static,

Register a raw callback to receive events.

The callback receives event type and details as JSON strings.

Examples found in repository?
examples/main.rs (lines 355-361)
201fn main() -> Result<(), Box<dyn std::error::Error>> {
202    println!("=== MaaFramework Rust SDK Demo ===\n");
203
204    // -------------------------------------------------------------------------
205    // 1. Initialize Toolkit
206    // -------------------------------------------------------------------------
207    let user_path = "./";
208    Toolkit::init_option(user_path, "{}")?;
209    println!("[1] Toolkit initialized with user_path: {}", user_path);
210
211    // -------------------------------------------------------------------------
212    // 2. Device Discovery
213    // -------------------------------------------------------------------------
214
215    // ADB devices
216    println!("\n[2] Scanning for ADB devices...");
217    let adb_devices = Toolkit::find_adb_devices()?;
218    if adb_devices.is_empty() {
219        println!("    No ADB device found.");
220    } else {
221        for device in &adb_devices {
222            println!("    Found: {} ({})", device.name, device.address);
223        }
224    }
225
226    // Win32 windows (Windows only)
227    #[cfg(target_os = "windows")]
228    {
229        println!("\n    Scanning for desktop windows...");
230        match Toolkit::find_desktop_windows() {
231            Ok(windows) => {
232                if windows.is_empty() {
233                    println!("    No window found.");
234                } else {
235                    for (i, win) in windows.iter().take(3).enumerate() {
236                        println!("    [{}] hwnd={:?}, class={}", i, win.hwnd, win.class_name);
237                    }
238                    if windows.len() > 3 {
239                        println!("    ... and {} more", windows.len() - 3);
240                    }
241                }
242            }
243            Err(e) => println!("    Failed to find windows: {}", e),
244        }
245    }
246
247    // -------------------------------------------------------------------------
248    // 3. Create Controller (choose one)
249    // -------------------------------------------------------------------------
250    println!("\n[3] Creating controller...");
251
252    let controller: Option<Controller>;
253
254    // Option A: ADB Controller
255    #[cfg(feature = "adb")]
256    if let Some(device) = adb_devices.first() {
257        println!("    Using ADB device: {}", device.name);
258        let config_str = serde_json::to_string(&device.config)?;
259        controller = Some(Controller::new_adb(
260            device.adb_path.to_str().unwrap(),
261            &device.address,
262            &config_str,
263            None,
264        )?);
265    } else {
266        controller = None;
267    }
268
269    #[cfg(not(feature = "adb"))]
270    {
271        controller = None;
272    }
273
274    // Option B: Win32 Controller (uncomment to use)
275    // #[cfg(target_os = "windows")]
276    // if let Some(window) = windows.first() {
277    //     controller = Some(Controller::new_win32(
278    //         window.hwnd as isize,
279    //         common::Win32ScreencapMethod::FramePool as i32,
280    //         common::Win32InputMethod::PostMessage as i32,
281    //         common::Win32InputMethod::PostMessage as i32,
282    //     )?);
283    // }
284
285    // -------------------------------------------------------------------------
286    // 4. Controller Operations
287    // -------------------------------------------------------------------------
288    if let Some(ref ctrl) = controller {
289        println!("\n[4] Controller operations...");
290
291        // Connect
292        let conn_id = ctrl.post_connection()?;
293        ctrl.wait(conn_id);
294        println!("    Connected: {}", ctrl.connected());
295
296        // Screenshot
297        let cap_id = ctrl.post_screencap()?;
298        ctrl.wait(cap_id);
299        println!("    Screenshot captured");
300
301        // Click (sync)
302        let click_id = ctrl.post_click(114, 514)?;
303        ctrl.wait(click_id);
304        println!("    Clicked at (114, 514)");
305
306        // Click (async) - post now, wait later
307        let click_id2 = ctrl.post_click(514, 114)?;
308        // ... do other work here ...
309        ctrl.wait(click_id2);
310        println!("    Async click completed");
311
312        // Input text
313        let input_id = ctrl.post_input_text("Hello MAA!")?;
314        ctrl.wait(input_id);
315        println!("    Text input sent");
316
317        // Get resolution
318        if let Ok((w, h)) = ctrl.resolution() {
319            println!("    Resolution: {}x{}", w, h);
320        }
321    } else {
322        println!("\n[4] Skipping controller operations (no device available)");
323    }
324
325    // -------------------------------------------------------------------------
326    // 5. Resource Setup
327    // -------------------------------------------------------------------------
328    println!("\n[5] Setting up resource...");
329
330    let resource = Resource::new()?;
331
332    // Register custom recognition and action
333    resource.register_custom_recognition("MyRecognition", Box::new(MyRecognition))?;
334    resource.register_custom_action("MyAction", Box::new(MyAction))?;
335    println!("    Registered: MyRecognition, MyAction");
336
337    // List registered components
338    let reco_list = resource.custom_recognition_list()?;
339    let action_list = resource.custom_action_list()?;
340    println!("    Recognition list: {:?}", reco_list);
341    println!("    Action list: {:?}", action_list);
342
343    // Load resource bundle
344    let resource_path = "sample/resource";
345    println!("    Loading resource from: {}", resource_path);
346    match resource.post_bundle(resource_path) {
347        Ok(job) => {
348            let status = job.wait();
349            println!("    Load status: {:?}", status);
350        }
351        Err(e) => println!("    Load failed: {} (OK for demo)", e),
352    }
353
354    // Add event sink
355    resource.add_sink(|msg, details| {
356        println!(
357            "    [ResourceEvent] {}: {}",
358            msg,
359            &details[..details.len().min(50)]
360        );
361    })?;
362
363    // -------------------------------------------------------------------------
364    // 6. Tasker Setup and Execution
365    // -------------------------------------------------------------------------
366    println!("\n[6] Setting up tasker...");
367
368    let tasker = Tasker::new()?;
369
370    // Bind resource
371    tasker.bind_resource(&resource)?;
372    println!("    Resource bound");
373
374    // Bind controller (if available)
375    if let Some(ref ctrl) = controller {
376        tasker.bind_controller(ctrl)?;
377        println!("    Controller bound");
378    }
379
380    // Check initialization
381    if tasker.inited() {
382        println!("    Tasker initialized successfully!");
383
384        // Add event sink
385        tasker.add_sink(|msg, details| {
386            println!(
387                "    [TaskerEvent] {}: {}",
388                msg,
389                &details[..details.len().min(50)]
390            );
391        })?;
392
393        // Execute task with pipeline override
394        let pipeline_override = r#"{
395            "MyCustomEntry": {
396                "recognition": "Custom",
397                "custom_recognition": "MyRecognition",
398                "action": "Custom",
399                "custom_action": "MyAction"
400            }
401        }"#;
402
403        println!("\n[7] Executing task...");
404        match tasker.post_task("MyCustomEntry", pipeline_override) {
405            Ok(job) => {
406                let status = job.wait();
407                println!("    Task status: {:?}", status);
408
409                if let Ok(Some(detail)) = job.get(false) {
410                    println!("    Entry: {}", detail.entry);
411                    println!("    Nodes executed: {}", detail.nodes.len());
412
413                    for node_opt in detail.nodes {
414                        if let Some(node) = node_opt {
415                            if let Some(reco) = node.recognition {
416                                println!(
417                                    "      Node: {}, Algo: {:?}",
418                                    node.node_name, reco.algorithm
419                                );
420                            }
421                        }
422                    }
423                }
424            }
425            Err(e) => println!("    Task failed: {}", e),
426        }
427    } else {
428        println!("    Tasker not fully initialized (missing controller binding)");
429    }
430
431    // -------------------------------------------------------------------------
432    // 8. Cleanup
433    // -------------------------------------------------------------------------
434    println!("\n[8] Demo completed!");
435    println!("    - Toolkit, Controller, Resource, Tasker all demonstrated");
436    println!("    - Custom Recognition and Action registered and explained");
437    println!("    - Context API documented in custom component implementations");
438
439    Ok(())
440}
Source

pub fn add_event_sink(&self, sink: Box<dyn EventSink>) -> MaaResult<MaaSinkId>

Register a strongly-typed event sink.

This method registers an implementation of the EventSink trait to receive structured notifications from this resource.

§Arguments
  • sink - The event sink implementation (must be boxed).
§Returns

A MaaSinkId which can be used to manually remove the sink later via remove_sink. The sink will be automatically unregistered and dropped when the Resource is dropped.

Source

pub fn remove_sink(&self, sink_id: MaaSinkId)

Remove a previously registered event sink.

Source

pub fn clear_sinks(&self)

Remove all registered event sinks.

Source

pub fn override_image( &self, image_name: &str, image: &MaaImageBuffer, ) -> MaaResult<()>

Override an image resource at runtime.

§Arguments
  • image_name - The name of the image to override
  • image - The new image buffer to use
Source

pub fn use_auto_ep(&self) -> MaaResult<()>

Auto-select the best inference execution provider.

Source

pub fn use_coreml(&self, coreml_flag: i32) -> MaaResult<()>

Use CoreML for inference (macOS only).

§Arguments
  • coreml_flag - CoreML configuration flag
Source

pub fn use_cuda(&self, nvidia_gpu_id: i32) -> MaaResult<()>

Use CUDA for inference (NVIDIA GPU only).

§Arguments
  • nvidia_gpu_id - NVIDIA GPU device ID (typically 0 for first GPU)
Source

pub fn unregister_custom_recognition(&self, name: &str) -> MaaResult<()>

Unregister a custom recognition by name.

Source

pub fn unregister_custom_action(&self, name: &str) -> MaaResult<()>

Unregister a custom action by name.

Source

pub fn custom_recognition_list(&self) -> MaaResult<Vec<String>>

Get the list of registered custom recognitions.

Examples found in repository?
examples/main.rs (line 338)
201fn main() -> Result<(), Box<dyn std::error::Error>> {
202    println!("=== MaaFramework Rust SDK Demo ===\n");
203
204    // -------------------------------------------------------------------------
205    // 1. Initialize Toolkit
206    // -------------------------------------------------------------------------
207    let user_path = "./";
208    Toolkit::init_option(user_path, "{}")?;
209    println!("[1] Toolkit initialized with user_path: {}", user_path);
210
211    // -------------------------------------------------------------------------
212    // 2. Device Discovery
213    // -------------------------------------------------------------------------
214
215    // ADB devices
216    println!("\n[2] Scanning for ADB devices...");
217    let adb_devices = Toolkit::find_adb_devices()?;
218    if adb_devices.is_empty() {
219        println!("    No ADB device found.");
220    } else {
221        for device in &adb_devices {
222            println!("    Found: {} ({})", device.name, device.address);
223        }
224    }
225
226    // Win32 windows (Windows only)
227    #[cfg(target_os = "windows")]
228    {
229        println!("\n    Scanning for desktop windows...");
230        match Toolkit::find_desktop_windows() {
231            Ok(windows) => {
232                if windows.is_empty() {
233                    println!("    No window found.");
234                } else {
235                    for (i, win) in windows.iter().take(3).enumerate() {
236                        println!("    [{}] hwnd={:?}, class={}", i, win.hwnd, win.class_name);
237                    }
238                    if windows.len() > 3 {
239                        println!("    ... and {} more", windows.len() - 3);
240                    }
241                }
242            }
243            Err(e) => println!("    Failed to find windows: {}", e),
244        }
245    }
246
247    // -------------------------------------------------------------------------
248    // 3. Create Controller (choose one)
249    // -------------------------------------------------------------------------
250    println!("\n[3] Creating controller...");
251
252    let controller: Option<Controller>;
253
254    // Option A: ADB Controller
255    #[cfg(feature = "adb")]
256    if let Some(device) = adb_devices.first() {
257        println!("    Using ADB device: {}", device.name);
258        let config_str = serde_json::to_string(&device.config)?;
259        controller = Some(Controller::new_adb(
260            device.adb_path.to_str().unwrap(),
261            &device.address,
262            &config_str,
263            None,
264        )?);
265    } else {
266        controller = None;
267    }
268
269    #[cfg(not(feature = "adb"))]
270    {
271        controller = None;
272    }
273
274    // Option B: Win32 Controller (uncomment to use)
275    // #[cfg(target_os = "windows")]
276    // if let Some(window) = windows.first() {
277    //     controller = Some(Controller::new_win32(
278    //         window.hwnd as isize,
279    //         common::Win32ScreencapMethod::FramePool as i32,
280    //         common::Win32InputMethod::PostMessage as i32,
281    //         common::Win32InputMethod::PostMessage as i32,
282    //     )?);
283    // }
284
285    // -------------------------------------------------------------------------
286    // 4. Controller Operations
287    // -------------------------------------------------------------------------
288    if let Some(ref ctrl) = controller {
289        println!("\n[4] Controller operations...");
290
291        // Connect
292        let conn_id = ctrl.post_connection()?;
293        ctrl.wait(conn_id);
294        println!("    Connected: {}", ctrl.connected());
295
296        // Screenshot
297        let cap_id = ctrl.post_screencap()?;
298        ctrl.wait(cap_id);
299        println!("    Screenshot captured");
300
301        // Click (sync)
302        let click_id = ctrl.post_click(114, 514)?;
303        ctrl.wait(click_id);
304        println!("    Clicked at (114, 514)");
305
306        // Click (async) - post now, wait later
307        let click_id2 = ctrl.post_click(514, 114)?;
308        // ... do other work here ...
309        ctrl.wait(click_id2);
310        println!("    Async click completed");
311
312        // Input text
313        let input_id = ctrl.post_input_text("Hello MAA!")?;
314        ctrl.wait(input_id);
315        println!("    Text input sent");
316
317        // Get resolution
318        if let Ok((w, h)) = ctrl.resolution() {
319            println!("    Resolution: {}x{}", w, h);
320        }
321    } else {
322        println!("\n[4] Skipping controller operations (no device available)");
323    }
324
325    // -------------------------------------------------------------------------
326    // 5. Resource Setup
327    // -------------------------------------------------------------------------
328    println!("\n[5] Setting up resource...");
329
330    let resource = Resource::new()?;
331
332    // Register custom recognition and action
333    resource.register_custom_recognition("MyRecognition", Box::new(MyRecognition))?;
334    resource.register_custom_action("MyAction", Box::new(MyAction))?;
335    println!("    Registered: MyRecognition, MyAction");
336
337    // List registered components
338    let reco_list = resource.custom_recognition_list()?;
339    let action_list = resource.custom_action_list()?;
340    println!("    Recognition list: {:?}", reco_list);
341    println!("    Action list: {:?}", action_list);
342
343    // Load resource bundle
344    let resource_path = "sample/resource";
345    println!("    Loading resource from: {}", resource_path);
346    match resource.post_bundle(resource_path) {
347        Ok(job) => {
348            let status = job.wait();
349            println!("    Load status: {:?}", status);
350        }
351        Err(e) => println!("    Load failed: {} (OK for demo)", e),
352    }
353
354    // Add event sink
355    resource.add_sink(|msg, details| {
356        println!(
357            "    [ResourceEvent] {}: {}",
358            msg,
359            &details[..details.len().min(50)]
360        );
361    })?;
362
363    // -------------------------------------------------------------------------
364    // 6. Tasker Setup and Execution
365    // -------------------------------------------------------------------------
366    println!("\n[6] Setting up tasker...");
367
368    let tasker = Tasker::new()?;
369
370    // Bind resource
371    tasker.bind_resource(&resource)?;
372    println!("    Resource bound");
373
374    // Bind controller (if available)
375    if let Some(ref ctrl) = controller {
376        tasker.bind_controller(ctrl)?;
377        println!("    Controller bound");
378    }
379
380    // Check initialization
381    if tasker.inited() {
382        println!("    Tasker initialized successfully!");
383
384        // Add event sink
385        tasker.add_sink(|msg, details| {
386            println!(
387                "    [TaskerEvent] {}: {}",
388                msg,
389                &details[..details.len().min(50)]
390            );
391        })?;
392
393        // Execute task with pipeline override
394        let pipeline_override = r#"{
395            "MyCustomEntry": {
396                "recognition": "Custom",
397                "custom_recognition": "MyRecognition",
398                "action": "Custom",
399                "custom_action": "MyAction"
400            }
401        }"#;
402
403        println!("\n[7] Executing task...");
404        match tasker.post_task("MyCustomEntry", pipeline_override) {
405            Ok(job) => {
406                let status = job.wait();
407                println!("    Task status: {:?}", status);
408
409                if let Ok(Some(detail)) = job.get(false) {
410                    println!("    Entry: {}", detail.entry);
411                    println!("    Nodes executed: {}", detail.nodes.len());
412
413                    for node_opt in detail.nodes {
414                        if let Some(node) = node_opt {
415                            if let Some(reco) = node.recognition {
416                                println!(
417                                    "      Node: {}, Algo: {:?}",
418                                    node.node_name, reco.algorithm
419                                );
420                            }
421                        }
422                    }
423                }
424            }
425            Err(e) => println!("    Task failed: {}", e),
426        }
427    } else {
428        println!("    Tasker not fully initialized (missing controller binding)");
429    }
430
431    // -------------------------------------------------------------------------
432    // 8. Cleanup
433    // -------------------------------------------------------------------------
434    println!("\n[8] Demo completed!");
435    println!("    - Toolkit, Controller, Resource, Tasker all demonstrated");
436    println!("    - Custom Recognition and Action registered and explained");
437    println!("    - Context API documented in custom component implementations");
438
439    Ok(())
440}
Source

pub fn custom_action_list(&self) -> MaaResult<Vec<String>>

Get the list of registered custom actions.

Examples found in repository?
examples/main.rs (line 339)
201fn main() -> Result<(), Box<dyn std::error::Error>> {
202    println!("=== MaaFramework Rust SDK Demo ===\n");
203
204    // -------------------------------------------------------------------------
205    // 1. Initialize Toolkit
206    // -------------------------------------------------------------------------
207    let user_path = "./";
208    Toolkit::init_option(user_path, "{}")?;
209    println!("[1] Toolkit initialized with user_path: {}", user_path);
210
211    // -------------------------------------------------------------------------
212    // 2. Device Discovery
213    // -------------------------------------------------------------------------
214
215    // ADB devices
216    println!("\n[2] Scanning for ADB devices...");
217    let adb_devices = Toolkit::find_adb_devices()?;
218    if adb_devices.is_empty() {
219        println!("    No ADB device found.");
220    } else {
221        for device in &adb_devices {
222            println!("    Found: {} ({})", device.name, device.address);
223        }
224    }
225
226    // Win32 windows (Windows only)
227    #[cfg(target_os = "windows")]
228    {
229        println!("\n    Scanning for desktop windows...");
230        match Toolkit::find_desktop_windows() {
231            Ok(windows) => {
232                if windows.is_empty() {
233                    println!("    No window found.");
234                } else {
235                    for (i, win) in windows.iter().take(3).enumerate() {
236                        println!("    [{}] hwnd={:?}, class={}", i, win.hwnd, win.class_name);
237                    }
238                    if windows.len() > 3 {
239                        println!("    ... and {} more", windows.len() - 3);
240                    }
241                }
242            }
243            Err(e) => println!("    Failed to find windows: {}", e),
244        }
245    }
246
247    // -------------------------------------------------------------------------
248    // 3. Create Controller (choose one)
249    // -------------------------------------------------------------------------
250    println!("\n[3] Creating controller...");
251
252    let controller: Option<Controller>;
253
254    // Option A: ADB Controller
255    #[cfg(feature = "adb")]
256    if let Some(device) = adb_devices.first() {
257        println!("    Using ADB device: {}", device.name);
258        let config_str = serde_json::to_string(&device.config)?;
259        controller = Some(Controller::new_adb(
260            device.adb_path.to_str().unwrap(),
261            &device.address,
262            &config_str,
263            None,
264        )?);
265    } else {
266        controller = None;
267    }
268
269    #[cfg(not(feature = "adb"))]
270    {
271        controller = None;
272    }
273
274    // Option B: Win32 Controller (uncomment to use)
275    // #[cfg(target_os = "windows")]
276    // if let Some(window) = windows.first() {
277    //     controller = Some(Controller::new_win32(
278    //         window.hwnd as isize,
279    //         common::Win32ScreencapMethod::FramePool as i32,
280    //         common::Win32InputMethod::PostMessage as i32,
281    //         common::Win32InputMethod::PostMessage as i32,
282    //     )?);
283    // }
284
285    // -------------------------------------------------------------------------
286    // 4. Controller Operations
287    // -------------------------------------------------------------------------
288    if let Some(ref ctrl) = controller {
289        println!("\n[4] Controller operations...");
290
291        // Connect
292        let conn_id = ctrl.post_connection()?;
293        ctrl.wait(conn_id);
294        println!("    Connected: {}", ctrl.connected());
295
296        // Screenshot
297        let cap_id = ctrl.post_screencap()?;
298        ctrl.wait(cap_id);
299        println!("    Screenshot captured");
300
301        // Click (sync)
302        let click_id = ctrl.post_click(114, 514)?;
303        ctrl.wait(click_id);
304        println!("    Clicked at (114, 514)");
305
306        // Click (async) - post now, wait later
307        let click_id2 = ctrl.post_click(514, 114)?;
308        // ... do other work here ...
309        ctrl.wait(click_id2);
310        println!("    Async click completed");
311
312        // Input text
313        let input_id = ctrl.post_input_text("Hello MAA!")?;
314        ctrl.wait(input_id);
315        println!("    Text input sent");
316
317        // Get resolution
318        if let Ok((w, h)) = ctrl.resolution() {
319            println!("    Resolution: {}x{}", w, h);
320        }
321    } else {
322        println!("\n[4] Skipping controller operations (no device available)");
323    }
324
325    // -------------------------------------------------------------------------
326    // 5. Resource Setup
327    // -------------------------------------------------------------------------
328    println!("\n[5] Setting up resource...");
329
330    let resource = Resource::new()?;
331
332    // Register custom recognition and action
333    resource.register_custom_recognition("MyRecognition", Box::new(MyRecognition))?;
334    resource.register_custom_action("MyAction", Box::new(MyAction))?;
335    println!("    Registered: MyRecognition, MyAction");
336
337    // List registered components
338    let reco_list = resource.custom_recognition_list()?;
339    let action_list = resource.custom_action_list()?;
340    println!("    Recognition list: {:?}", reco_list);
341    println!("    Action list: {:?}", action_list);
342
343    // Load resource bundle
344    let resource_path = "sample/resource";
345    println!("    Loading resource from: {}", resource_path);
346    match resource.post_bundle(resource_path) {
347        Ok(job) => {
348            let status = job.wait();
349            println!("    Load status: {:?}", status);
350        }
351        Err(e) => println!("    Load failed: {} (OK for demo)", e),
352    }
353
354    // Add event sink
355    resource.add_sink(|msg, details| {
356        println!(
357            "    [ResourceEvent] {}: {}",
358            msg,
359            &details[..details.len().min(50)]
360        );
361    })?;
362
363    // -------------------------------------------------------------------------
364    // 6. Tasker Setup and Execution
365    // -------------------------------------------------------------------------
366    println!("\n[6] Setting up tasker...");
367
368    let tasker = Tasker::new()?;
369
370    // Bind resource
371    tasker.bind_resource(&resource)?;
372    println!("    Resource bound");
373
374    // Bind controller (if available)
375    if let Some(ref ctrl) = controller {
376        tasker.bind_controller(ctrl)?;
377        println!("    Controller bound");
378    }
379
380    // Check initialization
381    if tasker.inited() {
382        println!("    Tasker initialized successfully!");
383
384        // Add event sink
385        tasker.add_sink(|msg, details| {
386            println!(
387                "    [TaskerEvent] {}: {}",
388                msg,
389                &details[..details.len().min(50)]
390            );
391        })?;
392
393        // Execute task with pipeline override
394        let pipeline_override = r#"{
395            "MyCustomEntry": {
396                "recognition": "Custom",
397                "custom_recognition": "MyRecognition",
398                "action": "Custom",
399                "custom_action": "MyAction"
400            }
401        }"#;
402
403        println!("\n[7] Executing task...");
404        match tasker.post_task("MyCustomEntry", pipeline_override) {
405            Ok(job) => {
406                let status = job.wait();
407                println!("    Task status: {:?}", status);
408
409                if let Ok(Some(detail)) = job.get(false) {
410                    println!("    Entry: {}", detail.entry);
411                    println!("    Nodes executed: {}", detail.nodes.len());
412
413                    for node_opt in detail.nodes {
414                        if let Some(node) = node_opt {
415                            if let Some(reco) = node.recognition {
416                                println!(
417                                    "      Node: {}, Algo: {:?}",
418                                    node.node_name, reco.algorithm
419                                );
420                            }
421                        }
422                    }
423                }
424            }
425            Err(e) => println!("    Task failed: {}", e),
426        }
427    } else {
428        println!("    Tasker not fully initialized (missing controller binding)");
429    }
430
431    // -------------------------------------------------------------------------
432    // 8. Cleanup
433    // -------------------------------------------------------------------------
434    println!("\n[8] Demo completed!");
435    println!("    - Toolkit, Controller, Resource, Tasker all demonstrated");
436    println!("    - Custom Recognition and Action registered and explained");
437    println!("    - Context API documented in custom component implementations");
438
439    Ok(())
440}
Source

pub fn clear_custom_recognition(&self) -> MaaResult<()>

Clear all registered custom recognitions.

Source

pub fn clear_custom_action(&self) -> MaaResult<()>

Clear all registered custom actions.

Trait Implementations§

Source§

impl Clone for Resource

Source§

fn clone(&self) -> Resource

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Send for Resource

Source§

impl Sync for Resource

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.