chatbot 0.2.3

An extensible chatbot
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

//! Contains the `ChatAdapter` trait and several implementations

use std::sync::mpsc::Sender;

use message::IncomingMessage;
use chatbot::Chatbot;

mod cli;
pub use self::cli::CliAdapter;

mod slack;
pub use self::slack::SlackAdapter;

mod irc;
pub use self::irc::IrcAdapter;
pub use self::irc::IrcConfig;

/// Chatbot is extensible in both message sources and command handling. To add a
/// new message source, create a type that implements the `ChatAdapter` trait.
pub trait ChatAdapter {
    /// The name of the adapter which is used internally as a map key and for
    /// debugging.
    fn get_name(&self) -> &str;

    /// ChatAdapters must implement process_events. What this method does will
    /// vary wildly by adapter. At the very least, it must generate IncominMessages from its input,
    /// send them via the `Sender` that's passed in. The main loop has the other end of this
    /// receiver. The IncomingMessage must be constructed with a `Sender<OutgoingMessage>` for
    /// which the adapter listens on the Receiver to send messages back to the service.
    fn process_events(&self, &Chatbot, Sender<IncomingMessage>);
}