Crate irclap [] [src]

A crate for parsing IRC bot commands via clap. Documentation is hopefully good, but not vetted by others, so any comments are very welcome.

The core function of the library is provided through new_irclap_future, which links together all necessary trait impls and config as a single Future. That Future can then be driven on a tokio reactor, and you've got yourself an IRC bot.

Structs

IrclapSimpleContextMapping

Supports extracting common context values from IRC messages into args for processing.

Traits

IrclapCommandProcessor

Used to execute your program based on the results of irclap's message handling and parsing.

IrclapContextMapper

Provides a mapping between the context provided by an IRC message and the actual arguments needed to run a clap application. Also allows for special transformations to any arguments provided in the message.

IrclapResponseStream

Sends out messages to whatever channel, nickname, or other target started processing of a message.

Functions

new_irclap_future

Create a new Future which will execute an irclap application.