Blockfrost.Client.Pagination

Pagination instance for HasClient

Documentation

data Paged

Pagination parameters

Constructors

Paged

Fields

• countPerPage :: Int

  Count of results per page

• pageNumber :: Int

  Page number

Instances

Eq Paged

Defined in Blockfrost.Util.Pagination

Methods

(==) :: Paged -> Paged -> Bool

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

Ord Paged

Defined in Blockfrost.Util.Pagination

Methods

compare :: Paged -> Paged -> Ordering

(<) :: Paged -> Paged -> Bool

(<=) :: Paged -> Paged -> Bool

(>) :: Paged -> Paged -> Bool

(>=) :: Paged -> Paged -> Bool

max :: Paged -> Paged -> Paged

min :: Paged -> Paged -> Paged

Show Paged

Defined in Blockfrost.Util.Pagination

Methods

showsPrec :: Int -> Paged -> ShowS

show :: Paged -> String

showList :: [Paged] -> ShowS

Default Paged

Defined in Blockfrost.Util.Pagination

Methods

def :: Paged

page :: Int -> Paged

Default Paged at specific page number

paged :: Int -> Int -> Paged

Construct Paged from page size and page number.

Throws error on invalid values.

nextPage :: Paged -> Paged

Increment page number

allPages :: Monad m => (Paged -> m [a]) -> m [a]

Query all results, until we get less than maximum items per page.

Orphan instances

HasClient m subApi => HasClient m (Pagination :> subApi)

Associated Types

type Client m (Pagination :> subApi)

Methods

clientWithRoute :: Proxy m -> Proxy (Pagination :> subApi) -> Request -> Client m (Pagination :> subApi)

hoistClientMonad :: Proxy m -> Proxy (Pagination :> subApi) -> (forall x. mon x -> mon' x) -> Client mon (Pagination :> subApi) -> Client mon' (Pagination :> subApi)