Lambdabot.Module

Documentation

data Module st

The Module type class.

Constructors

Module

Fields

moduleSerialize :: !(Maybe (Serial st))

If the module wants its state to be saved, this function should return a Serial.

The default implementation returns Nothing.

moduleDefState :: !(LB st)

If the module maintains state, this method specifies the default state (for example in case the state can't be read from a state).

The default implementation returns an error and assumes the state is never accessed.

moduleSticky :: !Bool

Is the module sticky? Sticky modules (as well as static ones) can't be unloaded. By default, modules are not sticky.

moduleCmds :: !(ModuleT st LB [Command (ModuleT st LB)])

The commands the module listenes to.

moduleInit :: !(ModuleT st LB ())

Initialize the module. The default implementation does nothing.

moduleExit :: !(ModuleT st LB ())

Finalize the module. The default implementation does nothing.

contextual :: !(String -> Cmd (ModuleT st LB) ())

Process contextual input. A plugin that implements contextual is able to respond to text not part of a normal command.

newModule :: Module st

data ModuleID st

Instances

GCompare * ModuleID

GEq * ModuleID

newModuleID :: IO (ModuleID st)

data ModuleInfo st

Info about a running module.

Constructors

ModuleInfo

Fields

moduleName :: !String

moduleID :: !(ModuleID st)

theModule :: !(Module st)

moduleState :: !(MVar st)

Instances

Monad m => MonadReader (ModuleInfo st) (ModuleT st m)

data ModuleT st m a

This transformer encodes the additional information a module might need to access its name or its state.

Instances

MonadBase b m => MonadBase b (ModuleT st m)

MonadBaseControl b m => MonadBaseControl b (ModuleT st m)

MonadTrans (ModuleT st)

MonadTransControl (ModuleT st)

Monad m => MonadReader (ModuleInfo st) (ModuleT st m)

Monad m => Monad (ModuleT st m)

Functor m => Functor (ModuleT st m)

Applicative m => Applicative (ModuleT st m)

MonadIO m => MonadIO (ModuleT st m)

MonadException m => MonadException (ModuleT st m)

MonadLogging m => MonadLogging (ModuleT st m)

MonadConfig m => MonadConfig (ModuleT st m)

MonadLB m => MonadLB (ModuleT st m)

MonadLB m => MonadLBState (ModuleT st m)

type StT (ModuleT st) a = a

type LBState (ModuleT st m) = st

type StM (ModuleT st m) a = ComposeSt (ModuleT st) m a

runModuleT :: ModuleT st m a -> ModuleInfo st -> m a