Safe Haskell	None
Language	Haskell2010

Yesod.Paginator.Pages

Contents

Type safe Naturals
Page
Pages
Safely accessing Pages data

Synopsis

data PageNumber
data PerPage
data ItemsCount
pageOffset :: PageNumber -> PerPage -> ItemsCount
data Page a
pageItems :: Page a -> [a]
pageNumber :: Page a -> PageNumber
toPage :: [a] -> PageNumber -> Page a
data Pages a
pagesCurrent :: Pages a -> Page a
pagesLast :: Pages a -> PageNumber
toPages :: PageNumber -> PerPage -> ItemsCount -> [a] -> Pages a
takePreviousPages :: Natural -> Pages a -> [PageNumber]
takeNextPages :: Natural -> Pages a -> [PageNumber]
getPreviousPage :: Pages a -> Maybe PageNumber
getNextPage :: Pages a -> Maybe PageNumber

Type safe `Natural`s

N.B. PageNumber and PerPage will currently allow 0, but it's unclear if that's correct and may not be the case in the future.

data PageNumber Source #

Instances

Instances details

Enum PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods succ :: PageNumber -> PageNumber # pred :: PageNumber -> PageNumber # toEnum :: Int -> PageNumber # fromEnum :: PageNumber -> Int # enumFrom :: PageNumber -> [PageNumber] # enumFromThen :: PageNumber -> PageNumber -> [PageNumber] # enumFromTo :: PageNumber -> PageNumber -> [PageNumber] # enumFromThenTo :: PageNumber -> PageNumber -> PageNumber -> [PageNumber] #
Eq PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods (==) :: PageNumber -> PageNumber -> Bool # (/=) :: PageNumber -> PageNumber -> Bool #
Integral PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods quot :: PageNumber -> PageNumber -> PageNumber # rem :: PageNumber -> PageNumber -> PageNumber # div :: PageNumber -> PageNumber -> PageNumber # mod :: PageNumber -> PageNumber -> PageNumber # quotRem :: PageNumber -> PageNumber -> (PageNumber, PageNumber) # divMod :: PageNumber -> PageNumber -> (PageNumber, PageNumber) # toInteger :: PageNumber -> Integer #
Num PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods (+) :: PageNumber -> PageNumber -> PageNumber # (-) :: PageNumber -> PageNumber -> PageNumber # (*) :: PageNumber -> PageNumber -> PageNumber # negate :: PageNumber -> PageNumber # abs :: PageNumber -> PageNumber # signum :: PageNumber -> PageNumber # fromInteger :: Integer -> PageNumber #
Ord PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods compare :: PageNumber -> PageNumber -> Ordering # (<) :: PageNumber -> PageNumber -> Bool # (<=) :: PageNumber -> PageNumber -> Bool # (>) :: PageNumber -> PageNumber -> Bool # (>=) :: PageNumber -> PageNumber -> Bool # max :: PageNumber -> PageNumber -> PageNumber # min :: PageNumber -> PageNumber -> PageNumber #
Real PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods toRational :: PageNumber -> Rational #
Show PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods showsPrec :: Int -> PageNumber -> ShowS # show :: PageNumber -> String # showList :: [PageNumber] -> ShowS #
ToMarkup PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods toMarkup :: PageNumber -> Markup # preEscapedToMarkup :: PageNumber -> Markup #

data PerPage Source #

Instances

Instances details

Enum PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods succ :: PerPage -> PerPage # pred :: PerPage -> PerPage # toEnum :: Int -> PerPage # fromEnum :: PerPage -> Int # enumFrom :: PerPage -> [PerPage] # enumFromThen :: PerPage -> PerPage -> [PerPage] # enumFromTo :: PerPage -> PerPage -> [PerPage] # enumFromThenTo :: PerPage -> PerPage -> PerPage -> [PerPage] #
Eq PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods (==) :: PerPage -> PerPage -> Bool # (/=) :: PerPage -> PerPage -> Bool #
Integral PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods quot :: PerPage -> PerPage -> PerPage # rem :: PerPage -> PerPage -> PerPage # div :: PerPage -> PerPage -> PerPage # mod :: PerPage -> PerPage -> PerPage # quotRem :: PerPage -> PerPage -> (PerPage, PerPage) # divMod :: PerPage -> PerPage -> (PerPage, PerPage) # toInteger :: PerPage -> Integer #
Num PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods (+) :: PerPage -> PerPage -> PerPage # (-) :: PerPage -> PerPage -> PerPage # (*) :: PerPage -> PerPage -> PerPage # negate :: PerPage -> PerPage # abs :: PerPage -> PerPage # signum :: PerPage -> PerPage # fromInteger :: Integer -> PerPage #
Ord PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods compare :: PerPage -> PerPage -> Ordering # (<) :: PerPage -> PerPage -> Bool # (<=) :: PerPage -> PerPage -> Bool # (>) :: PerPage -> PerPage -> Bool # (>=) :: PerPage -> PerPage -> Bool # max :: PerPage -> PerPage -> PerPage # min :: PerPage -> PerPage -> PerPage #
Read PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods readsPrec :: Int -> ReadS PerPage # readList :: ReadS [PerPage] # readPrec :: ReadPrec PerPage # readListPrec :: ReadPrec [PerPage] #
Real PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods toRational :: PerPage -> Rational #
Show PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods showsPrec :: Int -> PerPage -> ShowS # show :: PerPage -> String # showList :: [PerPage] -> ShowS #
PathPiece PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods fromPathPiece :: Text -> Maybe PerPage # toPathPiece :: PerPage -> Text #

