Safe Haskell	None
Language	Haskell2010

Discord.Internal.Rest

Description

Provides a higher level interface to the rest functions. Preperly writes to the rate-limit loop. Creates separate MVars for each call

Synopsis

module Discord.Internal.Types
data RestChanHandle = RestChanHandle {
- restHandleChan :: Chan (String, JsonRequest, MVar (Either RestCallInternalException ByteString))
}
class Request a where
- majorRoute :: a -> String
- jsonRequest :: a -> JsonRequest
writeRestCall :: (Request (r a), FromJSON a) => RestChanHandle -> r a -> IO (Either RestCallInternalException a)
startRestThread :: Auth -> Chan Text -> IO (RestChanHandle, ThreadId)
data RestCallInternalException

Documentation

module Discord.Internal.Types

data RestChanHandle Source #

Constructors

RestChanHandle
Fields restHandleChan :: Chan (String, JsonRequest, MVar (Either RestCallInternalException ByteString))

class Request a where Source #

Methods

majorRoute :: a -> String Source #

used for putting a request into a rate limit bucket https://discord.com/developers/docs/topics/rate-limits#rate-limits

jsonRequest :: a -> JsonRequest Source #

build a JSON http request

Instances

Instances details

Request (WebhookRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods majorRoute :: WebhookRequest a -> String Source # jsonRequest :: WebhookRequest a -> JsonRequest Source #
Request (VoiceRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Voice Methods majorRoute :: VoiceRequest a -> String Source # jsonRequest :: VoiceRequest a -> JsonRequest Source #
Request (UserRequest a) Source #
Instance details Defined in Discord.Internal.Rest.User Methods majorRoute :: UserRequest a -> String Source # jsonRequest :: UserRequest a -> JsonRequest Source #
Request (InviteRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Invite Methods majorRoute :: InviteRequest a -> String Source # jsonRequest :: InviteRequest a -> JsonRequest Source #
Request (InteractionResponseRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Interactions Methods majorRoute :: InteractionResponseRequest a -> String Source # jsonRequest :: InteractionResponseRequest a -> JsonRequest Source #
Request (GuildRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Guild Methods majorRoute :: GuildRequest a -> String Source # jsonRequest :: GuildRequest a -> JsonRequest Source #
Request (EmojiRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Emoji Methods majorRoute :: EmojiRequest a -> String Source # jsonRequest :: EmojiRequest a -> JsonRequest Source #
Request (ChannelRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Channel Methods majorRoute :: ChannelRequest a -> String Source # jsonRequest :: ChannelRequest a -> JsonRequest Source #
Request (ApplicationCommandRequest a) Source #
Instance details Defined in Discord.Internal.Rest.ApplicationCommands Methods majorRoute :: ApplicationCommandRequest a -> String Source # jsonRequest :: ApplicationCommandRequest a -> JsonRequest Source #

writeRestCall :: (Request (r a), FromJSON a) => RestChanHandle -> r a -> IO (Either RestCallInternalException a) Source #

Execute a request blocking until a response is received

startRestThread :: Auth -> Chan Text -> IO (RestChanHandle, ThreadId) Source #

Starts the http request thread. Please only call this once

data RestCallInternalException Source #

Constructors

RestCallInternalErrorCode Int ByteString ByteString
RestCallInternalNoParse String ByteString
RestCallInternalHttpException HttpException

Instances

Instances details

Show RestCallInternalException Source #
Instance details Defined in Discord.Internal.Rest.HTTP Methods showsPrec :: Int -> RestCallInternalException -> ShowS # show :: RestCallInternalException -> String # showList :: [RestCallInternalException] -> ShowS #