Struct vk_bot::core::Core

pub struct Core { /* fields omitted */ }

Core accepts user-defined handlers, and invokes them when needed. Note that only one handler (the first found, according to the Core::on docs) is called for a given message.

Works like a builder.

Methods

impl Core

pub fn new() -> Self

Creates a new Core.

pub fn cmd_prefix(self, cmd_prefix: &str) -> Self

Modifies this Core's command prefix.

pub fn on(self, event: Event, handler: Handler) -> Self

Adds a new event handler to this Core.

See Event for possible events.

Be very careful in implementation of Event::MessageReply. It will be triggered for every message your community admins or the bot sends, including ones sent through an Event::MessageReply or Event::NoMatch handler!

Handler for the Event::MessageNew is built-in, not changeable, and works like this:

#	cause	action
1	action field on object	Event::ServiceAction
2	special {"command": "start"} payload	Event::Start
3	exact payload match set up via Core::payload	respective handler
4	'dynamic' payload match set up via Core::dyn_payload	respective handler
5	command handlers (Core::cmd_prefix and Core::cmd)	respective handler
6	regex handlers (Core::regex)	respective handler
7	anything except Event::MessageReply and Event::NoMatch	Event::NoMatch

pub fn payload(self, payload: &str, handler: Handler) -> Self

Adds a new payload handler to this Core.

See also Core::dyn_payload.

pub fn dyn_payload(self, tester: Tester, handler: Handler) -> Self

Adds a new dynamic (provided a Tester) payload handler to this Core.

See also Core::payload.

pub fn cmd(self, cmd: &str, handler: Handler) -> Self

Adds a new command (exact string after command prefix) handler to this Core.

pub fn regex(self, regex: &str, handler: Handler) -> Self

Adds a new regex handler to this Core.

pub fn handle(&self, req: &CallbackAPIRequest, api: Arc<Mutex<APIClient>>)

Handles a request by telling the appropriate Handler to do so.

Trait Implementations

impl Default for Core

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Core

fn clone(&self) -> Core

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Core

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.