Struct HookScript 

pub struct HookScript {
    pub path: String,
    /* private fields */
}

A compiled stage-hook script, ready to call.

Compiled once at spawn and shared via Arc, keyed by the path as written in the blueprint - the same lifecycle a crate::region_hook::RegionScript has, so one file backing several hooks is compiled once.

Fields

path: String

The script path as written in the blueprint - log/error context only.

Implementations

impl HookScript

pub fn defines(&self, hook: &str) -> bool

Whether this script defines the named hook.

pub fn defined(&self) -> &[String]

Every hook this script defines, in HOOK_NAMES order.

Trait Implementations

impl Clone for HookScript

fn clone(&self) -> HookScript

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookScript

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

Formats the value using the given formatter.