Trait Plugin

pub trait Plugin: Send + Sync {
    // Required methods
    fn name(&self) -> &str;
    fn version(&self) -> &str;
    fn capabilities(&self) -> Vec<Capability>;
    fn process<'life0, 'async_trait>(
        &'life0 self,
        request: PluginRequest,
    ) -> Pin<Box<dyn Future<Output = Result<PluginResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

    // Provided methods
    fn description(&self) -> &str { ... }
    fn initialize<'life0, 'async_trait>(
        &'life0 mut self,
        _config: PluginConfig,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn shutdown<'life0, 'async_trait>(
        &'life0 mut self,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn can_handle(&self, _message: &Message) -> bool { ... }
    fn metadata(&self) -> PluginMetadata { ... }
}

Plugin trait for extending bot functionality

Required Methods

fn name(&self) -> &str

Get the plugin name

fn version(&self) -> &str

Get the plugin version

fn capabilities(&self) -> Vec<Capability>

Get plugin capabilities

fn process<'life0, 'async_trait>( &'life0 self, request: PluginRequest, ) -> Pin<Box<dyn Future<Output = Result<PluginResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Process a request

Provided Methods

fn description(&self) -> &str

Get plugin description

fn initialize<'life0, 'async_trait>( &'life0 mut self, _config: PluginConfig, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Initialize the plugin

fn shutdown<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Shutdown the plugin

fn can_handle(&self, _message: &Message) -> bool

Check if the plugin can handle a message

fn metadata(&self) -> PluginMetadata

Get plugin metadata

Implementors

impl Plugin for EchoPlugin