Struct hexchat_api::Plugin

pub struct Plugin { /* private fields */ }

Represents a created plugin entry. Plugins that embed other language interpreters and load plugins written in those languages can have Hexchat look as if the loaded scripts are actual plugins. By creating a Plugin object for such a script, an entry is made in Hexchat’s list of loaded plugins. When one of these scripts is unloaded, the fictitious plugin entry can be removed from Hexchat by dropping the associated Plugin object.

Implementations

impl Plugin

pub fn new( file_name: &str, plugin_name: &str, description: &str, version: &str ) -> Plugin

Creates a new plugin entry in Hexchat.

Arguments

file_name - The name of the script representing a “plugin”. plugin_name - The name of the plugin script. description - The plugin script’s description. version - A version string for the plugin script.

pub fn remove(&self)

Removes the plugin entry for the plugin script. This can be used to remove a plugin entry, or simply dropping the Plugin object will cause removal to happen automatically.

Trait Implementations

impl Clone for Plugin

fn clone(&self) -> Plugin

Returns a copy of the value.

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

Performs copy-assignment from source.