Servant.Util.Common.PolyKinds

Everything which requires PolyKinded extension, extracted in order not to spoil the remaining code.

Documentation

data TyNamedParam a

Pair of type and its name as it appears in API.

Constructors

TyNamedParam Symbol a

Instances

FilterBackend backend => BackendApplySomeFilter (backend :: k) ('[] :: [TyNamedFilter])

Defined in Servant.Util.Combinators.Filtering.Backend

Methods

backendApplySomeFilter' :: FilteringSpecApp backend '[] -> SomeFilter '[] -> Maybe (MatchPredicate backend)

(Typeable fk, Typeable a, FilterBackend backend, KnownSymbol name, BackendApplyTypeFilter backend fk a, BackendApplySomeFilter backend params) => BackendApplySomeFilter (backend :: k) ('TyNamedParam name (fk a) ': params)

Defined in Servant.Util.Combinators.Filtering.Backend

Methods

backendApplySomeFilter' :: FilteringSpecApp backend ('TyNamedParam name (fk a) ': params) -> SomeFilter ('TyNamedParam name (fk a) ': params) -> Maybe (MatchPredicate backend)

ReifyParamsNames ('[] :: [TyNamedParam k])

Defined in Servant.Util.Common.PolyKinds

Methods

reifyParamsNames' :: [Text]

ApplyToSortItem backend ('[] :: [TyNamedParam Type])

Defined in Servant.Util.Combinators.Sorting.Backend

Methods

applyToSortItem :: SortingSpecApp backend '[] -> SortingItem -> Maybe (BackendOrdering backend)

(KnownSymbol name, ReifyParamsNames params, ParamsContainNoName params name) => ReifyParamsNames ('TyNamedParam name p ': params :: [TyNamedParam k])

Defined in Servant.Util.Common.PolyKinds

Methods

reifyParamsNames' :: [Text]

(KnownSymbol name, ApplyToSortItem backend params) => ApplyToSortItem backend ('TyNamedParam name p ': params)

Defined in Servant.Util.Combinators.Sorting.Backend

Methods

applyToSortItem :: SortingSpecApp backend ('TyNamedParam name p ': params) -> SortingItem -> Maybe (BackendOrdering backend)

ToHttpApiData (TaggedSortingItemsList provided)

Defined in Servant.Util.Combinators.Sorting.Client

Methods

toUrlPiece :: TaggedSortingItemsList provided -> Text

toEncodedUrlPiece :: TaggedSortingItemsList provided -> Builder

toHeader :: TaggedSortingItemsList provided -> ByteString

toQueryParam :: TaggedSortingItemsList provided -> Text

ReifyParamsNames allowed => FromHttpApiData (TaggedSortingItemsList allowed)

Parse sort_by query param. Following the format described in Sorting section of https://www.moesif.com/blog/technical/api-design/REST-API-Design-Filtering-Sorting-and-Pagination/

Defined in Servant.Util.Combinators.Sorting.Server

Methods

parseUrlPiece :: Text -> Either Text (TaggedSortingItemsList allowed)

parseHeader :: ByteString -> Either Text (TaggedSortingItemsList allowed)

parseQueryParam :: Text -> Either Text (TaggedSortingItemsList allowed)

ReifySortingItems ('[] :: [TyNamedParam (SortingOrderType Type)])

Defined in Servant.Util.Combinators.Sorting.Base

Methods

reifySortingItems :: [SortingItem]

AreFilteringParams ('[] :: [TyNamedFilter])

Defined in Servant.Util.Combinators.Filtering.Server

Methods

parseFilteringParam :: Text -> Text -> Maybe (Either Text $ SomeFilter '[])

BuildSomeFilter ('[] :: [TyNamedFilter])

Defined in Servant.Util.Combinators.Filtering.Logging

Methods

buildSomeFilter' :: SomeFilter '[] -> Maybe Builder

(ReifySortingOrder order, KnownSymbol name, ReifySortingItems items) => ReifySortingItems ('TyNamedParam name (order field) ': items)

Defined in Servant.Util.Combinators.Sorting.Base

Methods

reifySortingItems :: [SortingItem]

(FromHttpApiData ty, Buildable ty, Typeable ty, KnownSymbol name, AreFilteringParams params) => AreFilteringParams ('TyNamedParam name ('ManualFilter ty) ': params)

Defined in Servant.Util.Combinators.Filtering.Server

Methods

parseFilteringParam :: Text -> Text -> Maybe (Either Text $ SomeFilter ('TyNamedParam name ('ManualFilter ty) ': params))

(FromHttpApiData ty, Typeable ty, AreAutoFilters (SupportedFilters ty), KnownSymbol name, AreFilteringParams params) => AreFilteringParams ('TyNamedParam name ('AutoFilter ty) ': params)

Defined in Servant.Util.Combinators.Filtering.Server

Methods

parseFilteringParam :: Text -> Text -> Maybe (Either Text $ SomeFilter ('TyNamedParam name ('AutoFilter ty) ': params))

(KnownSymbol name, Typeable a, Buildable a, BuildSomeFilter params) => BuildSomeFilter ('TyNamedParam name ('ManualFilter a) ': params)

Defined in Servant.Util.Combinators.Filtering.Logging

Methods

buildSomeFilter' :: SomeFilter ('TyNamedParam name ('ManualFilter a) ': params) -> Maybe Builder

(KnownSymbol name, Typeable a, Buildable a, BuildSomeFilter params) => BuildSomeFilter ('TyNamedParam name ('AutoFilter a) ': params)

Defined in Servant.Util.Combinators.Filtering.Logging

Methods

buildSomeFilter' :: SomeFilter ('TyNamedParam name ('AutoFilter a) ': params) -> Maybe Builder

type (?:) = 'TyNamedParam

Convenient type alias for TyNamedParam.

type family TyNamedParamType p where ...

Equations

TyNamedParamType ('TyNamedParam _ a) = a

type family TyNamedParamsNames (params :: [TyNamedParam k]) :: [Symbol] where ...

Equations

TyNamedParamsNames '[] = '[]

TyNamedParamsNames ('TyNamedParam name _ ': params) = name ': TyNamedParamsNames params

class ReifyParamsNames (params :: [TyNamedParam k]) where

Extract info from SortingParams.

Methods

reifyParamsNames' :: [Text]

Get all expected parameter names.

Instances

ReifyParamsNames ('[] :: [TyNamedParam k])

Defined in Servant.Util.Common.PolyKinds

Methods

reifyParamsNames' :: [Text]

(KnownSymbol name, ReifyParamsNames params, ParamsContainNoName params name) => ReifyParamsNames ('TyNamedParam name p ': params :: [TyNamedParam k])

Defined in Servant.Util.Common.PolyKinds

Methods

reifyParamsNames' :: [Text]

reifyParamsNames :: forall params. ReifyParamsNames params => [Text]

type family LookupParam (desc :: Symbol) (name :: Symbol) (params :: [TyNamedParam k]) :: k where ...

Equations

LookupParam desc name '[] = TypeError (('Text (("No " `AppendSymbol` desc) `AppendSymbol` " with name ") :<>: 'ShowType name) :<>: 'Text " found")

LookupParam desc name ('TyNamedParam name a ': params) = a

LookupParam desc name ('TyNamedParam name0 a ': params) = LookupParam desc name params

reifyParamsNamesSet :: forall params. ReifyParamsNames params => Set Text

All names are quaranteed to be unique, so taking set of them is safe (number of entires will be preserved).

type family ParamsContainNoName (params :: [TyNamedParam k]) name :: Constraint where ...

Equations

ParamsContainNoName '[] name = ()

ParamsContainNoName ('TyNamedParam name p ': params) name = TypeError ('Text "Duplicate name in parameters: " :<>: 'ShowType name)

ParamsContainNoName ('TyNamedParam name p ': params) name' = ParamsContainNoName params name'

type family Elem (a :: k) (l :: [k]) :: Bool where ...

Equations

Elem a '[] = 'False

Elem a (a ': l) = 'True

Elem a (_ ': l) = Elem a l

type family If (cond :: Bool) (tru :: k) (fls :: k) :: k where ...

Type-level If. If True a b ==> a; If False a b ==> b

Equations

If 'True (tru :: k) (fls :: k) = tru

If 'False (tru :: k) (fls :: k) = fls

type family (a :: k) == (b :: k) :: Bool where ... infix 4

Equations

a == a = 'True

_ == _ = 'False

type family (a :: Bool) && (b :: Bool) :: Bool where ... infix 3

Equations

'False && _ = 'False

_ && 'False = 'False

'True && 'True = 'True

type family (a :: Bool) || (b :: Bool) :: Bool where ... infix 2

Equations

'True || _ = 'True

_ || 'True = 'True

'False || 'False = 'False

type family (as :: [k]) ++ (bs :: [k]) :: [k] where ...

Equations

'[] ++ bs = bs

(a ': as) ++ bs = a ': (as ++ bs)

type family (as :: [k]) // (bs :: [k]) :: [k] where ...

Equations

'[] // bs = '[]

(a ': as) // bs = If (a `Elem` bs) (as // bs) (a ': (as // bs))

type family InsSorted (s :: Symbol) (ss :: [Symbol]) :: [Symbol] where ...

Equations

InsSorted s '[] = '[s]

InsSorted s0 (s ': ss) = If (CmpSymbol s0 s == 'GT) (s ': InsSorted s0 ss) (If (s0 == s) (s ': ss) (s0 ': (s ': ss)))

type family UnionSorted (ss1 :: [Symbol]) (ss2 :: [Symbol]) :: [Symbol] where ...

Equations

UnionSorted ss1 '[] = ss1

UnionSorted '[] ss2 = ss2

UnionSorted (s1 ': ss1) (s2 ': ss2) = If (s1 == s2) (s1 ': UnionSorted ss1 ss2) (If (CmpSymbol s1 s2 == 'LT) (s1 ': UnionSorted ss1 (s2 ': ss2)) (s2 ': UnionSorted (s1 ': ss1) ss2))