Calamity.HTTP.Internal.Route

The route type Why I did this I don't know

Documentation

mkRouteBuilder :: RouteBuilder '[]

giveID :: forall t reqs. Typeable t => Snowflake t -> RouteBuilder reqs -> RouteBuilder ('('IDRequirement t, 'Satisfied) ': reqs)

giveParam :: forall (s :: Symbol) reqs. KnownSymbol s => Text -> RouteBuilder reqs -> RouteBuilder ('('PSRequirement s, 'Satisfied) ': reqs)

buildRoute :: forall (reqs :: [(RequirementType, RouteRequirement)]). EnsureFulfilled reqs => RouteBuilder reqs -> Route

routeKey :: Route -> RouteKey

type RouteKey = (Text, Maybe (Snowflake Channel), Maybe (Snowflake Guild))

data RouteBuilder (reqstate :: [(RequirementType, RouteRequirement)])

data RouteRequirement

Instances

Eq RouteRequirement

Defined in Calamity.HTTP.Internal.Route

Methods

(==) :: RouteRequirement -> RouteRequirement -> Bool

(/=) :: RouteRequirement -> RouteRequirement -> Bool

Show RouteRequirement

Defined in Calamity.HTTP.Internal.Route

Methods

showsPrec :: Int -> RouteRequirement -> ShowS

show :: RouteRequirement -> String

showList :: [RouteRequirement] -> ShowS

Generic RouteRequirement

Defined in Calamity.HTTP.Internal.Route

Associated Types

type Rep RouteRequirement :: Type -> Type

Methods

from :: RouteRequirement -> Rep RouteRequirement x

to :: Rep RouteRequirement x -> RouteRequirement

type Rep RouteRequirement

Defined in Calamity.HTTP.Internal.Route

type Rep RouteRequirement = D1 ('MetaData "RouteRequirement" "Calamity.HTTP.Internal.Route" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "NotNeeded" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Required" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Satisfied" 'PrefixI 'False) (U1 :: Type -> Type)))

data Route

Instances

Show Route

Defined in Calamity.HTTP.Internal.Route

Methods

showsPrec :: Int -> Route -> ShowS

show :: Route -> String

showList :: [Route] -> ShowS

Generic Route

Defined in Calamity.HTTP.Internal.Route

Associated Types

type Rep Route :: Type -> Type

Methods

from :: Route -> Rep Route x

to :: Rep Route x -> Route

type Rep Route

Defined in Calamity.HTTP.Internal.Route

type Rep Route = D1 ('MetaData "Route" "Calamity.HTTP.Internal.Route" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "Route" 'PrefixI 'True) ((S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Url 'Https)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "channelID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Snowflake Channel))) :*: S1 ('MetaSel ('Just "guildID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Snowflake Guild))))))

newtype S

A static string fragment of a route

Constructors

S Text

Instances

RouteFragmentable S reqs

Defined in Calamity.HTTP.Internal.Route

Associated Types

type ConsRes S reqs

Methods

(//) :: RouteBuilder reqs -> S -> ConsRes S reqs

type ConsRes S reqs

Defined in Calamity.HTTP.Internal.Route

type ConsRes S reqs = RouteBuilder reqs

data PS (s :: Symbol)

A parameterised string fragment of a route

Constructors

PS

Instances

KnownSymbol s => RouteFragmentable (PS s) reqs

Defined in Calamity.HTTP.Internal.Route

Associated Types

type ConsRes (PS s) reqs

Methods

(//) :: RouteBuilder reqs -> PS s -> ConsRes (PS s) reqs

type ConsRes (PS s) reqs

Defined in Calamity.HTTP.Internal.Route

type ConsRes (PS s) reqs

data ID a

An id fragment of a route

Constructors

ID

Instances

Typeable a => RouteFragmentable (ID a) reqs

Defined in Calamity.HTTP.Internal.Route

Associated Types

type ConsRes (ID a) reqs

Methods

(//) :: RouteBuilder reqs -> ID a -> ConsRes (ID a) reqs

type ConsRes (ID a) reqs

Defined in Calamity.HTTP.Internal.Route

type ConsRes (ID a) reqs

class Typeable a => RouteFragmentable a reqs where

Associated Types

type ConsRes a reqs

Methods

(//) :: RouteBuilder reqs -> a -> ConsRes a reqs infixl 5

Instances

RouteFragmentable S reqs

Defined in Calamity.HTTP.Internal.Route

Associated Types

type ConsRes S reqs

Methods

(//) :: RouteBuilder reqs -> S -> ConsRes S reqs

KnownSymbol s => RouteFragmentable (PS s) reqs

Defined in Calamity.HTTP.Internal.Route

Associated Types

type ConsRes (PS s) reqs

Methods

(//) :: RouteBuilder reqs -> PS s -> ConsRes (PS s) reqs

Typeable a => RouteFragmentable (ID a) reqs

Defined in Calamity.HTTP.Internal.Route

Associated Types

type ConsRes (ID a) reqs

Methods

(//) :: RouteBuilder reqs -> ID a -> ConsRes (ID a) reqs