Safe Haskell	Safe-Inferred
Language	Haskell2010

Calamity.HTTP.Internal.Route

Description

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

Synopsis

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
data Route
newtype S = S Text
data PS (s :: Symbol) = PS
data ID a = ID
class Typeable a => RouteFragmentable a reqs where
- type ConsRes a reqs
- (//) :: RouteBuilder reqs -> a -> ConsRes a reqs

Documentation

mkRouteBuilder :: RouteBuilder '[] Source #

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

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

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

routeKey :: Route -> RouteKey Source #

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

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

data RouteRequirement Source #

Instances

Instances details

Show RouteRequirement Source #
Instance details Defined in Calamity.HTTP.Internal.Route Methods showsPrec :: Int -> RouteRequirement -> ShowS # show :: RouteRequirement -> String # showList :: [RouteRequirement] -> ShowS #
Eq RouteRequirement Source #
Instance details Defined in Calamity.HTTP.Internal.Route Methods (==) :: RouteRequirement -> RouteRequirement -> Bool # (/=) :: RouteRequirement -> RouteRequirement -> Bool #

data Route Source #

Instances

Instances details

Show Route Source #
Instance details Defined in Calamity.HTTP.Internal.Route Methods showsPrec :: Int -> Route -> ShowS # show :: Route -> String # showList :: [Route] -> ShowS #
(k ~ A_Lens, a ~ Maybe (Snowflake Channel), b ~ Maybe (Snowflake Channel)) => LabelOptic "channelID" k Route Route a b Source #
Instance details Defined in Calamity.HTTP.Internal.Route Methods labelOptic :: Optic k NoIx Route Route a b #
(k ~ A_Lens, a ~ Maybe (Snowflake Guild), b ~ Maybe (Snowflake Guild)) => LabelOptic "guildID" k Route Route a b Source #
Instance details Defined in Calamity.HTTP.Internal.Route Methods labelOptic :: Optic k NoIx Route Route a b #
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "key" k Route Route a b Source #
Instance details Defined in Calamity.HTTP.Internal.Route Methods labelOptic :: Optic k NoIx Route Route a b #
(k ~ A_Lens, a ~ Url 'Https, b ~ Url 'Https) => LabelOptic "path" k Route Route a b Source #
Instance details Defined in Calamity.HTTP.Internal.Route Methods labelOptic :: Optic k NoIx Route Route a b #

newtype S Source #

A static string fragment of a route

Constructors

S Text

Instances

Instances details

RouteFragmentable S reqs Source #
Instance details Defined in Calamity.HTTP.Internal.Route Associated Types type ConsRes S reqs Source # Methods (//) :: RouteBuilder reqs -> S -> ConsRes S reqs Source #
type ConsRes S reqs Source #
Instance details Defined in Calamity.HTTP.Internal.Route type ConsRes S reqs = RouteBuilder reqs

data PS (s :: Symbol) Source #

A parameterised string fragment of a route

Constructors

PS

Instances

Instances details

KnownSymbol s => RouteFragmentable (PS s) reqs Source #
Instance details Defined in Calamity.HTTP.Internal.Route Associated Types type ConsRes (PS s) reqs Source # Methods (//) :: RouteBuilder reqs -> PS s -> ConsRes (PS s) reqs Source #
type ConsRes (PS s) reqs Source #
Instance details Defined in Calamity.HTTP.Internal.Route type ConsRes (PS s) reqs

data ID a Source #

An id fragment of a route

Constructors

ID

Instances

Instances details

Typeable a => RouteFragmentable (ID a) reqs Source #
Instance details Defined in Calamity.HTTP.Internal.Route Associated Types type ConsRes (ID a) reqs Source # Methods (//) :: RouteBuilder reqs -> ID a -> ConsRes (ID a) reqs Source #
type ConsRes (ID a) reqs Source #
Instance details Defined in Calamity.HTTP.Internal.Route type ConsRes (ID a) reqs

class Typeable a => RouteFragmentable a reqs where Source #

Associated Types

type ConsRes a reqs Source #

Methods

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

Instances

Instances details

RouteFragmentable S reqs Source #
Instance details Defined in Calamity.HTTP.Internal.Route Associated Types type ConsRes S reqs Source # Methods (//) :: RouteBuilder reqs -> S -> ConsRes S reqs Source #
KnownSymbol s => RouteFragmentable (PS s) reqs Source #
Instance details Defined in Calamity.HTTP.Internal.Route Associated Types type ConsRes (PS s) reqs Source # Methods (//) :: RouteBuilder reqs -> PS s -> ConsRes (PS s) reqs Source #
Typeable a => RouteFragmentable (ID a) reqs Source #
Instance details Defined in Calamity.HTTP.Internal.Route Associated Types type ConsRes (ID a) reqs Source # Methods (//) :: RouteBuilder reqs -> ID a -> ConsRes (ID a) reqs Source #