Calamity.HTTP.Internal.Types

Types for the http lib

Documentation

data RestError

Constructors

HTTPError

An error response from discord

Fields

• status :: Int
• response :: Maybe Value

InternalClientError Text

Something failed while making the request (after retrying a few times)

Instances

Show RestError

Defined in Calamity.HTTP.Internal.Types

Methods

showsPrec :: Int -> RestError -> ShowS

show :: RestError -> String

showList :: [RestError] -> ShowS

Generic RestError

Defined in Calamity.HTTP.Internal.Types

Associated Types

type Rep RestError :: Type -> Type

Methods

from :: RestError -> Rep RestError x

to :: Rep RestError x -> RestError

type Rep RestError

Defined in Calamity.HTTP.Internal.Types

type Rep RestError = D1 ('MetaData "RestError" "Calamity.HTTP.Internal.Types" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "HTTPError" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "response") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Value))) :+: C1 ('MetaCons "InternalClientError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

data RateLimitState

Constructors

RateLimitState

Fields

• bucketKeys :: Map RouteKey ByteString
• buckets :: Map ByteString Bucket
• globalLock :: Event

Instances

Generic RateLimitState

Defined in Calamity.HTTP.Internal.Types

Associated Types

type Rep RateLimitState :: Type -> Type

Methods

from :: RateLimitState -> Rep RateLimitState x

to :: Rep RateLimitState x -> RateLimitState

type Rep RateLimitState

Defined in Calamity.HTTP.Internal.Types

type Rep RateLimitState = D1 ('MetaData "RateLimitState" "Calamity.HTTP.Internal.Types" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "RateLimitState" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucketKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map RouteKey ByteString)) :*: (S1 ('MetaSel ('Just "buckets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map ByteString Bucket)) :*: S1 ('MetaSel ('Just "globalLock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Event))))

data DiscordResponseType

Constructors

Good

A good response

Fields

• ByteString
• (Maybe (BucketState, ByteString))

  The ratelimit headers if we got them

Ratelimited

We hit a 429, no response and ratelimited

Fields

• UTCTime

  Retry after

• Bool

  Global ratelimit

• (Maybe (BucketState, ByteString))

ServerError Int

Discord's error, we should retry (HTTP 5XX)

ClientError Int ByteString

Our error, we should fail

InternalResponseError Text

Something went wrong with the http client

newtype Bucket

Constructors

Bucket

Fields

• state :: TVar BucketState

Instances

Generic Bucket

Defined in Calamity.HTTP.Internal.Types

Associated Types

type Rep Bucket :: Type -> Type

Methods

from :: Bucket -> Rep Bucket x

to :: Rep Bucket x -> Bucket

type Rep Bucket

Defined in Calamity.HTTP.Internal.Types

type Rep Bucket = D1 ('MetaData "Bucket" "Calamity.HTTP.Internal.Types" "calamity-0.3.0.0-inplace" 'True) (C1 ('MetaCons "Bucket" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TVar BucketState))))

data BucketState

Constructors

BucketState

Fields

• resetTime :: Maybe UTCTime

  The time when the bucket resets, used to heuristically wait out ratelimits

• resetKey :: Int

  The X-Ratelimit-Reset value discord gave us

• remaining :: Int

  The number of uses left in the bucket, used to heuristically wait out ratelimits

• limit :: Int

  The total number of uses for this bucket

• ongoing :: Int

  How many ongoing requests

Instances

Show BucketState

Defined in Calamity.HTTP.Internal.Types

Methods

showsPrec :: Int -> BucketState -> ShowS

show :: BucketState -> String

showList :: [BucketState] -> ShowS

Generic BucketState

Defined in Calamity.HTTP.Internal.Types

Associated Types

type Rep BucketState :: Type -> Type

Methods

from :: BucketState -> Rep BucketState x

to :: Rep BucketState x -> BucketState

type Rep BucketState

Defined in Calamity.HTTP.Internal.Types

type Rep BucketState = D1 ('MetaData "BucketState" "Calamity.HTTP.Internal.Types" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "BucketState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resetTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UTCTime)) :*: S1 ('MetaSel ('Just "resetKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "remaining") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "ongoing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

data GatewayResponse

Instances

Show GatewayResponse

Defined in Calamity.HTTP.Internal.Types

Methods

showsPrec :: Int -> GatewayResponse -> ShowS

show :: GatewayResponse -> String

showList :: [GatewayResponse] -> ShowS

Generic GatewayResponse

Defined in Calamity.HTTP.Internal.Types

Associated Types

type Rep GatewayResponse :: Type -> Type

Methods

from :: GatewayResponse -> Rep GatewayResponse x

to :: Rep GatewayResponse x -> GatewayResponse

FromJSON GatewayResponse

Defined in Calamity.HTTP.Internal.Types

Methods

parseJSON :: Value -> Parser GatewayResponse

parseJSONList :: Value -> Parser [GatewayResponse]

type Rep GatewayResponse

Defined in Calamity.HTTP.Internal.Types

type Rep GatewayResponse = D1 ('MetaData "GatewayResponse" "Calamity.HTTP.Internal.Types" "calamity-0.3.0.0-inplace" 'True) (C1 ('MetaCons "GatewayResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data BotGatewayResponse

Instances

Show BotGatewayResponse

Defined in Calamity.HTTP.Internal.Types

Methods

showsPrec :: Int -> BotGatewayResponse -> ShowS

show :: BotGatewayResponse -> String

showList :: [BotGatewayResponse] -> ShowS

Generic BotGatewayResponse

Defined in Calamity.HTTP.Internal.Types

Associated Types

type Rep BotGatewayResponse :: Type -> Type

Methods

from :: BotGatewayResponse -> Rep BotGatewayResponse x

to :: Rep BotGatewayResponse x -> BotGatewayResponse

FromJSON BotGatewayResponse

Defined in Calamity.HTTP.Internal.Types

Methods

parseJSON :: Value -> Parser BotGatewayResponse

parseJSONList :: Value -> Parser [BotGatewayResponse]

type Rep BotGatewayResponse

Defined in Calamity.HTTP.Internal.Types

type Rep BotGatewayResponse = D1 ('MetaData "BotGatewayResponse" "Calamity.HTTP.Internal.Types" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "BotGatewayResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "shards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))