Trait Plugin 

pub trait Plugin: Send {
    // Required methods
    fn id(&self) -> &str;
    fn name(&self) -> &str;
    fn init(&mut self, ctx: &mut PluginContext) -> Result<(), Box<dyn Error>>;

    // Provided methods
    fn handle_key(&mut self, _key: KeyEvent) -> bool { ... }
    fn render(&self, _f: &mut Frame<'_>, _area: Rect) { ... }
    fn tick(&mut self) { ... }
    fn on_focus(&mut self) { ... }
    fn on_blur(&mut self) { ... }
    fn on_theme_change(&mut self, _theme: &Theme) { ... }
    fn on_user_update(&mut self, _user: Option<&User>) { ... }
    fn status_hints(&self) -> Vec<(String, String)> { ... }
    fn commands(&self) -> Vec<PluginCmdItem> { ... }
    fn handle_palette_command(&mut self, _index: usize) { ... }
    fn on_plugin_message(&mut self, _from: &str, _action: &str, _data: &str) { ... }
    fn shutdown(&mut self) { ... }
    fn binary_path(&self) -> Option<&Path> { ... }
    fn is_alive(&self) -> bool { ... }
    fn can_background(&self) -> bool { ... }
    fn set_capabilities(&mut self, _caps: Vec<String>) { ... }
}

Required Methods

fn id(&self) -> &str

fn name(&self) -> &str

fn init(&mut self, ctx: &mut PluginContext) -> Result<(), Box<dyn Error>>

Provided Methods

fn handle_key(&mut self, _key: KeyEvent) -> bool

fn render(&self, _f: &mut Frame<'_>, _area: Rect)

fn tick(&mut self)

fn on_focus(&mut self)

fn on_blur(&mut self)

fn on_theme_change(&mut self, _theme: &Theme)

fn on_user_update(&mut self, _user: Option<&User>)

fn status_hints(&self) -> Vec<(String, String)>

fn commands(&self) -> Vec<PluginCmdItem>

Palette commands that this plugin registers (category, label).

fn handle_palette_command(&mut self, _index: usize)

Called when a palette command from this plugin is selected. index is the position in commands().

fn on_plugin_message(&mut self, _from: &str, _action: &str, _data: &str)

Called when a plugin-to-plugin message arrives.

fn shutdown(&mut self)

Called before the plugin is unloaded (hot-reload or app exit). The plugin should flush state, close handles, and prepare to be dropped. For IPC plugins this sends Shutdown and waits briefly for a response before the child process is killed.

fn binary_path(&self) -> Option<&Path>

Return the filesystem path to this plugin’s binary, if it runs as an external process. None for in-process plugins. Used by the hot-reload mechanism to detect when the binary has been updated on disk.

fn is_alive(&self) -> bool

Whether the plugin process is still running. Returns true for in-process plugins. IPC plugins override this to check the child process.

fn can_background(&self) -> bool

Whether the plugin supports running in the background when the user presses Esc (e.g., audio players that should keep playing). Default is false. Override to return true for background-capable plugins.

fn set_capabilities(&mut self, _caps: Vec<String>)

Set runtime capabilities (e.g. "background") declared in the plugin manifest. Default is no-op; IPC plugins override this to store the value.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors