Struct UserEngineApi 

pub struct UserEngineApi { /* private fields */ }

The Userscript Scan Engine API

The userscript scan engine API exposes a function user_engines:register(<name>, <function>) to the Lua userscript environment. Once one or more userscript scan engines are registered, a scan can be launched using user_engines:scan(<string>), where <string> may also be a bytestring.

Implementations

impl UserEngineApi

pub fn new(engine_ref: WeakActorRef<UserEngine>) -> Self

Creates a new Userscript Scan Engine API with no engines loaded.

Trait Implementations

impl ApiObject for UserEngineApi

fn name(&self) -> &'static str

The name of the API object, as visible from Lua

fn init_script(&self, _: &Lua) -> Result<()>

An optional startup function, which runs when the ApiObject

impl UserData for UserEngineApi

fn add_methods<M: LuaUserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn add_fields<F>(fields: &mut F)

where F: UserDataFields<Self>,

Adds custom fields specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.