Struct State

pub struct State { /* private fields */ }

Implementations

impl State

pub fn load_modules<Modls>( &mut self, modules: Modls, mode: ModuleLoadMode, ) -> Result<(), Vec<Error>>

where Modls: IntoIterator<Item = Module>,

pub fn load_module( &mut self, module: Module, mode: ModuleLoadMode, ) -> Result<(), Vec<Error>>

impl State

pub fn framework_crate_name(&self) -> &'static str

Returns a &str containing either the name of this crate or the text "<unknown>".

pub fn framework_version_str(&self) -> &'static str

Returns a &str containing either version information for the bot framework or the text "<unknown>".

This version information is intended for display only, and is not necessarily in SemVer format or otherwise intended as machine-readable.

pub fn framework_homepage_url_str(&self) -> &'static str

Returns a &str containing either a Uniform Resource Locator (URL) for a Web page containing information about the bot framework, or the text "<unknown>".

impl State

pub fn nick(&self, server_id: ServerId) -> Result<String>

pub fn module_data_path(&self) -> Result<&Path>

pub fn command(&self, name: &str) -> Result<Option<&BotCommand>>

pub fn command_names(&self) -> Result<Vec<Cow<'static, str>>>

pub fn have_admin(&self, _: MsgPrefix<'_>) -> Result<bool>

pub fn rng(&self) -> Result<MutexGuard<'_, StdRng>>

Allows access to a random number generator that’s stored centrally, to avoid the cost of repeatedly initializing one.