Safe Haskell	None
Language	Haskell2010

Calamity.Client.Types

Description

Types for the client

Synopsis

data Client = Client {
- shards :: TVar [(InChan ControlMessage, Async (Maybe ()))]
- numShards :: MVar Int
- token :: Token
- rlState :: RateLimitState
- eventsIn :: InChan CalamityEvent
- eventsOut :: OutChan CalamityEvent
- ehidCounter :: IORef Integer
- initialDi :: Maybe (Di Level Path Message)
}
newtype StartupError = StartupError String
data EventType
- = ReadyEvt
- | ChannelCreateEvt
- | ChannelUpdateEvt
- | ChannelDeleteEvt
- | ChannelpinsUpdateEvt
- | GuildCreateEvt
- | GuildUpdateEvt
- | GuildDeleteEvt
- | GuildBanAddEvt
- | GuildBanRemoveEvt
- | GuildEmojisUpdateEvt
- | GuildIntegrationsUpdateEvt
- | GuildMemberAddEvt
- | GuildMemberRemoveEvt
- | GuildMemberUpdateEvt
- | GuildMembersChunkEvt
- | GuildRoleCreateEvt
- | GuildRoleUpdateEvt
- | GuildRoleDeleteEvt
- | InviteCreateEvt
- | InviteDeleteEvt
- | MessageCreateEvt
- | MessageUpdateEvt
- | RawMessageUpdateEvt
- | MessageDeleteEvt
- | RawMessageDeleteEvt
- | MessageDeleteBulkEvt
- | RawMessageDeleteBulkEvt
- | MessageReactionAddEvt
- | RawMessageReactionAddEvt
- | MessageReactionRemoveEvt
- | RawMessageReactionRemoveEvt
- | MessageReactionRemoveAllEvt
- | RawMessageReactionRemoveAllEvt
- | TypingStartEvt
- | UserUpdateEvt
- | VoiceStateUpdateEvt
- | InteractionEvt
- | forall (a :: Type). CustomEvt a
data GuildCreateStatus
- = GuildCreateNew
- | GuildCreateAvailable
data GuildDeleteStatus
- = GuildDeleteUnavailable
- | GuildDeleteRemoved
type family EHType (d :: EventType) where ...
type BotC r = Members '[LogEff, MetricEff, CacheEff, RatelimitEff, TokenEff, Reader Client, AtomicState EventHandlers, Embed IO, Final IO, Async] r
type SetupEff r = RatelimitEff ': (TokenEff ': (Reader Client ': (AtomicState EventHandlers ': (Async ': r))))
type ReactConstraints s = (InsertEventHandler s, RemoveEventHandler s)
newtype EventHandlers = EventHandlers (TypeRepMap EventHandler)
class InsertEventHandler (a :: EventType) where
- makeEventHandlers :: Proxy a -> Integer -> StoredEHType a -> EventHandlers
class RemoveEventHandler a where
- removeEventHandler :: Proxy a -> Integer -> EventHandlers -> EventHandlers
getEventHandlers :: GetEventHandlers a => EventHandlers -> [StoredEHType a]
getCustomEventHandlers :: forall a. Typeable a => EventHandlers -> [a -> IO ()]

Documentation

data Client Source #

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 initialDi :: Maybe (Di Level Path Message)

Instances

Instances details

Generic Client Source #
Instance details 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 Source #
Instance details Defined in Calamity.Client.Types type Rep Client = D1 ('MetaData "Client" "Calamity.Client.Types" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "Client" 'PrefixI 'True) (((S1 ('MetaSel ('Just "shards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TVar [(InChan ControlMessage, Async (Maybe ()))])) :: S1 ('MetaSel ('Just "numShards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (MVar Int))) :: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Token) :: S1 ('MetaSel ('Just "rlState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RateLimitState))) :: ((S1 ('MetaSel ('Just "eventsIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (InChan CalamityEvent)) :: S1 ('MetaSel ('Just "eventsOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (OutChan CalamityEvent))) :: (S1 ('MetaSel ('Just "ehidCounter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (IORef Integer)) :*: S1 ('MetaSel ('Just "initialDi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Di Level Path Message)))))))

newtype StartupError Source #

Constructors

StartupError String

Instances

Instances details

Show StartupError Source #
Instance details Defined in Calamity.Client.Types Methods showsPrec :: Int -> StartupError -> ShowS # show :: StartupError -> String # showList :: [StartupError] -> ShowS #

data EventType Source #

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	Fired when a cached message is updated, use `RawMessageUpdateEvt` to see updates of uncached messages
RawMessageUpdateEvt	Fired when a message is updated
MessageDeleteEvt	Fired when a cached message is deleted, use `RawMessageDeleteEvt` to see deletes of uncached messages. Does not include messages deleted through bulk deletes, use `MessageDeleteBulkEvt` for those
RawMessageDeleteEvt	Fired when a message is deleted. Does not include messages deleted through bulk deletes, use `RawMessageDeleteBulkEvt` for those
MessageDeleteBulkEvt	Fired when messages are bulk deleted. Only includes cached messages, use `RawMessageDeleteBulkEvt` to see deletes of uncached messages.
RawMessageDeleteBulkEvt	Fired when messages are bulk deleted.
MessageReactionAddEvt	Fired when a reaction is added to a cached message, use `RawMessageReactionAddEvt` to see reactions on uncached messages.
RawMessageReactionAddEvt	Fired when a reaction is added to a message.
MessageReactionRemoveEvt	Fired when a reaction is removed from a cached message, use `RawMessageReactionRemoveEvt` to see reactions on uncached messages.
RawMessageReactionRemoveEvt	Fired when a reaction is removed from a message.
MessageReactionRemoveAllEvt	Fired when all reactions are removed from a cached message, use `RawMessageReactionRemoveEvt` to see reactions on uncached messages. The message passed will contain the removed events.
RawMessageReactionRemoveAllEvt	Fired when all reactions are removed from a message.
TypingStartEvt
UserUpdateEvt
VoiceStateUpdateEvt	Sent when someone joinsleavesmoves voice channels
InteractionEvt	Fired when the bot receives an interaction
forall (a :: Type). CustomEvt a	A custom event, `a` is the data sent to the handler and should probably be a newtype to disambiguate events

Instances

Instances details

(EHInstanceSelector a ~ flag, RemoveEventHandler' flag a) => RemoveEventHandler (a :: EventType) Source #
Instance details Defined in Calamity.Client.Types Methods removeEventHandler :: Proxy a -> Integer -> EventHandlers -> EventHandlers Source #

data GuildCreateStatus Source #

Constructors

GuildCreateNew	The guild was just joined
GuildCreateAvailable	The guild is becoming available

Instances

Instances details

Show GuildCreateStatus Source #
Instance details Defined in Calamity.Client.Types Methods showsPrec :: Int -> GuildCreateStatus -> ShowS # show :: GuildCreateStatus -> String # showList :: [GuildCreateStatus] -> ShowS #
Generic GuildCreateStatus Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details Defined in Calamity.Client.Types type Rep GuildCreateStatus = D1 ('MetaData "GuildCreateStatus" "Calamity.Client.Types" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "GuildCreateNew" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GuildCreateAvailable" 'PrefixI 'False) (U1 :: Type -> Type))

data GuildDeleteStatus Source #

Constructors

GuildDeleteUnavailable	The guild became unavailable
GuildDeleteRemoved	The bot was removed from the guild

Instances

Instances details

Show GuildDeleteStatus Source #
Instance details Defined in Calamity.Client.Types Methods showsPrec :: Int -> GuildDeleteStatus -> ShowS # show :: GuildDeleteStatus -> String # showList :: [GuildDeleteStatus] -> ShowS #
Generic GuildDeleteStatus Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details Defined in Calamity.Client.Types type Rep GuildDeleteStatus = D1 ('MetaData "GuildDeleteStatus" "Calamity.Client.Types" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "GuildDeleteUnavailable" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GuildDeleteRemoved" 'PrefixI 'False) (U1 :: Type -> Type))

type family EHType (d :: EventType) where ... Source #

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 = ReadyData
EHType 'ChannelCreateEvt = Channel
EHType 'ChannelUpdateEvt = (Channel, Channel)
EHType 'ChannelDeleteEvt = Channel
EHType 'ChannelpinsUpdateEvt = (Channel, Maybe UTCTime)
EHType 'GuildCreateEvt = (Guild, GuildCreateStatus)
EHType 'GuildUpdateEvt = (Guild, Guild)
EHType 'GuildDeleteEvt = (Guild, GuildDeleteStatus)
EHType 'GuildBanAddEvt = (Guild, User)
EHType 'GuildBanRemoveEvt = (Guild, User)
EHType 'GuildEmojisUpdateEvt = (Guild, [Emoji])
EHType 'GuildIntegrationsUpdateEvt = Guild
EHType 'GuildMemberAddEvt = Member
EHType 'GuildMemberRemoveEvt = Member
EHType 'GuildMemberUpdateEvt = (Member, Member)
EHType 'GuildMembersChunkEvt = (Guild, [Member])
EHType 'GuildRoleCreateEvt = (Guild, Role)
EHType 'GuildRoleUpdateEvt = (Guild, Role, Role)
EHType 'GuildRoleDeleteEvt = (Guild, Role)
EHType 'InviteCreateEvt = InviteCreateData
EHType 'InviteDeleteEvt = InviteDeleteData
EHType 'MessageCreateEvt = (Message, Maybe User, Maybe Member)
EHType 'MessageUpdateEvt = (Message, Message, Maybe User, Maybe Member)
EHType 'MessageDeleteEvt = Message
EHType 'MessageDeleteBulkEvt = [Message]
EHType 'MessageReactionAddEvt = (Message, User, Channel, RawEmoji)
EHType 'MessageReactionRemoveEvt = (Message, User, Channel, RawEmoji)
EHType 'MessageReactionRemoveAllEvt = Message
EHType 'RawMessageUpdateEvt = (UpdatedMessage, Maybe User, Maybe Member)
EHType 'RawMessageDeleteEvt = Snowflake Message
EHType 'RawMessageDeleteBulkEvt = [Snowflake Message]
EHType 'RawMessageReactionAddEvt = ReactionEvtData
EHType 'RawMessageReactionRemoveEvt = ReactionEvtData
EHType 'RawMessageReactionRemoveAllEvt = Snowflake Message
EHType 'TypingStartEvt = (Channel, Snowflake User, UTCTime)
EHType 'UserUpdateEvt = (User, User)
EHType 'VoiceStateUpdateEvt = (Maybe VoiceState, VoiceState)
EHType 'InteractionEvt = Interaction
EHType ('CustomEvt a) = a

type BotC r = Members '[LogEff, MetricEff, CacheEff, RatelimitEff, TokenEff, Reader Client, AtomicState EventHandlers, Embed IO, Final IO, Async] r Source #

Constraints required by the bot client

type SetupEff r = RatelimitEff ': (TokenEff ': (Reader Client ': (AtomicState EventHandlers ': (Async ': r)))) Source #

A concrete effect stack used inside the bot

type ReactConstraints s = (InsertEventHandler s, RemoveEventHandler s) Source #

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

newtype EventHandlers Source #

Constructors

EventHandlers (TypeRepMap EventHandler)

Instances

Instances details

Semigroup EventHandlers Source #
Instance details Defined in Calamity.Client.Types Methods (<>) :: EventHandlers -> EventHandlers -> EventHandlers # sconcat :: NonEmpty EventHandlers -> EventHandlers # stimes :: Integral b => b -> EventHandlers -> EventHandlers #
Monoid EventHandlers Source #
Instance details Defined in Calamity.Client.Types Methods mempty :: EventHandlers # mappend :: EventHandlers -> EventHandlers -> EventHandlers # mconcat :: [EventHandlers] -> EventHandlers #
Default EventHandlers Source #
Instance details Defined in Calamity.Client.Types Methods def :: EventHandlers #

class InsertEventHandler (a :: EventType) where Source #

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 Source #

Instances

Instances details

(EHInstanceSelector a ~ flag, InsertEventHandler' flag a) => InsertEventHandler a Source #
Instance details Defined in Calamity.Client.Types Methods makeEventHandlers :: Proxy a -> Integer -> StoredEHType a -> EventHandlers Source #

class RemoveEventHandler a where Source #

Methods

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

Instances

Instances details

(EHInstanceSelector a ~ flag, RemoveEventHandler' flag a) => RemoveEventHandler (a :: EventType) Source #
Instance details Defined in Calamity.Client.Types Methods removeEventHandler :: Proxy a -> Integer -> EventHandlers -> EventHandlers Source #

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

getCustomEventHandlers :: forall a. Typeable a => EventHandlers -> [a -> IO ()] Source #