Marvin.Types

Documentation

data Message a

contents and meta information of a recieved message

Constructors

Message

Fields

• sender :: User a
• channel :: Channel a
• content :: Text
• timestamp :: TimeStamp

Instances

HasResponds (Handlers a0) (Vector (Regex, Match -> Message a0 -> RunnerM ()))

Methods

responds :: Lens' (Handlers a0) (Vector (Regex, Match -> Message a0 -> RunnerM ()))

HasHears (Handlers a0) (Vector (Regex, Match -> Message a0 -> RunnerM ()))

Methods

hears :: Lens' (Handlers a0) (Vector (Regex, Match -> Message a0 -> RunnerM ()))

Get (b, Message a) (User' a)

Methods

getLens :: Lens' (b, Message a) (User' a)

Get (b, Message a) (Channel' a)

Methods

getLens :: Lens' (b, Message a) (Channel' a)

Get (b, Message a) (Message a)

Methods

getLens :: Lens' (b, Message a) (Message a)

newtype ScriptId

A type, basically a String, which identifies a script to the config and the logging facilities.

Constructors

ScriptId

Fields

• unwrapScriptId :: Text

Instances

Eq ScriptId

Methods

(==) :: ScriptId -> ScriptId -> Bool

(/=) :: ScriptId -> ScriptId -> Bool

Show ScriptId

Methods

showsPrec :: Int -> ScriptId -> ShowS

show :: ScriptId -> String

showList :: [ScriptId] -> ShowS

IsString ScriptId

Methods

fromString :: String -> ScriptId

ShowT ScriptId

Methods

showT :: ScriptId -> Text

showListT :: [ScriptId] -> Text

HasScriptId (Script a0) ScriptId

Methods

scriptId :: Lens' (Script a0) ScriptId

HasScriptId (BotActionState a0 d0) ScriptId

Methods

scriptId :: Lens' (BotActionState a0 d0) ScriptId

applicationScriptId :: ScriptId

class IsScript m where

Minimal complete definition

getScriptId

Methods

getScriptId :: m ScriptId

Instances

IsScript (ScriptDefinition a)

Methods

getScriptId :: ScriptDefinition a ScriptId

IsScript (BotReacting a b)

Methods

getScriptId :: BotReacting a b ScriptId

getScriptId :: IsScript m => m ScriptId

class (IsScript m, MonadIO m) => HasConfigAccess m

Denotes a place from which we may access the configuration.

During script definition or when handling a request we can obtain the config with getConfigVal or requireConfigVal.

Minimal complete definition

getConfigInternal

Instances

HasConfigAccess (ScriptDefinition a)

Methods

getConfigInternal :: ScriptDefinition a Config

HasConfigAccess (BotReacting a b)

Methods

getConfigInternal :: BotReacting a b Config