Servant.Util.Combinators.Sorting.Construction

Manual construction of sorting spec.

Documentation

data SortingRequestItem (provided :: [TyNamedParam *])

Helper for defining custom SortingSpecs, contains SortingItem corresponding to one of parameter in provided list.

Instances

Show (SortingRequestItem provided)

Defined in Servant.Util.Combinators.Sorting.Construction

Methods

showsPrec :: Int -> SortingRequestItem provided -> ShowS

show :: SortingRequestItem provided -> String

showList :: [SortingRequestItem provided] -> ShowS

asc :: forall name provided. (KnownSymbol name, KnownTypeName provided name provided) => NameLabel name -> SortingRequestItem provided

Ascendant sorting on a field with given name.

desc :: forall name provided. (KnownSymbol name, KnownTypeName provided name provided) => NameLabel name -> SortingRequestItem provided

Ascendant sorting on a field with given name.

mkSortingSpec :: ReifySortingItems base => [SortingRequestItem provided] -> SortingSpec provided base

Make a sorting specification. Specified list should contain sorting on distinct fields; we do not enforce this at type-level for convenience.

Example:

-- 

sortingSpec :: SortingSpec ["id" ?: Int, "desc" ?: Text]
sortingSpec = mkSortingSpec [asc #id]

noSorting :: ReifySortingItems base => SortingSpec provided base

Do not specify ordering.

Orphan instances

ReifySortingItems base => IsList (SortingSpec provided base)

Instance for SortingSpec construction.

Associated Types

type Item (SortingSpec provided base)

Methods

fromList :: [Item (SortingSpec provided base)] -> SortingSpec provided base

fromListN :: Int -> [Item (SortingSpec provided base)] -> SortingSpec provided base

toList :: SortingSpec provided base -> [Item (SortingSpec provided base)]

ReifySortingItems base => Default (SortingSpec provided base)

By default noSorting is used.

Methods

def :: SortingSpec provided base