data ItemsCount Source #

Instances

Instances details

Enum ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods succ :: ItemsCount -> ItemsCount # pred :: ItemsCount -> ItemsCount # toEnum :: Int -> ItemsCount # fromEnum :: ItemsCount -> Int # enumFrom :: ItemsCount -> [ItemsCount] # enumFromThen :: ItemsCount -> ItemsCount -> [ItemsCount] # enumFromTo :: ItemsCount -> ItemsCount -> [ItemsCount] # enumFromThenTo :: ItemsCount -> ItemsCount -> ItemsCount -> [ItemsCount] #
Eq ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods (==) :: ItemsCount -> ItemsCount -> Bool # (/=) :: ItemsCount -> ItemsCount -> Bool #
Integral ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods quot :: ItemsCount -> ItemsCount -> ItemsCount # rem :: ItemsCount -> ItemsCount -> ItemsCount # div :: ItemsCount -> ItemsCount -> ItemsCount # mod :: ItemsCount -> ItemsCount -> ItemsCount # quotRem :: ItemsCount -> ItemsCount -> (ItemsCount, ItemsCount) # divMod :: ItemsCount -> ItemsCount -> (ItemsCount, ItemsCount) # toInteger :: ItemsCount -> Integer #
Num ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods (+) :: ItemsCount -> ItemsCount -> ItemsCount # (-) :: ItemsCount -> ItemsCount -> ItemsCount # (*) :: ItemsCount -> ItemsCount -> ItemsCount # negate :: ItemsCount -> ItemsCount # abs :: ItemsCount -> ItemsCount # signum :: ItemsCount -> ItemsCount # fromInteger :: Integer -> ItemsCount #
Ord ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods compare :: ItemsCount -> ItemsCount -> Ordering # (<) :: ItemsCount -> ItemsCount -> Bool # (<=) :: ItemsCount -> ItemsCount -> Bool # (>) :: ItemsCount -> ItemsCount -> Bool # (>=) :: ItemsCount -> ItemsCount -> Bool # max :: ItemsCount -> ItemsCount -> ItemsCount # min :: ItemsCount -> ItemsCount -> ItemsCount #
Read ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods readsPrec :: Int -> ReadS ItemsCount # readList :: ReadS [ItemsCount] # readPrec :: ReadPrec ItemsCount # readListPrec :: ReadPrec [ItemsCount] #
Real ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods toRational :: ItemsCount -> Rational #
Show ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods showsPrec :: Int -> ItemsCount -> ShowS # show :: ItemsCount -> String # showList :: [ItemsCount] -> ShowS #
PathPiece ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods fromPathPiece :: Text -> Maybe ItemsCount # toPathPiece :: ItemsCount -> Text #

pageOffset :: PageNumber -> PerPage -> ItemsCount Source #

Calculate a page's zero-based offset in the overall items

>>> pageOffset 4 3
9

Page

data Page a Source #

Instances

Instances details

Functor Page Source #
Instance details Defined in Yesod.Paginator.Pages Methods fmap :: (a -> b) -> Page a -> Page b # (<$) :: a -> Page b -> Page a #
Foldable Page Source #
Instance details Defined in Yesod.Paginator.Pages Methods fold :: Monoid m => Page m -> m # foldMap :: Monoid m => (a -> m) -> Page a -> m # foldMap' :: Monoid m => (a -> m) -> Page a -> m # foldr :: (a -> b -> b) -> b -> Page a -> b # foldr' :: (a -> b -> b) -> b -> Page a -> b # foldl :: (b -> a -> b) -> b -> Page a -> b # foldl' :: (b -> a -> b) -> b -> Page a -> b # foldr1 :: (a -> a -> a) -> Page a -> a # foldl1 :: (a -> a -> a) -> Page a -> a # toList :: Page a -> [a] # null :: Page a -> Bool # length :: Page a -> Int # elem :: Eq a => a -> Page a -> Bool # maximum :: Ord a => Page a -> a # minimum :: Ord a => Page a -> a # sum :: Num a => Page a -> a # product :: Num a => Page a -> a #
Traversable Page Source #
Instance details Defined in Yesod.Paginator.Pages Methods traverse :: Applicative f => (a -> f b) -> Page a -> f (Page b) # sequenceA :: Applicative f => Page (f a) -> f (Page a) # mapM :: Monad m => (a -> m b) -> Page a -> m (Page b) # sequence :: Monad m => Page (m a) -> m (Page a) #
Eq a => Eq (Page a) Source #
Instance details Defined in Yesod.Paginator.Pages Methods (==) :: Page a -> Page a -> Bool # (/=) :: Page a -> Page a -> Bool #
Show a => Show (Page a) Source #
Instance details Defined in Yesod.Paginator.Pages Methods showsPrec :: Int -> Page a -> ShowS # show :: Page a -> String # showList :: [Page a] -> ShowS #

