Network.JSONApi.Pagination

Documentation

data Pagination

Wrapper type for the various components of pagination being page size, page number and the number of resources in total.

Constructors

Pagination

Fields

• getPaginationPageSize :: PageSize
• getPaginationPageNum :: PageNum
• getPaginationResourceCount :: ResourceCount

Instances

Generic Pagination

Defined in Network.JSONApi.Pagination

Associated Types

type Rep Pagination :: Type -> Type

Methods

from :: Pagination -> Rep Pagination x

to :: Rep Pagination x -> Pagination

ToJSON Pagination

Defined in Network.JSONApi.Pagination

Methods

toJSON :: Pagination -> Value

toEncoding :: Pagination -> Encoding

toJSONList :: [Pagination] -> Value

toEncodingList :: [Pagination] -> Encoding

NFData Pagination

Defined in Network.JSONApi.Pagination

Methods

rnf :: Pagination -> ()

MetaObject Pagination

Pagination can be used as a meta object if required in addition to the links generated for paging.

Defined in Network.JSONApi.Pagination

Methods

typeName :: Pagination -> Text

type Rep Pagination

Defined in Network.JSONApi.Pagination

type Rep Pagination = D1 (MetaData "Pagination" "Network.JSONApi.Pagination" "json-api-lib-0.2.0.0-CIYDoTtBA9V1pU3j2B9t69" False) (C1 (MetaCons "Pagination" PrefixI True) (S1 (MetaSel (Just "getPaginationPageSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageSize) :*: (S1 (MetaSel (Just "getPaginationPageNum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageNum) :*: S1 (MetaSel (Just "getPaginationResourceCount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ResourceCount))))

newtype PageNum

Constructors

PageNum

Fields

• getPageNum :: Int

Instances

Show PageNum

Defined in Network.JSONApi.Pagination

Methods

showsPrec :: Int -> PageNum -> ShowS

show :: PageNum -> String

showList :: [PageNum] -> ShowS

Generic PageNum

Defined in Network.JSONApi.Pagination

Associated Types

type Rep PageNum :: Type -> Type

Methods

from :: PageNum -> Rep PageNum x

to :: Rep PageNum x -> PageNum

NFData PageNum

Defined in Network.JSONApi.Pagination

Methods

rnf :: PageNum -> ()

type Rep PageNum

Defined in Network.JSONApi.Pagination

type Rep PageNum = D1 (MetaData "PageNum" "Network.JSONApi.Pagination" "json-api-lib-0.2.0.0-CIYDoTtBA9V1pU3j2B9t69" True) (C1 (MetaCons "PageNum" PrefixI True) (S1 (MetaSel (Just "getPageNum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

newtype PageSize

We can specify limits on the number of rows we would like back from the database

Constructors

PageSize

Fields

• getPageSize :: Int

Instances

Show PageSize

Defined in Network.JSONApi.Pagination

Methods

showsPrec :: Int -> PageSize -> ShowS

show :: PageSize -> String

showList :: [PageSize] -> ShowS

Generic PageSize

Defined in Network.JSONApi.Pagination

Associated Types

type Rep PageSize :: Type -> Type

Methods

from :: PageSize -> Rep PageSize x

to :: Rep PageSize x -> PageSize

NFData PageSize

Defined in Network.JSONApi.Pagination

Methods

rnf :: PageSize -> ()

type Rep PageSize

Defined in Network.JSONApi.Pagination

type Rep PageSize = D1 (MetaData "PageSize" "Network.JSONApi.Pagination" "json-api-lib-0.2.0.0-CIYDoTtBA9V1pU3j2B9t69" True) (C1 (MetaCons "PageSize" PrefixI True) (S1 (MetaSel (Just "getPageSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

newtype ResourceCount

Constructors

ResourceCount

Fields

• getResourceCount :: Int

Instances

Show ResourceCount

Defined in Network.JSONApi.Pagination

Methods

showsPrec :: Int -> ResourceCount -> ShowS

show :: ResourceCount -> String

showList :: [ResourceCount] -> ShowS

Generic ResourceCount

Defined in Network.JSONApi.Pagination

Associated Types

type Rep ResourceCount :: Type -> Type

Methods

from :: ResourceCount -> Rep ResourceCount x

to :: Rep ResourceCount x -> ResourceCount

NFData ResourceCount

Defined in Network.JSONApi.Pagination

Methods

rnf :: ResourceCount -> ()

type Rep ResourceCount

Defined in Network.JSONApi.Pagination

type Rep ResourceCount = D1 (MetaData "ResourceCount" "Network.JSONApi.Pagination" "json-api-lib-0.2.0.0-CIYDoTtBA9V1pU3j2B9t69" True) (C1 (MetaCons "ResourceCount" PrefixI True) (S1 (MetaSel (Just "getResourceCount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))