Yesod.Paginator.Pages

Type safe Naturals

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

Instances

Enum PageNumber

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

Methods

(==) :: PageNumber -> PageNumber -> Bool

(/=) :: PageNumber -> PageNumber -> Bool

Integral PageNumber

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

Methods

(+) :: PageNumber -> PageNumber -> PageNumber

(-) :: PageNumber -> PageNumber -> PageNumber

(*) :: PageNumber -> PageNumber -> PageNumber

negate :: PageNumber -> PageNumber

abs :: PageNumber -> PageNumber

signum :: PageNumber -> PageNumber

fromInteger :: Integer -> PageNumber

Ord PageNumber

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

Methods

toRational :: PageNumber -> Rational

Show PageNumber

Methods

showsPrec :: Int -> PageNumber -> ShowS

show :: PageNumber -> String

showList :: [PageNumber] -> ShowS

ToMarkup PageNumber

Methods

toMarkup :: PageNumber -> Markup

preEscapedToMarkup :: PageNumber -> Markup

data PerPage

Instances

Enum PerPage

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

Methods

(==) :: PerPage -> PerPage -> Bool

(/=) :: PerPage -> PerPage -> Bool

Integral PerPage

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

Methods

(+) :: PerPage -> PerPage -> PerPage

(-) :: PerPage -> PerPage -> PerPage

(*) :: PerPage -> PerPage -> PerPage

negate :: PerPage -> PerPage

abs :: PerPage -> PerPage

signum :: PerPage -> PerPage

fromInteger :: Integer -> PerPage

Ord PerPage

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

Methods

readsPrec :: Int -> ReadS PerPage

readList :: ReadS [PerPage]

readPrec :: ReadPrec PerPage

readListPrec :: ReadPrec [PerPage]

Real PerPage

Methods

toRational :: PerPage -> Rational

Show PerPage

Methods

showsPrec :: Int -> PerPage -> ShowS

show :: PerPage -> String

showList :: [PerPage] -> ShowS

PathPiece PerPage

Methods

fromPathPiece :: Text -> Maybe PerPage

toPathPiece :: PerPage -> Text

data ItemsCount

Instances

Enum ItemsCount

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

Methods

(==) :: ItemsCount -> ItemsCount -> Bool

(/=) :: ItemsCount -> ItemsCount -> Bool

Integral ItemsCount

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

Methods

(+) :: ItemsCount -> ItemsCount -> ItemsCount

(-) :: ItemsCount -> ItemsCount -> ItemsCount

(*) :: ItemsCount -> ItemsCount -> ItemsCount

negate :: ItemsCount -> ItemsCount

abs :: ItemsCount -> ItemsCount

signum :: ItemsCount -> ItemsCount

fromInteger :: Integer -> ItemsCount

Ord ItemsCount

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

Methods

readsPrec :: Int -> ReadS ItemsCount

readList :: ReadS [ItemsCount]

readPrec :: ReadPrec ItemsCount

readListPrec :: ReadPrec [ItemsCount]

Real ItemsCount

Methods

toRational :: ItemsCount -> Rational

Show ItemsCount

Methods

showsPrec :: Int -> ItemsCount -> ShowS

show :: ItemsCount -> String

showList :: [ItemsCount] -> ShowS

PathPiece ItemsCount

Methods

fromPathPiece :: Text -> Maybe ItemsCount

toPathPiece :: ItemsCount -> Text

pageOffset :: PageNumber -> PerPage -> ItemsCount

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

>>> pageOffset 4 3
9

Page

data Page a

Instances

Eq a => Eq (Page a)

Methods

(==) :: Page a -> Page a -> Bool

(/=) :: Page a -> Page a -> Bool

Show a => Show (Page a)

Methods

showsPrec :: Int -> Page a -> ShowS

show :: Page a -> String

showList :: [Page a] -> ShowS

pageItems :: Page a -> [a]

pageNumber :: Page a -> PageNumber

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

Page constructor

Pages

data Pages a

Instances

Eq a => Eq (Pages a)

Methods

(==) :: Pages a -> Pages a -> Bool

(/=) :: Pages a -> Pages a -> Bool

Show a => Show (Pages a)

Methods

showsPrec :: Int -> Pages a -> ShowS

show :: Pages a -> String

showList :: [Pages a] -> ShowS

pagesCurrent :: Pages a -> Page a

pagesLast :: Pages a -> PageNumber

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

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]

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]

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

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

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