Skip to main content

PluginManager

Struct PluginManager 

Source
pub struct PluginManager {
    pub lua: Lua,
}
Expand description

Orchestrates Zoi’s extensibility via global Lua plugins.

Plugins allow users to customize Zoi’s behavior by:

  • Registering new subcommands (zoi.register_command).
  • Intercepting lifecycle events (zoi.on_post_install, etc.).
  • Overriding tool versions at runtime (shim resolution).

Plugins are stored in ~/.zoi/plugins/ and are verified against a trusted_hashes.json database to prevent unauthorized execution.

Fields§

§lua: Lua

The initialized mlua Lua Virtual Machine.

Implementations§

Source§

impl PluginManager

Source

pub fn new() -> Result<Self>

Initializes a new PluginManager and sets up the global Lua API.

This injects the entire zoi.* API surface into the Lua environment, enabling plugins to interact with the filesystem, HTTP, archives, the UI, and the hook registry.

§Errors

Returns an error if the Lua VM cannot be initialized or if the zoi API fails to be injected.

Source

pub fn set_context(&self, scope: Scope) -> Result<()>

Sets the operational scope for plugins.

§Errors

Returns an error if the zoi global table cannot be accessed or if the scope cannot be set.

Source

pub fn load_all(&self, yes: bool) -> Result<()>

Loads and executes all trusted Lua plugins from the plugin directory.

§Errors

Returns an error if the plugin directory cannot be read, if a plugin script cannot be loaded, or if a plugin execution fails.

Source

pub fn trigger_hook(&self, hook_name: &str, arg: Option<&Value>) -> Result<()>

Triggers a lifecycle hook, executing all registered callbacks.

§Errors

Returns an error if the hook registry cannot be accessed or if any callback execution fails.

Source

pub fn trigger_hook_nonfatal(&self, hook_name: &str, arg: Option<&Value>)

Triggers a lifecycle hook but ignores errors, printing a warning instead.

Source

pub fn trigger_resolve_shim_version( &self, bin_name: &str, ) -> Result<Option<String>>

Triggers the shim version resolution hook.

§Errors

Returns an error if the hook registry cannot be accessed or if any callback execution fails.

Source

pub fn trigger_project_install_hook(&self) -> Result<bool>

Triggers the project installation hook.

§Errors

Returns an error if the hook registry cannot be accessed or if any callback execution fails.

Source

pub fn run_command(&self, name: &str, args: Vec<String>) -> Result<bool>

Executes a custom command registered by a plugin.

§Errors

Returns an error if the command registry cannot be accessed or if the command execution fails.

Source

pub fn list_commands(&self) -> Result<Vec<(String, String)>>

Lists all custom commands registered by plugins.

§Errors

Returns an error if the command registry cannot be accessed.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSend for T

Source§

impl<T> MaybeSync for T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more