Calamity.Client.Types

Types for the client

Documentation

data Client

Constructors

Client

Fields

• shards :: TVar [(InChan ControlMessage, Async (Maybe ()))]
• numShards :: MVar Int
• token :: Token
• rlState :: RateLimitState
• eventsIn :: InChan CalamityEvent
• eventsOut :: OutChan CalamityEvent
• ehidCounter :: IORef Integer

Instances

Generic Client

Defined in Calamity.Client.Types

Associated Types

type Rep Client :: Type -> Type

Methods

from :: Client -> Rep Client x

to :: Rep Client x -> Client

type Rep Client

Defined in Calamity.Client.Types

type Rep Client = D1 ('MetaData "Client" "Calamity.Client.Types" "calamity-0.1.12.0-inplace" 'False) (C1 ('MetaCons "Client" 'PrefixI 'True) ((S1 ('MetaSel ('Just "shards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TVar [(InChan ControlMessage, Async (Maybe ()))])) :*: (S1 ('MetaSel ('Just "numShards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MVar Int)) :*: S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Token))) :*: ((S1 ('MetaSel ('Just "rlState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RateLimitState) :*: S1 ('MetaSel ('Just "eventsIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InChan CalamityEvent))) :*: (S1 ('MetaSel ('Just "eventsOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OutChan CalamityEvent)) :*: S1 ('MetaSel ('Just "ehidCounter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (IORef Integer))))))

newtype StartupError

Constructors

StartupError String

Instances

Show StartupError

Defined in Calamity.Client.Types

Methods

showsPrec :: Int -> StartupError -> ShowS

show :: StartupError -> String

showList :: [StartupError] -> ShowS

data EventType

A Data Kind used to fire custom events

Constructors

ReadyEvt

ChannelCreateEvt

ChannelUpdateEvt

ChannelDeleteEvt

ChannelpinsUpdateEvt

GuildCreateEvt

GuildUpdateEvt

GuildDeleteEvt

GuildBanAddEvt

GuildBanRemoveEvt

GuildEmojisUpdateEvt

GuildIntegrationsUpdateEvt

GuildMemberAddEvt

GuildMemberRemoveEvt

GuildMemberUpdateEvt

GuildMembersChunkEvt

GuildRoleCreateEvt

GuildRoleUpdateEvt

GuildRoleDeleteEvt

InviteCreateEvt

InviteDeleteEvt

MessageCreateEvt

MessageUpdateEvt

MessageDeleteEvt

MessageDeleteBulkEvt

MessageReactionAddEvt

MessageReactionRemoveEvt

MessageReactionRemoveAllEvt

TypingStartEvt

UserUpdateEvt

forall s a. CustomEvt s a

A custom event, s is the name and a is the data sent to the handler

Instances

(EHInstanceSelector a ~ flag, RemoveEventHandler' flag a) => RemoveEventHandler (a :: EventType)

Defined in Calamity.Client.Types

Methods

removeEventHandler :: Proxy a -> Integer -> EventHandlers -> EventHandlers

data GuildCreateStatus

Constructors

GuildCreateNew

The guild was just joined

GuildCreateAvailable

The guild is becoming available

Instances

Show GuildCreateStatus

Defined in Calamity.Client.Types

Methods

showsPrec :: Int -> GuildCreateStatus -> ShowS

show :: GuildCreateStatus -> String

showList :: [GuildCreateStatus] -> ShowS

Generic GuildCreateStatus

Defined in Calamity.Client.Types

Associated Types

type Rep GuildCreateStatus :: Type -> Type

Methods

from :: GuildCreateStatus -> Rep GuildCreateStatus x

to :: Rep GuildCreateStatus x -> GuildCreateStatus

TextShow GuildCreateStatus

Defined in Calamity.Client.Types

Methods

showbPrec :: Int -> GuildCreateStatus -> Builder

showb :: GuildCreateStatus -> Builder

showbList :: [GuildCreateStatus] -> Builder

showtPrec :: Int -> GuildCreateStatus -> Text

showt :: GuildCreateStatus -> Text

showtList :: [GuildCreateStatus] -> Text

showtlPrec :: Int -> GuildCreateStatus -> Text

showtl :: GuildCreateStatus -> Text

showtlList :: [GuildCreateStatus] -> Text

type Rep GuildCreateStatus

Defined in Calamity.Client.Types

type Rep GuildCreateStatus = D1 ('MetaData "GuildCreateStatus" "Calamity.Client.Types" "calamity-0.1.12.0-inplace" 'False) (C1 ('MetaCons "GuildCreateNew" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GuildCreateAvailable" 'PrefixI 'False) (U1 :: Type -> Type))

data GuildDeleteStatus

Constructors

GuildDeleteUnavailable

The guild became unavailable

GuildDeleteRemoved

The bot was removed from the guild

Instances

Show GuildDeleteStatus

Defined in Calamity.Client.Types

Methods

showsPrec :: Int -> GuildDeleteStatus -> ShowS

show :: GuildDeleteStatus -> String

showList :: [GuildDeleteStatus] -> ShowS

Generic GuildDeleteStatus

Defined in Calamity.Client.Types

Associated Types

type Rep GuildDeleteStatus :: Type -> Type

Methods

from :: GuildDeleteStatus -> Rep GuildDeleteStatus x

to :: Rep GuildDeleteStatus x -> GuildDeleteStatus

TextShow GuildDeleteStatus

Defined in Calamity.Client.Types

Methods

showbPrec :: Int -> GuildDeleteStatus -> Builder

showb :: GuildDeleteStatus -> Builder

showbList :: [GuildDeleteStatus] -> Builder

showtPrec :: Int -> GuildDeleteStatus -> Text

showt :: GuildDeleteStatus -> Text

showtList :: [GuildDeleteStatus] -> Text

showtlPrec :: Int -> GuildDeleteStatus -> Text

showtl :: GuildDeleteStatus -> Text

showtlList :: [GuildDeleteStatus] -> Text

type Rep GuildDeleteStatus

Defined in Calamity.Client.Types

type Rep GuildDeleteStatus = D1 ('MetaData "GuildDeleteStatus" "Calamity.Client.Types" "calamity-0.1.12.0-inplace" 'False) (C1 ('MetaCons "GuildDeleteUnavailable" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GuildDeleteRemoved" 'PrefixI 'False) (U1 :: Type -> Type))

type family EHType (d :: EventType) m r where ...

A type family to decide what the parameters for an event handler should be determined by the type of event it is handling.

Equations

EHType 'ReadyEvt m r = ReadyData -> m r

EHType 'ChannelCreateEvt m r = Channel -> m r

EHType 'ChannelUpdateEvt m r = Channel -> Channel -> m r

EHType 'ChannelDeleteEvt m r = Channel -> m r

EHType 'ChannelpinsUpdateEvt m r = Channel -> Maybe UTCTime -> m r

EHType 'GuildCreateEvt m r = Guild -> GuildCreateStatus -> m r

EHType 'GuildUpdateEvt m r = Guild -> Guild -> m r

EHType 'GuildDeleteEvt m r = Guild -> GuildDeleteStatus -> m r

EHType 'GuildBanAddEvt m r = Guild -> User -> m r

EHType 'GuildBanRemoveEvt m r = Guild -> User -> m r

EHType 'GuildEmojisUpdateEvt m r = Guild -> [Emoji] -> m r

EHType 'GuildIntegrationsUpdateEvt m r = Guild -> m r

EHType 'GuildMemberAddEvt m r = Member -> m r

EHType 'GuildMemberRemoveEvt m r = Member -> m r

EHType 'GuildMemberUpdateEvt m r = Member -> Member -> m r

EHType 'GuildMembersChunkEvt m r = Guild -> [Member] -> m r

EHType 'GuildRoleCreateEvt m r = Guild -> Role -> m r

EHType 'GuildRoleUpdateEvt m r = Guild -> Role -> Role -> m r

EHType 'GuildRoleDeleteEvt m r = Guild -> Role -> m r

EHType 'InviteCreateEvt m r = InviteCreateData -> m r

EHType 'InviteDeleteEvt m r = InviteDeleteData -> m r

EHType 'MessageCreateEvt m r = Message -> m r

EHType 'MessageUpdateEvt m r = Message -> Message -> m r

EHType 'MessageDeleteEvt m r = Message -> m r

EHType 'MessageDeleteBulkEvt m r = [Message] -> m r

EHType 'MessageReactionAddEvt m r = Message -> Reaction -> m r

EHType 'MessageReactionRemoveEvt m r = Message -> Reaction -> m r

EHType 'MessageReactionRemoveAllEvt m r = Message -> m r

EHType 'TypingStartEvt m r = Channel -> Snowflake User -> UnixTimestamp -> m r

EHType 'UserUpdateEvt m r = User -> User -> m r

EHType ('CustomEvt s a) m r = a -> m r

type BotC r = (Members '[LogEff, MetricEff, CacheEff, Reader Client, AtomicState EventHandlers, Embed IO, Final IO, Async] r, Typeable r)

type SetupEff r = LogEff ': (Reader Client ': (AtomicState EventHandlers ': (Async ': r)))

A concrete effect stack used inside the bot

type ReactConstraints r s eh ehIO t = (InsertEventHandler s, RemoveEventHandler s, eh ~ EHType s (Sem r) (), ehIO ~ EHType s IO (), Uncurry eh, Uncurried eh ~ (t -> Sem r ()), Curry (t -> IO ()), ehIO ~ Curried (t -> IO ()))

Some constraints that react needs to work. Don't worry about these since they are satisfied for any type s can be

type WaitUntilConstraints r s eh check t = (InsertEventHandler s, RemoveEventHandler s, Uncurry eh, eh ~ EHType s (Sem r) (), eh ~ Curried (t -> Sem r ()), Uncurry check, Uncurried check ~ (t -> Bool), Curry (t -> IO ()), Curried (t -> IO ()) ~ EHType s IO ())

Some constraints that waitUntil needs to work. Don't worry about these since they are satisfied for any type s can be

type WaitUntilMConstraints r s eh ehB t = (InsertEventHandler s, RemoveEventHandler s, Uncurry eh, eh ~ EHType s (Sem r) (), eh ~ Curried (t -> Sem r ()), Uncurry ehB, Uncurried ehB ~ (t -> Sem r Bool), Curry (t -> IO ()), Curried (t -> IO ()) ~ EHType s IO ())

Some constraints that waitUntilM needs to work. Don't worry about these since they are satisfied for any type s can be

newtype EventHandlers

Constructors

EventHandlers (TypeRepMap EventHandler)

Instances

Semigroup EventHandlers

Defined in Calamity.Client.Types

Methods

(<>) :: EventHandlers -> EventHandlers -> EventHandlers

sconcat :: NonEmpty EventHandlers -> EventHandlers

stimes :: Integral b => b -> EventHandlers -> EventHandlers

Monoid EventHandlers

Defined in Calamity.Client.Types

Methods

mempty :: EventHandlers

mappend :: EventHandlers -> EventHandlers -> EventHandlers

mconcat :: [EventHandlers] -> EventHandlers

Default EventHandlers

Defined in Calamity.Client.Types

Methods

def :: EventHandlers

class InsertEventHandler a where

A helper typeclass that is used to decide how to register regular events, and custom events which require storing in a map at runtime.

Methods

makeEventHandlers :: Proxy a -> Integer -> StoredEHType a -> EventHandlers

Instances

(EHInstanceSelector a ~ flag, InsertEventHandler' flag a) => InsertEventHandler a

Defined in Calamity.Client.Types

Methods

makeEventHandlers :: Proxy a -> Integer -> StoredEHType a -> EventHandlers

class RemoveEventHandler a where

Methods

removeEventHandler :: Proxy a -> Integer -> EventHandlers -> EventHandlers

Instances

(EHInstanceSelector a ~ flag, RemoveEventHandler' flag a) => RemoveEventHandler (a :: EventType)

Defined in Calamity.Client.Types

Methods

removeEventHandler :: Proxy a -> Integer -> EventHandlers -> EventHandlers

getEventHandlers :: GetEventHandlers a => EventHandlers -> [StoredEHType a]

getCustomEventHandlers :: TypeRep -> TypeRep -> EventHandlers -> [Dynamic -> IO ()]