Struct auxtools::Proc

pub struct Proc {
    pub id: ProcId,
    pub entry: *mut ProcEntry,
    pub path: String,
}

Used to hook and call procs.

Fields

id: ProcId

entry: *mut ProcEntry

path: String

Implementations

impl Proc

pub fn hook( &self, func: fn(_: &Value, _: &Value, _: Vec<Value>) -> DMResult ) -> Result<(), HookFailure>

impl Proc

pub fn find<S: Into<String>>(path: S) -> Option<Self>

Finds the first proc with the given path

pub fn find_override<S: Into<String>>(path: S, override_id: u32) -> Option<Self>

Finds the n’th re-defined proc with the given path

pub fn from_id(id: ProcId) -> Option<Self>

pub unsafe fn file_name(&self) -> Option<StringRef>

pub fn parameter_names(&self) -> Vec<StringRef>

pub fn local_names(&self) -> Vec<StringRef>

pub fn set_bytecode(&self, bytecode: Vec<u32>)

pub unsafe fn bytecode_mut_ptr(&self) -> (*mut u32, u16)

pub unsafe fn bytecode(&self) -> &[u32]

pub fn call(&self, args: &[&Value]) -> DMResult

Calls a global proc with the given arguments.

Examples

This function is equivalent to return do_explode(3) in DM.

#[hook("/proc/my_proc")]
fn my_proc_hook() -> DMResult {
    let proc = Proc::find("/proc/do_explode").unwrap();
    proc.call(&[&Value::from(3.0)])
}

pub fn override_id(&self) -> u32

Trait Implementations

impl Clone for Proc

fn clone(&self) -> Proc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Proc

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

Formats the value using the given formatter.