Yesod.Page

Documentation

withPageLink :: (MonadHandler m, ToJSON position, FromJSON position, RenderRoute (HandlerSite m)) => (a -> position) -> (Cursor position -> m [a]) -> m [a]

withPage and adding pagination data to a Link response header

withPage

Arguments

:: (MonadHandler m, ToJSON position, FromJSON position, RenderRoute (HandlerSite m))

=> (a -> position)

How to get an item's position

For example, this would be entityKey for paginated Entity values.

-> (Cursor position -> m [a])

How to fetch one page of data at the given Cursor

-> m (Page a)

data Page a

Constructors

Page

Fields

• pageData :: [a]
• pageFirst :: RenderedRoute
• pageNext :: Maybe RenderedRoute
• pagePrevious :: Maybe RenderedRoute
• pageLast :: RenderedRoute

Instances

Functor Page

Defined in Yesod.Page

Methods

fmap :: (a -> b) -> Page a -> Page b

(<$) :: a -> Page b -> Page a

ToJSON a => ToJSON (Page a)

Defined in Yesod.Page

Methods

toJSON :: Page a -> Value

toEncoding :: Page a -> Encoding

toJSONList :: [Page a] -> Value

toEncodingList :: [Page a] -> Encoding

data Cursor position

An encoding of the position in a page

A Cursor encodes all necessary information to determine the position in a specific page.

Constructors

Cursor

Fields

• cursorRoute :: RenderedRoute

  The route of the parsed request

• cursorPosition :: Position position

  The last position seen by the endpoint consumer

• cursorLimit :: Limit

  The page size requested by the endpoint consumer

data Position position

Constructors

First

Next position

Previous position

Last

Instances

ToJSON position => ToJSON (Position position)

Defined in Yesod.Page

Methods

toJSON :: Position position -> Value

toEncoding :: Position position -> Encoding

toJSONList :: [Position position] -> Value

toEncodingList :: [Position position] -> Encoding

FromJSON position => FromJSON (Position position)

Defined in Yesod.Page

Methods

parseJSON :: Value -> Parser (Position position)

parseJSONList :: Value -> Parser [Position position]

data Limit

unLimit :: Limit -> Int