Enum HookFunction 

pub enum HookFunction {
    PreInstall,
    PostInstall,
    PreRun,
}

Enumeration of all available hook functions that can be implemented by plugins.

Hook functions are called at specific points during proto operations to allow plugins to customize behavior, perform setup/cleanup, or modify the environment.

Variants

PreInstall

Pre-install hook.

Called before a tool installation begins, allowing plugins to perform setup tasks, validate prerequisites, or modify the installation environment.

Input: InstallHook | Output: None

PostInstall

Post-install hook.

Called after a tool installation completes successfully, allowing plugins to perform cleanup tasks, configure the tool, or set up additional resources.

Input: InstallHook | Output: None

PreRun

Pre-run hook.

Called before executing a tool’s executable, allowing plugins to modify environment variables, validate runtime conditions, or perform setup.

Input: RunHook | Output: RunHookResult

Implementations

impl HookFunction

pub fn as_str(&self) -> &'static str

Get the string representation of the hook function name.

This returns the actual function name that should be used when calling the hook function via WASM.

Trait Implementations

impl AsRef<str> for HookFunction

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for HookFunction

fn clone(&self) -> HookFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookFunction

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

Formats the value using the given formatter.

impl Hash for HookFunction

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HookFunction

fn eq(&self, other: &HookFunction) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for HookFunction

impl Eq for HookFunction

impl StructuralPartialEq for HookFunction