License	BSD-3-Clause
Maintainer	Oleg Grenrus <oleg.grenrus@iki.fi>
Safe Haskell	None
Language	Haskell2010

GitHub.Data.Request

Contents

Request
Smart constructors
Auxiliary types

Description

Synopsis

Request

data Request (k :: RW) a where Source #

Github request data type.

k describes whether authentication is required. It's required for non-GET requests.
a is the result type

Note: Request is not Functor on purpose.

Constructors

SimpleQuery :: FromJSON a => SimpleRequest k a -> Request k a
StatusQuery :: StatusMap a -> SimpleRequest k () -> Request k a
HeaderQuery :: FromJSON a => RequestHeaders -> SimpleRequest k a -> Request k a
RedirectQuery :: SimpleRequest k () -> Request k URI

Instances

Eq a => Eq (Request k a) Source #
Methods (==) :: Request k a -> Request k a -> Bool # (/=) :: Request k a -> Request k a -> Bool #
Ord a => Ord (Request k a) Source #
Methods compare :: Request k a -> Request k a -> Ordering # (<) :: Request k a -> Request k a -> Bool # (<=) :: Request k a -> Request k a -> Bool # (>) :: Request k a -> Request k a -> Bool # (>=) :: Request k a -> Request k a -> Bool # max :: Request k a -> Request k a -> Request k a # min :: Request k a -> Request k a -> Request k a #
Show (Request k a) Source #
Methods showsPrec :: Int -> Request k a -> ShowS # show :: Request k a -> String # showList :: [Request k a] -> ShowS #
Hashable (Request k a) Source #
Methods hashWithSalt :: Int -> Request k a -> Int # hash :: Request k a -> Int #

data SimpleRequest (k :: RW) a where Source #

Constructors

Query :: Paths -> QueryString -> SimpleRequest k a
PagedQuery :: Paths -> QueryString -> FetchCount -> SimpleRequest k (Vector a)
Command :: CommandMethod a -> Paths -> ByteString -> SimpleRequest RW a

Instances

Eq a => Eq (SimpleRequest k a) Source #
Methods (==) :: SimpleRequest k a -> SimpleRequest k a -> Bool # (/=) :: SimpleRequest k a -> SimpleRequest k a -> Bool #
Ord a => Ord (SimpleRequest k a) Source #
Methods compare :: SimpleRequest k a -> SimpleRequest k a -> Ordering # (<) :: SimpleRequest k a -> SimpleRequest k a -> Bool # (<=) :: SimpleRequest k a -> SimpleRequest k a -> Bool # (>) :: SimpleRequest k a -> SimpleRequest k a -> Bool # (>=) :: SimpleRequest k a -> SimpleRequest k a -> Bool # max :: SimpleRequest k a -> SimpleRequest k a -> SimpleRequest k a # min :: SimpleRequest k a -> SimpleRequest k a -> SimpleRequest k a #
Show (SimpleRequest k a) Source #
Methods showsPrec :: Int -> SimpleRequest k a -> ShowS # show :: SimpleRequest k a -> String # showList :: [SimpleRequest k a] -> ShowS #
Hashable (SimpleRequest k a) Source #
Methods hashWithSalt :: Int -> SimpleRequest k a -> Int # hash :: SimpleRequest k a -> Int #

Smart constructors

query :: FromJSON a => Paths -> QueryString -> Request k a Source #

pagedQuery :: FromJSON a => Paths -> QueryString -> FetchCount -> Request k (Vector a) Source #

command :: FromJSON a => CommandMethod a -> Paths -> ByteString -> Request RW a Source #

Auxiliary types

data RW Source #

Type used as with DataKinds to tag whether requests need authentication or aren't read-only.

Constructors

RO	Read-only, doesn't necessarily requires authentication
RA	Read autenticated
RW	Read-write, requires authentication

Instances

Bounded RW Source #
Methods minBound :: RW # maxBound :: RW #
Enum RW Source #
Methods succ :: RW -> RW # pred :: RW -> RW # toEnum :: Int -> RW # fromEnum :: RW -> Int # enumFrom :: RW -> [RW] # enumFromThen :: RW -> RW -> [RW] # enumFromTo :: RW -> RW -> [RW] # enumFromThenTo :: RW -> RW -> RW -> [RW] #
Eq RW Source #
Methods (==) :: RW -> RW -> Bool # (/=) :: RW -> RW -> Bool #
Data RW Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RW -> c RW # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RW # toConstr :: RW -> Constr # dataTypeOf :: RW -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c RW) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RW) # gmapT :: (forall b. Data b => b -> b) -> RW -> RW # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RW -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RW -> r # gmapQ :: (forall d. Data d => d -> u) -> RW -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RW -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RW -> m RW # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RW -> m RW # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RW -> m RW #
Ord RW Source #
Methods compare :: RW -> RW -> Ordering # (<) :: RW -> RW -> Bool # (<=) :: RW -> RW -> Bool # (>) :: RW -> RW -> Bool # (>=) :: RW -> RW -> Bool # max :: RW -> RW -> RW # min :: RW -> RW -> RW #
Read RW Source #
Methods readsPrec :: Int -> ReadS RW # readList :: ReadS [RW] # readPrec :: ReadPrec RW # readListPrec :: ReadPrec [RW] #
Show RW Source #
Methods showsPrec :: Int -> RW -> ShowS # show :: RW -> String # showList :: [RW] -> ShowS #
Generic RW Source #
Associated Types type Rep RW :: * -> * # Methods from :: RW -> Rep RW x # to :: Rep RW x -> RW #
type Rep RW Source #
type Rep RW = D1 * (MetaData "RW" "GitHub.Data.Request" "github-0.19-HK5gGFVL8du3RBT4q9vA87" False) ((:+:) * (C1 * (MetaCons "RO" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "RA" PrefixI False) (U1 )) (C1 (MetaCons "RW" PrefixI False) (U1 *))))

