Trait Plugin 

pub trait Plugin: Default + 'static {
    // Required method
    fn info() -> PluginInfo;

    // Provided methods
    fn start(&mut self) { ... }
    fn stop(&mut self) { ... }
    fn on_event(&mut self, _event: Event) { ... }
    fn pre_send(&mut self, _message: OutgoingMessage) -> SendDecision { ... }
    fn pre_edit(&mut self, _edit: OutgoingEdit) -> SendDecision { ... }
    fn message_accessories(&mut self, _message: Message) -> Vec<Element> { ... }
    fn message_decorations(&mut self, _message: Message) -> Vec<Element> { ... }
    fn message_popover_buttons(
        &mut self,
        _message: Message,
    ) -> Vec<PopoverButton> { ... }
    fn chat_bar_buttons(
        &mut self,
        _context: ChatBarContext,
    ) -> Vec<ChatBarButton> { ... }
    fn context_menu(&mut self, _target: MenuTarget) -> Vec<MenuItem> { ... }
    fn profile_sections(&mut self, _context: ProfileContext) -> Vec<Element> { ... }
    fn user_badges(&mut self, _context: ProfileContext) -> Vec<Badge> { ... }
    fn member_decorations(&mut self, _context: MemberContext) -> Vec<Element> { ... }
    fn server_list_elements(&mut self) -> Vec<Element> { ... }
    fn settings_panel(&mut self) -> Option<Element> { ... }
}

A PhoenixCord plugin.

The host creates the plugin with Default when it is enabled and drops it when it is disabled. Every hook has an empty default, so implement only the hooks listed in PluginInfo::hooks. The meaning of each hook is documented on the matching function of the plugin interface in phoenixcord.wit.

Required Methods

fn info() -> PluginInfo

Static metadata, read once when the plugin is loaded.

Provided Methods

fn start(&mut self)

fn stop(&mut self)

fn on_event(&mut self, _event: Event)

fn pre_send(&mut self, _message: OutgoingMessage) -> SendDecision

fn pre_edit(&mut self, _edit: OutgoingEdit) -> SendDecision

fn message_accessories(&mut self, _message: Message) -> Vec<Element>

fn message_decorations(&mut self, _message: Message) -> Vec<Element>

fn message_popover_buttons(&mut self, _message: Message) -> Vec<PopoverButton>

fn chat_bar_buttons(&mut self, _context: ChatBarContext) -> Vec<ChatBarButton>

fn context_menu(&mut self, _target: MenuTarget) -> Vec<MenuItem>

fn profile_sections(&mut self, _context: ProfileContext) -> Vec<Element>

fn user_badges(&mut self, _context: ProfileContext) -> Vec<Badge>

fn member_decorations(&mut self, _context: MemberContext) -> Vec<Element>

fn server_list_elements(&mut self) -> Vec<Element>

fn settings_panel(&mut self) -> Option<Element>

Dyn Compatibility

This trait is not dyn compatible.

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

Implementors