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.

The framework rejects an empty name and any name already taken by a custom recognition or action on this Resource; in that case the previous registration is kept and Err(MaaError::InvalidArgument) is returned. Unregister first to replace.

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.

The framework rejects an empty name and any name already taken by a custom recognition or action on this Resource; in that case the previous registration is kept and Err(MaaError::InvalidArgument) is returned. Unregister first to replace.

Source §

impl Resource

Source

pub fn new() -> MaaResult<Self>

Create a new resource manager.

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.

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 use_webgpu(&self, device_id: i32) -> MaaResult<()>

Use WebGPU for GPU-accelerated inference (Windows, Linux and macOS).

§Arguments

device_id - WebGPU device id (0 for the first device)

Source

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

Use NCNN for inference (Android builds only, CPU only).

Fails on builds without NCNN, and when switching to or from NCNN after resource loading has started (until clear). Models are loaded from <model stem>.ncnn.param/.ncnn.bin/.ncnn.json with no fallback to onnxruntime.

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.

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