Safe Haskell	Safe-Inferred
Language	Haskell2010

Calamity.HTTP.Internal.Types

Description

Types for the http lib

Documentation

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 details

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

Constructors

RateLimitState
Fields bucketKeys :: Map RouteKey ByteString buckets :: Map ByteString Bucket globalLock :: Event

Instances details

(k ~ A_Lens, a ~ Map RouteKey ByteString, b ~ Map RouteKey ByteString) => LabelOptic "bucketKeys" k RateLimitState RateLimitState a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx RateLimitState RateLimitState a b #
(k ~ A_Lens, a ~ Map ByteString Bucket, b ~ Map ByteString Bucket) => LabelOptic "buckets" k RateLimitState RateLimitState a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx RateLimitState RateLimitState a b #
(k ~ A_Lens, a ~ Event, b ~ Event) => LabelOptic "globalLock" k RateLimitState RateLimitState a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx RateLimitState RateLimitState a b #

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

Constructors

Bucket
Fields state :: TVar BucketState

Instances details

(k ~ An_Iso, a ~ TVar BucketState, b ~ TVar BucketState) => LabelOptic "state" k Bucket Bucket a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx Bucket Bucket a b #

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 details

Show BucketState Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods showsPrec :: Int -> BucketState -> ShowS # show :: BucketState -> String # showList :: [BucketState] -> ShowS #
(k ~ A_Lens, a ~ Int, b ~ Int) => LabelOptic "limit" k BucketState BucketState a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx BucketState BucketState a b #
(k ~ A_Lens, a ~ Int, b ~ Int) => LabelOptic "ongoing" k BucketState BucketState a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx BucketState BucketState a b #
(k ~ A_Lens, a ~ Int, b ~ Int) => LabelOptic "remaining" k BucketState BucketState a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx BucketState BucketState a b #
(k ~ A_Lens, a ~ Int, b ~ Int) => LabelOptic "resetKey" k BucketState BucketState a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx BucketState BucketState a b #
(k ~ A_Lens, a ~ Maybe UTCTime, b ~ Maybe UTCTime) => LabelOptic "resetTime" k BucketState BucketState a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx BucketState BucketState a b #

Instances details

FromJSON GatewayResponse Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods parseJSON :: Value -> Parser GatewayResponse # parseJSONList :: Value -> Parser [GatewayResponse] #
Show GatewayResponse Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods showsPrec :: Int -> GatewayResponse -> ShowS # show :: GatewayResponse -> String # showList :: [GatewayResponse] -> ShowS #
(k ~ An_Iso, a ~ Text, b ~ Text) => LabelOptic "url" k GatewayResponse GatewayResponse a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx GatewayResponse GatewayResponse a b #

Instances details

FromJSON BotGatewayResponse Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods parseJSON :: Value -> Parser BotGatewayResponse # parseJSONList :: Value -> Parser [BotGatewayResponse] #
Show BotGatewayResponse Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods showsPrec :: Int -> BotGatewayResponse -> ShowS # show :: BotGatewayResponse -> String # showList :: [BotGatewayResponse] -> ShowS #
(k ~ A_Lens, a ~ Int, b ~ Int) => LabelOptic "shards" k BotGatewayResponse BotGatewayResponse a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx BotGatewayResponse BotGatewayResponse a b #
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "url" k BotGatewayResponse BotGatewayResponse a b Source #
Instance details Defined in Calamity.HTTP.Internal.Types Methods labelOptic :: Optic k NoIx BotGatewayResponse BotGatewayResponse a b #