Struct Bot

pub struct Bot {
    pub information: BotInformation,
    /* private fields */
}

bot结构体

Fields

information: BotInformation

Implementations

impl Bot

pub fn spawn<F>(&mut self, future: F) -> JoinHandle<F::Output>

where F: Future + Send + 'static, F::Output: Send + 'static,

pub fn run(self)

运行bot

注意此函数会阻塞, 直到Bot连接失效，或者有退出信号传入程序

impl Bot

pub fn build<C>(conf: C) -> Bot

where C: AsRef<KoviConf>,

构建一个bot实例

Examples

let conf = KoviConf::new(
    123456,
    None,
    Server {
        host: "127.0.0.1".parse(),
        port: 8081,
        access_token: "",
    },
    false,
    None,
);
let bot = Bot::build(conf);
bot.run()

pub fn mount_main<T>( &mut self, name: T, version: T, main: Arc<dyn Fn() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>, )

where String: From<T>,

👎Deprecated since 0.12.0: 请使用 mount_plugin 代替

挂载插件。

pub fn mount_plugin(&mut self, plugin: Plugin)

挂载插件。

pub fn load_local_conf() -> Result<KoviConf, BotBuildError>

读取本地Kovi.conf.toml文件

impl Bot

pub fn set_plugin_startup_use_file(self) -> Self

使用KoviConf设置插件在Bot启动时的状态

如果配置文件中没有对应的插件，将会被忽略，保留插件默认状态

如果配置文件读取失败或者解析toml失败，将会保留插件默认状态

pub fn set_plugin_startup_use_file_ref(&mut self)

使用KoviConf设置插件在Bot启动时的状态

如果配置文件中没有对应的插件，将会被忽略，保留插件默认状态

如果配置文件读取失败或者解析toml失败，将会保留插件默认状态

pub fn set_all_plugin_startup(self, enabled: bool) -> Self

设置全部插件在Bot启动时的状态

pub fn set_all_plugin_startup_ref(&mut self, enabled: bool)

设置全部插件在Bot启动时的状态

pub fn set_plugin_startup<T: AsRef<str>>( self, name: T, enabled: bool, ) -> Result<Self, BotError>

设置单个插件在Bot启动时的状态

pub fn set_plugin_startup_ref<T: AsRef<str>>( &mut self, name: T, enabled: bool, ) -> Result<(), BotError>

设置单个插件在Bot启动时的状态

Trait Implementations

impl Clone for Bot

fn clone(&self) -> Bot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for Bot

fn drop(&mut self)

Executes the destructor for this type.