Interface TrinityCommand

modules/libcommand/src/lib.rs:124–151

}

pub trait TrinityCommand {
    /// Code that will be called once during initialization of the command. This is a good time to
    /// retrieve settings from the database and cache them locally, if needs be, or run any
    /// initialization code that shouldn't run on every message later.
    fn init(_config: HashMap<String, String>) {}

    /// Handle a message received in a room where the bot is present.
    ///
    /// The message isn't identified as a request for help or an admin command. Those are handled
    /// respectively by `on_help` and `on_admin`.
    ///
    /// This should always be implemented, otherwise the command doesn't do anything.
    fn on_msg(client: &mut CommandClient, content: &str);

    /// Respond to a help request, for this specific command.
    ///
    /// If the topic is not set, then this should return a general description of the command, with
    /// hints to the possible topics. If the topic is set, then this function should document
    /// something related to the specific topic.
    ///
    /// This should always be implemented, at least to document what's the command's purpose.
    fn on_help(_topic: Option<&str>) -> String;

    /// Handle a message received by an admin, prefixed with the `!admin` subject.
    ///
    /// By default this does nothing, as admin commands are facultative.
    fn on_admin(_client: &mut CommandClient, _command: &str) {}
}