Moduleservant-0.20.3.0Haskell2010

Servant.API.Modifiers

Contents

Required / optional argument
Lenient / strict parsing
Utilities

Synopsis

data Required
data Optional
type FoldRequired
family FoldRequired'
data Lenient
data Strict
type FoldLenient
family FoldLenient'
type RequiredArgument
value foldRequiredArgument
value unfoldRequiredArgument
type RequestArgument
value unfoldRequestArgument

Packageservant-0.20.3.0
Exports13
LanguageHaskell2010
LicenceBSD-3-Clause
SourceModifiers.hs

Required / optional argument

datadata Required

Source#

Required argument. Not wrapped.

datadata Optional

Source#

Optional argument. Wrapped in Maybe.

typetype FoldRequired (mods :: [Type]) = FoldRequired' 'False mods

Source#

Fold modifier list to decide whether argument is required.

Example1 expression

>>> :kind! FoldRequired '[Required, Description "something"]FoldRequired '[Required, Description "something"] :: Bool= 'True

Example1 expression

>>> :kind! FoldRequired '[Required, Optional]FoldRequired '[Required, Optional] :: Bool= 'False

Example1 expression

>>> :kind! FoldRequired '[]FoldRequired '[] :: Bool= 'False

familytype family FoldRequired' (acc :: Bool) (mods :: [Type]) :: Bool where

Source#

Implementation of FoldRequired.

Equations

FoldRequired' acc '[] = acc
FoldRequired' acc (Required ': mods) = FoldRequired' 'True mods
FoldRequired' acc (Optional ': mods) = FoldRequired' 'False mods
FoldRequired' acc (mod ': mods) = FoldRequired' acc mods

Lenient / strict parsing

datadata Lenient

Source#

Leniently parsed argument, i.e. parsing never fail. Wrapped in Either Text.

datadata Strict

Source#

Strictly parsed argument. Not wrapped.

typetype FoldLenient (mods :: [Type]) = FoldLenient' 'False mods

Source#

Fold modifier list to decide whether argument should be parsed strictly or leniently.

Example1 expression

>>> :kind! FoldLenient '[]FoldLenient '[] :: Bool= 'False

familytype family FoldLenient' (acc :: Bool) (mods :: [Type]) :: Bool where

Source#

Implementation of FoldLenient.

Equations

FoldLenient' acc '[] = acc
FoldLenient' acc (Lenient ': mods) = FoldLenient' 'True mods
FoldLenient' acc (Strict ': mods) = FoldLenient' 'False mods
FoldLenient' acc (mod ': mods) = FoldLenient' acc mods

Utilities

typetype RequiredArgument (mods :: [Type]) a = If (FoldRequired mods) a (Maybe a)

Source#

Helper type alias.

Required ↦ a
Optional ↦ Maybe a

valuefoldRequiredArgument

:: SBoolI (FoldRequired mods)
=> Proxy mods
-> (a -> r)
Required
-> (Maybe a -> r)
Optional
-> RequiredArgument mods a
-> r

Source#

Fold a RequiredAgument into a value

valueunfoldRequiredArgument

:: (Monad m, SBoolI (FoldRequired mods), SBoolI (FoldLenient mods))
=> Proxy mods
-> m (RequiredArgument mods a)
error when argument is required
-> (Text -> m (RequiredArgument mods a))
error when argument is strictly parsed
-> Maybe (Either Text a)
value
-> m (RequiredArgument mods a)

Source#

Unfold a value into a RequiredArgument.

type

type RequestArgument (mods :: [Type]) a = If (FoldRequired mods) (If (FoldLenient mods) (Either Text a) a) (Maybe (If (FoldLenient mods) (Either Text a) a))

Source#

Helper type alias.

By default argument is Optional and Strict.

Required, Strict ↦ a
Required, Lenient ↦ Either Text a
Optional, Strict ↦ Maybe a
Optional, Lenient ↦ Maybe (Either Text a)

valueunfoldRequestArgument

:: (Monad m, SBoolI (FoldRequired mods), SBoolI (FoldLenient mods))
=> Proxy mods
-> m (RequestArgument mods a)
error when argument is required
-> (Text -> m (RequestArgument mods a))
error when argument is strictly parsed
-> Maybe (Either Text a)
value
-> m (RequestArgument mods a)

Source#

Unfold a value into a RequestArgument.