Struct hexchat_api::PluginInfo

pub struct PluginInfo { /* private fields */ }

Hexchat addons need to return an instance of this struct from their plugin_info() function, which gets called when Hexchat loads the addons. The PluginInfo object holds pinned internal buffers that Hexchat can read from at its leisure.

Implementations

impl PluginInfo

pub fn new(name: &str, version: &str, description: &str) -> PluginInfo

Constructor. The plugin information provided in the parameters is used to create persistent pinned buffers that are guaranteed to be valid for Hexchat to read from while the plugin is loading.

Arguments

• name - The name of the plugin.
• version - The plugin’s version number.
• description - The plugin’s description.

Returns

A PluginInfo object initialized from the parameter data.