type StatusMap a = [(Int, a)] Source #

statusOnlyOk :: StatusMap Bool Source #

data CommandMethod a where Source #

Http method of requests with body.

Constructors

Post :: CommandMethod a
Patch :: CommandMethod a
Put :: CommandMethod a
Put' :: CommandMethod ()
Delete :: CommandMethod ()

Instances

Eq (CommandMethod a) Source #
Methods (==) :: CommandMethod a -> CommandMethod a -> Bool # (/=) :: CommandMethod a -> CommandMethod a -> Bool #
Ord (CommandMethod a) Source #
Methods compare :: CommandMethod a -> CommandMethod a -> Ordering # (<) :: CommandMethod a -> CommandMethod a -> Bool # (<=) :: CommandMethod a -> CommandMethod a -> Bool # (>) :: CommandMethod a -> CommandMethod a -> Bool # (>=) :: CommandMethod a -> CommandMethod a -> Bool # max :: CommandMethod a -> CommandMethod a -> CommandMethod a # min :: CommandMethod a -> CommandMethod a -> CommandMethod a #
Show (CommandMethod a) Source #
Methods showsPrec :: Int -> CommandMethod a -> ShowS # show :: CommandMethod a -> String # showList :: [CommandMethod a] -> ShowS #
Hashable (CommandMethod a) Source #
Methods hashWithSalt :: Int -> CommandMethod a -> Int # hash :: CommandMethod a -> Int #

toMethod :: CommandMethod a -> Method Source #

data FetchCount Source #

PagedQuery returns just some results, using this data we can specify how many pages we want to fetch.

Constructors

FetchAtLeast !Word
FetchAll

Instances

Eq FetchCount Source #
Methods (==) :: FetchCount -> FetchCount -> Bool # (/=) :: FetchCount -> FetchCount -> Bool #
Num FetchCount Source #	This instance is there mostly for `fromInteger`.
Methods (+) :: FetchCount -> FetchCount -> FetchCount # (-) :: FetchCount -> FetchCount -> FetchCount # (*) :: FetchCount -> FetchCount -> FetchCount # negate :: FetchCount -> FetchCount # abs :: FetchCount -> FetchCount # signum :: FetchCount -> FetchCount # fromInteger :: Integer -> FetchCount #
Ord FetchCount Source #
Methods compare :: FetchCount -> FetchCount -> Ordering # (<) :: FetchCount -> FetchCount -> Bool # (<=) :: FetchCount -> FetchCount -> Bool # (>) :: FetchCount -> FetchCount -> Bool # (>=) :: FetchCount -> FetchCount -> Bool # max :: FetchCount -> FetchCount -> FetchCount # min :: FetchCount -> FetchCount -> FetchCount #
Read FetchCount Source #
Methods readsPrec :: Int -> ReadS FetchCount # readList :: ReadS [FetchCount] # readPrec :: ReadPrec FetchCount # readListPrec :: ReadPrec [FetchCount] #
Show FetchCount Source #
Methods showsPrec :: Int -> FetchCount -> ShowS # show :: FetchCount -> String # showList :: [FetchCount] -> ShowS #
Generic FetchCount Source #
Associated Types type Rep FetchCount :: * -> * # Methods from :: FetchCount -> Rep FetchCount x # to :: Rep FetchCount x -> FetchCount #
Hashable FetchCount Source #
Methods hashWithSalt :: Int -> FetchCount -> Int # hash :: FetchCount -> Int #
Binary FetchCount Source #
Methods put :: FetchCount -> Put # get :: Get FetchCount # putList :: [FetchCount] -> Put #
NFData FetchCount Source #
Methods rnf :: FetchCount -> () #
type Rep FetchCount Source #
type Rep FetchCount = D1 * (MetaData "FetchCount" "GitHub.Data.Request" "github-0.19-HK5gGFVL8du3RBT4q9vA87" False) ((:+:) * (C1 * (MetaCons "FetchAtLeast" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Word))) (C1 * (MetaCons "FetchAll" PrefixI False) (U1 *)))

type Paths = [Text] Source #

class IsPathPart a where Source #

Minimal complete definition

toPathPart

Methods

toPathPart :: a -> Text Source #

Instances

IsPathPart ArchiveFormat Source #
Methods toPathPart :: ArchiveFormat -> Text Source #
IsPathPart (Name a) Source #
Methods toPathPart :: Name a -> Text Source #
IsPathPart (Id a) Source #
Methods toPathPart :: Id a -> Text Source #

type QueryString = [(ByteString, Maybe ByteString)] Source #

Request query string

type Count = Int Source #

Count of elements