pageItems :: Page a -> [a] Source #

pageNumber :: Page a -> PageNumber Source #

toPage :: [a] -> PageNumber -> Page a Source #

Page constructor

Pages

data Pages a Source #

Instances

Instances details

Functor Pages Source #
Instance details Defined in Yesod.Paginator.Pages Methods fmap :: (a -> b) -> Pages a -> Pages b # (<$) :: a -> Pages b -> Pages a #
Foldable Pages Source #
Instance details Defined in Yesod.Paginator.Pages Methods fold :: Monoid m => Pages m -> m # foldMap :: Monoid m => (a -> m) -> Pages a -> m # foldMap' :: Monoid m => (a -> m) -> Pages a -> m # foldr :: (a -> b -> b) -> b -> Pages a -> b # foldr' :: (a -> b -> b) -> b -> Pages a -> b # foldl :: (b -> a -> b) -> b -> Pages a -> b # foldl' :: (b -> a -> b) -> b -> Pages a -> b # foldr1 :: (a -> a -> a) -> Pages a -> a # foldl1 :: (a -> a -> a) -> Pages a -> a # toList :: Pages a -> [a] # null :: Pages a -> Bool # length :: Pages a -> Int # elem :: Eq a => a -> Pages a -> Bool # maximum :: Ord a => Pages a -> a # minimum :: Ord a => Pages a -> a # sum :: Num a => Pages a -> a # product :: Num a => Pages a -> a #
Traversable Pages Source #
Instance details Defined in Yesod.Paginator.Pages Methods traverse :: Applicative f => (a -> f b) -> Pages a -> f (Pages b) # sequenceA :: Applicative f => Pages (f a) -> f (Pages a) # mapM :: Monad m => (a -> m b) -> Pages a -> m (Pages b) # sequence :: Monad m => Pages (m a) -> m (Pages a) #
Eq a => Eq (Pages a) Source #
Instance details Defined in Yesod.Paginator.Pages Methods (==) :: Pages a -> Pages a -> Bool # (/=) :: Pages a -> Pages a -> Bool #
Show a => Show (Pages a) Source #
Instance details Defined in Yesod.Paginator.Pages Methods showsPrec :: Int -> Pages a -> ShowS # show :: Pages a -> String # showList :: [Pages a] -> ShowS #

pagesCurrent :: Pages a -> Page a Source #

pagesLast :: Pages a -> PageNumber Source #

toPages :: PageNumber -> PerPage -> ItemsCount -> [a] -> Pages a Source #

Construct a Pages a from paginated data

>>> toPages 4 3 10 []
Pages {pagesCurrent = Page {pageItems = [], pageNumber = 4}, pagesPrevious = [1,2,3], pagesNext = [], pagesLast = 4}

Safely accessing Pages data

takePreviousPages :: Natural -> Pages a -> [PageNumber] Source #

Take previous pages, going back from current

>>> takePreviousPages 3 $ Pages (Page [] 5) [1,2,3,4] [6] 6
[2,3,4]

takeNextPages :: Natural -> Pages a -> [PageNumber] Source #

Take next pages, going forward from current

>>> takeNextPages 3 $ Pages (Page [] 2) [1] [3,4,5,6] 6
[3,4,5]

getPreviousPage :: Pages a -> Maybe PageNumber Source #

The previous page number, if it exists

>>> getPreviousPage $ Pages (Page [] 1) [] [2,3,4] 4
Nothing

>>> getPreviousPage $ Pages (Page [] 2) [1] [3,4] 4
Just 1

getNextPage :: Pages a -> Maybe PageNumber Source #

The next page number, if it exists

>>> getNextPage $ Pages (Page [] 4) [1,2,3] [] 4
Nothing

>>> getNextPage $ Pages (Page [] 3) [1,2] [4] 4
Just 4

Type safe Naturals

Instances

Instances

Instances

Page

Instances

Pages

Instances

Safely accessing Pages data

Type safe `Natural`s