{-# LANGUAGE DeriveAnyClass #-}
{-# LANGUAGE StandaloneDeriving #-}

module Hercules.API.Paging where

import Data.OpenApi qualified as O3
import Hercules.API.Prelude

-- To be used in newtypes only; otherwise the schema will have colliding
-- PagedResponse types.
data PagedResponse a = PagedResponse
  { -- | The items you requested, up to some limit.
    forall a. PagedResponse a -> [a]
items :: [a],
    -- | Whether more items would be returned if it wasn't for the limit.
    forall a. PagedResponse a -> Bool
more :: Bool
  }
  deriving ((forall x. PagedResponse a -> Rep (PagedResponse a) x)
-> (forall x. Rep (PagedResponse a) x -> PagedResponse a)
-> Generic (PagedResponse a)
forall x. Rep (PagedResponse a) x -> PagedResponse a
forall x. PagedResponse a -> Rep (PagedResponse a) x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
forall a x. Rep (PagedResponse a) x -> PagedResponse a
forall a x. PagedResponse a -> Rep (PagedResponse a) x
$cfrom :: forall a x. PagedResponse a -> Rep (PagedResponse a) x
from :: forall x. PagedResponse a -> Rep (PagedResponse a) x
$cto :: forall a x. Rep (PagedResponse a) x -> PagedResponse a
to :: forall x. Rep (PagedResponse a) x -> PagedResponse a
Generic, Int -> PagedResponse a -> ShowS
[PagedResponse a] -> ShowS
PagedResponse a -> String
(Int -> PagedResponse a -> ShowS)
-> (PagedResponse a -> String)
-> ([PagedResponse a] -> ShowS)
-> Show (PagedResponse a)
forall a. Show a => Int -> PagedResponse a -> ShowS
forall a. Show a => [PagedResponse a] -> ShowS
forall a. Show a => PagedResponse a -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: forall a. Show a => Int -> PagedResponse a -> ShowS
showsPrec :: Int -> PagedResponse a -> ShowS
$cshow :: forall a. Show a => PagedResponse a -> String
show :: PagedResponse a -> String
$cshowList :: forall a. Show a => [PagedResponse a] -> ShowS
showList :: [PagedResponse a] -> ShowS
Show, PagedResponse a -> PagedResponse a -> Bool
(PagedResponse a -> PagedResponse a -> Bool)
-> (PagedResponse a -> PagedResponse a -> Bool)
-> Eq (PagedResponse a)
forall a. Eq a => PagedResponse a -> PagedResponse a -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: forall a. Eq a => PagedResponse a -> PagedResponse a -> Bool
== :: PagedResponse a -> PagedResponse a -> Bool
$c/= :: forall a. Eq a => PagedResponse a -> PagedResponse a -> Bool
/= :: PagedResponse a -> PagedResponse a -> Bool
Eq, PagedResponse a -> ()
(PagedResponse a -> ()) -> NFData (PagedResponse a)
forall a. NFData a => PagedResponse a -> ()
forall a. (a -> ()) -> NFData a
$crnf :: forall a. NFData a => PagedResponse a -> ()
rnf :: PagedResponse a -> ()
NFData, [PagedResponse a] -> Value
[PagedResponse a] -> Encoding
PagedResponse a -> Value
PagedResponse a -> Encoding
(PagedResponse a -> Value)
-> (PagedResponse a -> Encoding)
-> ([PagedResponse a] -> Value)
-> ([PagedResponse a] -> Encoding)
-> ToJSON (PagedResponse a)
forall a. ToJSON a => [PagedResponse a] -> Value
forall a. ToJSON a => [PagedResponse a] -> Encoding
forall a. ToJSON a => PagedResponse a -> Value
forall a. ToJSON a => PagedResponse a -> Encoding
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> ToJSON a
$ctoJSON :: forall a. ToJSON a => PagedResponse a -> Value
toJSON :: PagedResponse a -> Value
$ctoEncoding :: forall a. ToJSON a => PagedResponse a -> Encoding
toEncoding :: PagedResponse a -> Encoding
$ctoJSONList :: forall a. ToJSON a => [PagedResponse a] -> Value
toJSONList :: [PagedResponse a] -> Value
$ctoEncodingList :: forall a. ToJSON a => [PagedResponse a] -> Encoding
toEncodingList :: [PagedResponse a] -> Encoding
ToJSON, Value -> Parser [PagedResponse a]
Value -> Parser (PagedResponse a)
(Value -> Parser (PagedResponse a))
-> (Value -> Parser [PagedResponse a])
-> FromJSON (PagedResponse a)
forall a. FromJSON a => Value -> Parser [PagedResponse a]
forall a. FromJSON a => Value -> Parser (PagedResponse a)
forall a.
(Value -> Parser a) -> (Value -> Parser [a]) -> FromJSON a
$cparseJSON :: forall a. FromJSON a => Value -> Parser (PagedResponse a)
parseJSON :: Value -> Parser (PagedResponse a)
$cparseJSONList :: forall a. FromJSON a => Value -> Parser [PagedResponse a]
parseJSONList :: Value -> Parser [PagedResponse a]
FromJSON)

deriving instance (ToSchema a) => ToSchema (PagedResponse a)

deriving instance (O3.ToSchema a) => O3.ToSchema (PagedResponse a)