Marvin.Types

Documentation

newtype User

Identifier for a user (internal and not necessarily equal to the username)

Constructors

User Text

Instances

Eq User

Methods

(==) :: User -> User -> Bool

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

IsString User

Methods

fromString :: String -> User

ToJSON User

Methods

toJSON :: User -> Value

toEncoding :: User -> Encoding

FromJSON User

Methods

parseJSON :: Value -> Parser User

Hashable User

Methods

hashWithSalt :: Int -> User -> Int

hash :: User -> Int

HasUser User

Methods

userLens :: Lens' User User

HasUser (User, a)

Methods

userLens :: Lens' (User, a) User

newtype Channel

Identifier for a channel (internal and not necessarily equal to the channel name)

Constructors

Channel Text

Instances

Eq Channel

Methods

(==) :: Channel -> Channel -> Bool

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

Show Channel

Methods

showsPrec :: Int -> Channel -> ShowS

show :: Channel -> String

showList :: [Channel] -> ShowS

IsString Channel

Methods

fromString :: String -> Channel

ToJSON Channel

Methods

toJSON :: Channel -> Value

toEncoding :: Channel -> Encoding

FromJSON Channel

Methods

parseJSON :: Value -> Parser Channel

Hashable Channel

Methods

hashWithSalt :: Int -> Channel -> Int

hash :: Channel -> Int

HasChannel (a, Channel)

Methods

channelLens :: Lens' (a, Channel) Channel

data Message

contents and meta information of a recieved message

Constructors

Message

Fields

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

Instances

HasMessageField MessageReactionData Message

Methods

messageField :: Lens' MessageReactionData Message

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