Hercules.API.Paging

Documentation

data PagedResponse a

Constructors

PagedResponse

Fields

• items :: [a]

  The items you requested, up to some limit.

• more :: Bool

  Whether more items would be returned if it wasn't for the limit.

Instances

HasField "get" PagedJobs (PagedResponse Job)

Defined in Hercules.API.Projects

Methods

getField :: PagedJobs -> PagedResponse Job

FromJSON a => FromJSON (PagedResponse a)

Defined in Hercules.API.Paging

Methods

parseJSON :: Value -> Parser (PagedResponse a)

parseJSONList :: Value -> Parser [PagedResponse a]

ToJSON a => ToJSON (PagedResponse a)

Defined in Hercules.API.Paging

Methods

toJSON :: PagedResponse a -> Value

toEncoding :: PagedResponse a -> Encoding

toJSONList :: [PagedResponse a] -> Value

toEncodingList :: [PagedResponse a] -> Encoding

Generic (PagedResponse a)

Defined in Hercules.API.Paging

Associated Types

type Rep (PagedResponse a) :: Type -> Type

Methods

from :: PagedResponse a -> Rep (PagedResponse a) x

to :: Rep (PagedResponse a) x -> PagedResponse a

Show a => Show (PagedResponse a)

Defined in Hercules.API.Paging

Methods

showsPrec :: Int -> PagedResponse a -> ShowS

show :: PagedResponse a -> String

showList :: [PagedResponse a] -> ShowS

NFData a => NFData (PagedResponse a)

Defined in Hercules.API.Paging

Methods

rnf :: PagedResponse a -> ()

Eq a => Eq (PagedResponse a)

Defined in Hercules.API.Paging

Methods

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

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

ToSchema a => ToSchema (PagedResponse a)

Defined in Hercules.API.Paging

Methods

declareNamedSchema :: Proxy (PagedResponse a) -> Declare (Definitions Schema) NamedSchema

ToSchema a => ToSchema (PagedResponse a)

Defined in Hercules.API.Paging

Methods

declareNamedSchema :: Proxy (PagedResponse a) -> Declare (Definitions Schema) NamedSchema

type Rep (PagedResponse a)

Defined in Hercules.API.Paging

type Rep (PagedResponse a) = D1 ('MetaData "PagedResponse" "Hercules.API.Paging" "hercules-ci-api-0.8.4.0-inplace" 'False) (C1 ('MetaCons "PagedResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a]) :*: S1 ('MetaSel ('Just "more") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))