calamity-0.3.0.0: A library for writing discord bots in haskell
Safe HaskellNone
LanguageHaskell2010

Calamity.HTTP

Contents

Description

Combined http request stuff

Synopsis

Documentation

invoke :: (Members '[RatelimitEff, TokenEff, LogEff, MetricEff, Embed IO] r, Request a, ReadResponse (Result a)) => a -> Sem r (Either RestError (Result a)) Source #

module Calamity.HTTP.AuditLog

module Calamity.HTTP.Channel

module Calamity.HTTP.Emoji

module Calamity.HTTP.Guild

module Calamity.HTTP.Invite

module Calamity.HTTP.Interaction

module Calamity.HTTP.MiscRoutes

module Calamity.HTTP.User

module Calamity.HTTP.Reason

module Calamity.HTTP.Webhook

data RestError Source #

Instances

Instances details
Show RestError Source # 
Instance details

Defined in Calamity.HTTP.Internal.Types

Methods

showsPrec :: Int -> RestError -> ShowS #

show :: RestError -> String #

showList :: [RestError] -> ShowS #

Generic RestError Source # 
Instance details

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

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 RatelimitEff m a where Source #

Constructors

GetRatelimitState :: RatelimitEff m RateLimitState 

data TokenEff m a where Source #

Constructors

GetBotToken :: TokenEff m Token 

HTTP

This module contains all the http related things

Registered Metrics

  1. Gauge: "inflight_requests" [route]

    Keeps track of how many requests are currently in-flight, the route parameter will be the route that is currently active.

  1. Counter: "total_requests" [route]

    Incremented on every request, the route parameter is the route that the request was made on.

Examples

Editing a message:

invoke $ EditMessage someChannel someMessage (Just "new content") Nothing