Trait zsh_module::Actions

pub trait Actions {
    fn boot(&mut self) -> Result<()>;
    fn cleanup(&mut self) -> Result<()>;
}

This trait allows for defining behaviour to be enacted on parts of the zsh module lifecycle.

Refer to each method for a description of when it is called

Required Methods

fn boot(&mut self) -> Result<()>

This method is called right after setup().

If this returns Err, loading is cancelled and Self::cleanup is not called.

fn cleanup(&mut self) -> Result<()>

This method is only called if the module was successfully loaded.

An Err result means the module is not ready to unload yet. However, zsh will ignore this if it is exiting.

Implementors