Safe Haskell	None
Language	Haskell2010

Control.Monad.Freer.Extras.Pagination

Synopsis

data PageQuery a = PageQuery {
- pageQuerySize :: PageSize
- pageQueryLastItem :: Maybe a
}
data Page a = Page {
- currentPageQuery :: PageQuery a
- nextPageQuery :: Maybe ( PageQuery a)
- pageItems :: [a]
}
newtype PageSize = PageSize {
- getPageSize :: Natural
}
pageOf :: Eq a => PageQuery a -> Set a -> Page a

Documentation

data PageQuery a Source #

Query parameters for pagination.

Constructors

PageQuery
Fields pageQuerySize :: PageSize Number of items per page. pageQueryLastItem :: Maybe a Last item of the queried page.

Instances

Instances details

Functor PageQuery Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods fmap :: (a -> b) -> PageQuery a -> PageQuery b Source # (<$) :: a -> PageQuery b -> PageQuery a Source #
Eq a => Eq ( PageQuery a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods (==) :: PageQuery a -> PageQuery a -> Bool Source # (/=) :: PageQuery a -> PageQuery a -> Bool Source #
Ord a => Ord ( PageQuery a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods compare :: PageQuery a -> PageQuery a -> Ordering Source # (<) :: PageQuery a -> PageQuery a -> Bool Source # (<=) :: PageQuery a -> PageQuery a -> Bool Source # (>) :: PageQuery a -> PageQuery a -> Bool Source # (>=) :: PageQuery a -> PageQuery a -> Bool Source # max :: PageQuery a -> PageQuery a -> PageQuery a Source # min :: PageQuery a -> PageQuery a -> PageQuery a Source #
Show a => Show ( PageQuery a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods showsPrec :: Int -> PageQuery a -> ShowS Source # show :: PageQuery a -> String Source # showList :: [ PageQuery a] -> ShowS Source #
Generic ( PageQuery a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Associated Types type Rep ( PageQuery a) :: Type -> Type Source # Methods from :: PageQuery a -> Rep ( PageQuery a) x Source # to :: Rep ( PageQuery a) x -> PageQuery a Source #
ToJSON a => ToJSON ( PageQuery a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods toJSON :: PageQuery a -> Value Source # toEncoding :: PageQuery a -> Encoding Source # toJSONList :: [ PageQuery a] -> Value Source # toEncodingList :: [ PageQuery a] -> Encoding Source #
FromJSON a => FromJSON ( PageQuery a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods parseJSON :: Value -> Parser ( PageQuery a) Source # parseJSONList :: Value -> Parser [ PageQuery a] Source #
Default ( PageQuery a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods def :: PageQuery a Source #
type Rep ( PageQuery a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination type Rep ( PageQuery a) = D1 (' MetaData "PageQuery" "Control.Monad.Freer.Extras.Pagination" "freer-extras-1.2.0.0-LXgx2kLJeQTLxOMFH7LYd8" ' False ) ( C1 (' MetaCons "PageQuery" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "pageQuerySize") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PageSize ) :*: S1 (' MetaSel (' Just "pageQueryLastItem") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe a))))

data Page a Source #

Part of a collection.

Constructors

Page
Fields currentPageQuery :: PageQuery a The `PageQuery` which was used to request this `Page` . nextPageQuery :: Maybe ( PageQuery a) The `PageQuery` to use to request the next `Page` . Nothing if we requested the last page. pageItems :: [a] Items in the current `Page` .

Instances

Instances details

Functor Page Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods fmap :: (a -> b) -> Page a -> Page b Source # (<$) :: a -> Page b -> Page a Source #
Eq a => Eq ( Page a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods (==) :: Page a -> Page a -> Bool Source # (/=) :: Page a -> Page a -> Bool Source #
Ord a => Ord ( Page a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods compare :: Page a -> Page a -> Ordering Source # (<) :: Page a -> Page a -> Bool Source # (<=) :: Page a -> Page a -> Bool Source # (>) :: Page a -> Page a -> Bool Source # (>=) :: Page a -> Page a -> Bool Source # max :: Page a -> Page a -> Page a Source # min :: Page a -> Page a -> Page a Source #
Show a => Show ( Page a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods showsPrec :: Int -> Page a -> ShowS Source # show :: Page a -> String Source # showList :: [ Page a] -> ShowS Source #
Generic ( Page a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Associated Types type Rep ( Page a) :: Type -> Type Source # Methods from :: Page a -> Rep ( Page a) x Source # to :: Rep ( Page a) x -> Page a Source #
ToJSON a => ToJSON ( Page a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods toJSON :: Page a -> Value Source # toEncoding :: Page a -> Encoding Source # toJSONList :: [ Page a] -> Value Source # toEncodingList :: [ Page a] -> Encoding Source #
FromJSON a => FromJSON ( Page a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods parseJSON :: Value -> Parser ( Page a) Source # parseJSONList :: Value -> Parser [ Page a] Source #
type Rep ( Page a) Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination type Rep ( Page a) = D1 (' MetaData "Page" "Control.Monad.Freer.Extras.Pagination" "freer-extras-1.2.0.0-LXgx2kLJeQTLxOMFH7LYd8" ' False ) ( C1 (' MetaCons "Page" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "currentPageQuery") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( PageQuery a)) :: ( S1 (' MetaSel (' Just "nextPageQuery") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe ( PageQuery a))) :: S1 (' MetaSel (' Just "pageItems") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [a]))))

newtype PageSize Source #

Constructors

PageSize
Fields getPageSize :: Natural

Instances

Instances details

Eq PageSize Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods (==) :: PageSize -> PageSize -> Bool Source # (/=) :: PageSize -> PageSize -> Bool Source #
Num PageSize Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods (+) :: PageSize -> PageSize -> PageSize Source # (-) :: PageSize -> PageSize -> PageSize Source # (*) :: PageSize -> PageSize -> PageSize Source # negate :: PageSize -> PageSize Source # abs :: PageSize -> PageSize Source # signum :: PageSize -> PageSize Source # fromInteger :: Integer -> PageSize Source #
Ord PageSize Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods compare :: PageSize -> PageSize -> Ordering Source # (<) :: PageSize -> PageSize -> Bool Source # (<=) :: PageSize -> PageSize -> Bool Source # (>) :: PageSize -> PageSize -> Bool Source # (>=) :: PageSize -> PageSize -> Bool Source # max :: PageSize -> PageSize -> PageSize Source # min :: PageSize -> PageSize -> PageSize Source #
Show PageSize Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods showsPrec :: Int -> PageSize -> ShowS Source # show :: PageSize -> String Source # showList :: [ PageSize ] -> ShowS Source #
Generic PageSize Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Associated Types type Rep PageSize :: Type -> Type Source # Methods from :: PageSize -> Rep PageSize x Source # to :: Rep PageSize x -> PageSize Source #
ToJSON PageSize Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods toJSON :: PageSize -> Value Source # toEncoding :: PageSize -> Encoding Source # toJSONList :: [ PageSize ] -> Value Source # toEncodingList :: [ PageSize ] -> Encoding Source #
FromJSON PageSize Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods parseJSON :: Value -> Parser PageSize Source # parseJSONList :: Value -> Parser [ PageSize ] Source #
Default PageSize Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods def :: PageSize Source #
type Rep PageSize Source #
Instance details Defined in Control.Monad.Freer.Extras.Pagination type Rep PageSize = D1 (' MetaData "PageSize" "Control.Monad.Freer.Extras.Pagination" "freer-extras-1.2.0.0-LXgx2kLJeQTLxOMFH7LYd8" ' True ) ( C1 (' MetaCons "PageSize" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getPageSize") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Natural )))

pageOf Source #

Arguments

:: Eq a
=> PageQuery a	Pagination query parameters.
-> Set a
-> Page a

Given a Set , request the Page with the given PageQuery .