Reflex.Dom.Contrib.Pagination

Documentation

pqSearchString :: Lens' PaginationQuery String

pqOffset :: Lens' PaginationQuery Word64

pqLimit :: Lens' PaginationQuery Word64

prTotalCount :: forall a. Lens' (PaginationResults a) Word64

prTimestamp :: forall a. Lens' (PaginationResults a) UTCTime

prResults :: forall a a. Lens (PaginationResults a) (PaginationResults a) [a] [a]

prOffset :: forall a. Lens' (PaginationResults a) Word64

pvValue :: forall a a. Lens (CacheVal a) (CacheVal a) a a

pvShouldStore :: forall a. Lens' (CacheVal a) Bool

pvQuery :: forall a. Lens' (CacheVal a) PaginationQuery

data PaginationQuery

General data structure needed for running queries with paginated results.

Constructors

PaginationQuery

Fields

_pqLimit :: Word64

_pqOffset :: Word64

_pqSearchString :: String

Instances

Eq PaginationQuery

Ord PaginationQuery

Read PaginationQuery

Show PaginationQuery

Default PaginationQuery

ToJSON PaginationQuery

FromJSON PaginationQuery

data PaginationResults a

Data structure wrapping results.

Constructors

PaginationResults

Fields

_prOffset :: Word64

_prTotalCount :: Word64

_prTimestamp :: UTCTime

_prResults :: [a]

Instances

Eq a => Eq (PaginationResults a)

Ord a => Ord (PaginationResults a)

Read a => Read (PaginationResults a)

Show a => Show (PaginationResults a)

ToJSON a => ToJSON (PaginationResults a)

FromJSON a => FromJSON (PaginationResults a)

type PaginationCache k v = Map k [CacheVal v]

type PaginationInput k = (k, PaginationQuery)

type PaginationOutput k v = (k, Maybe (CacheVal v))

data CacheVal a

Along with the query results we also need to store the PaginationQuery structure that generated it as well as a flag indicating whether this data should be stored in the cache. This prevents results that are sub-searches of a previous search from overwriting the results of a more general query.

Constructors

CacheVal

Fields

_pvQuery :: PaginationQuery

_pvShouldStore :: Bool

_pvValue :: a

Instances

Eq a => Eq (CacheVal a)

Ord a => Ord (CacheVal a)

Show a => Show (CacheVal a)

data PQParams

Constructors

PQParams

Fields

pqpMaxCacheSize :: Int

The max number of queries to cache

pqpPruneAmount :: Int

The number of queries to discard when we reach the size limit

Instances

Eq PQParams

Ord PQParams

Show PQParams

Default PQParams

paginatedQuery

Arguments

:: (MonadWidget t m, Show k, Ord k, FromJSON a)

=> PQParams

-> (String -> a -> Bool)

-> String

-> Event t (Map String ByteString, PaginationInput k)

Param map and pagination structure. k is any additional information that you need to disambiguate multiple PaginationQuery entries.

-> m (Event t (Maybe (PaginationResults a)))

Paginated querying with built-in search and results caching.

addToCache :: Ord k => PQParams -> PaginationOutput k (PaginationResults v) -> PaginationCache k (PaginationResults v) -> PaginationCache k (PaginationResults v)

prune :: Ord k => Int -> PaginationCache k (PaginationResults v) -> PaginationCache k (PaginationResults v)

Prunes the PaginationCache of the oldest n entries. This is not the oldest (k,v) pairs. It is the oldest vs out of all the (k,[v]) pairs.

cachedQuery :: (MonadWidget t m, Show k, Ord k, FromJSON a) => (String -> a -> Bool) -> String -> PaginationCache k (PaginationResults a) -> (Map String ByteString, PaginationInput k) -> m (Event t (PaginationOutput k (PaginationResults a)))

Checks a cache and makes a request to the supplied URL if the cached data cannot be used to serve the results of the current requested query.

isSubSearch

Arguments

:: PaginationQuery

-> CacheVal (PaginationResults a)

Cached query results

-> Bool

Checks whether a previous cached search string is a substring of the current search string. In this case we don't need to requery the server.