GitHub.Data.Request

Request

data Request (k :: RW) a where

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)

Defined in GitHub.Data.Request

Methods

(==) :: Request k a -> Request k a -> Bool

(/=) :: Request k a -> Request k a -> Bool

Ord a => Ord (Request k a)

Defined in GitHub.Data.Request

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)

Defined in GitHub.Data.Request

Methods

showsPrec :: Int -> Request k a -> ShowS

show :: Request k a -> String

showList :: [Request k a] -> ShowS

Hashable (Request k a)

Defined in GitHub.Data.Request

Methods

hashWithSalt :: Int -> Request k a -> Int

hash :: Request k a -> Int

data SimpleRequest (k :: RW) a where

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)

Defined in GitHub.Data.Request

Methods

(==) :: SimpleRequest k a -> SimpleRequest k a -> Bool

(/=) :: SimpleRequest k a -> SimpleRequest k a -> Bool

Ord a => Ord (SimpleRequest k a)

Defined in GitHub.Data.Request

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)

Defined in GitHub.Data.Request

Methods

showsPrec :: Int -> SimpleRequest k a -> ShowS

show :: SimpleRequest k a -> String

showList :: [SimpleRequest k a] -> ShowS

Hashable (SimpleRequest k a)

Defined in GitHub.Data.Request

Methods

hashWithSalt :: Int -> SimpleRequest k a -> Int

hash :: SimpleRequest k a -> Int

Smart constructors

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

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

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

Auxiliary types

data RW

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

Defined in GitHub.Data.Request

Methods

minBound :: RW

maxBound :: RW

Enum RW

Defined in GitHub.Data.Request

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

Defined in GitHub.Data.Request

Methods

(==) :: RW -> RW -> Bool

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

Data RW

Defined in GitHub.Data.Request

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

Defined in GitHub.Data.Request

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

Defined in GitHub.Data.Request

Methods

readsPrec :: Int -> ReadS RW

readList :: ReadS [RW]

readPrec :: ReadPrec RW

readListPrec :: ReadPrec [RW]

Show RW

Defined in GitHub.Data.Request

Methods

showsPrec :: Int -> RW -> ShowS

show :: RW -> String

showList :: [RW] -> ShowS

Generic RW

Defined in GitHub.Data.Request

Associated Types

type Rep RW :: * -> *

Methods

from :: RW -> Rep RW x

to :: Rep RW x -> RW

type Rep RW

Defined in GitHub.Data.Request

type Rep RW = D1 (MetaData "RW" "GitHub.Data.Request" "github-0.20-LpKGfLbWVDaCmfioJOVpjl" False) (C1 (MetaCons "RO" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "RA" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RW" PrefixI False) (U1 :: * -> *)))

type StatusMap a = [(Int, a)]

statusOnlyOk :: StatusMap Bool

data CommandMethod a where

Http method of requests with body.

Constructors

Post :: CommandMethod a

Patch :: CommandMethod a

Put :: CommandMethod a

Put' :: CommandMethod ()

Delete :: CommandMethod ()

Instances

Eq (CommandMethod a)

Defined in GitHub.Data.Request

Methods

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

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

Ord (CommandMethod a)

Defined in GitHub.Data.Request

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)

Defined in GitHub.Data.Request

Methods

showsPrec :: Int -> CommandMethod a -> ShowS

show :: CommandMethod a -> String

showList :: [CommandMethod a] -> ShowS

Hashable (CommandMethod a)

Defined in GitHub.Data.Request

Methods

hashWithSalt :: Int -> CommandMethod a -> Int

hash :: CommandMethod a -> Int

toMethod :: CommandMethod a -> Method

data FetchCount

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

Defined in GitHub.Data.Request

Methods

(==) :: FetchCount -> FetchCount -> Bool

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

Num FetchCount

This instance is there mostly for fromInteger.

Defined in GitHub.Data.Request

Methods

(+) :: FetchCount -> FetchCount -> FetchCount

(-) :: FetchCount -> FetchCount -> FetchCount

(*) :: FetchCount -> FetchCount -> FetchCount

negate :: FetchCount -> FetchCount

abs :: FetchCount -> FetchCount

signum :: FetchCount -> FetchCount

fromInteger :: Integer -> FetchCount

Ord FetchCount

Defined in GitHub.Data.Request

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

Defined in GitHub.Data.Request

Methods

readsPrec :: Int -> ReadS FetchCount

readList :: ReadS [FetchCount]

readPrec :: ReadPrec FetchCount

readListPrec :: ReadPrec [FetchCount]

Show FetchCount

Defined in GitHub.Data.Request

Methods

showsPrec :: Int -> FetchCount -> ShowS

show :: FetchCount -> String

showList :: [FetchCount] -> ShowS

Generic FetchCount

Defined in GitHub.Data.Request

Associated Types

type Rep FetchCount :: * -> *

Methods

from :: FetchCount -> Rep FetchCount x

to :: Rep FetchCount x -> FetchCount

Hashable FetchCount

Defined in GitHub.Data.Request

Methods

hashWithSalt :: Int -> FetchCount -> Int

hash :: FetchCount -> Int

Binary FetchCount

Defined in GitHub.Data.Request

Methods

put :: FetchCount -> Put

get :: Get FetchCount

putList :: [FetchCount] -> Put

NFData FetchCount

Defined in GitHub.Data.Request

Methods

rnf :: FetchCount -> ()

type Rep FetchCount

Defined in GitHub.Data.Request

type Rep FetchCount = D1 (MetaData "FetchCount" "GitHub.Data.Request" "github-0.20-LpKGfLbWVDaCmfioJOVpjl" False) (C1 (MetaCons "FetchAtLeast" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word)) :+: C1 (MetaCons "FetchAll" PrefixI False) (U1 :: * -> *))

type Paths = [Text]

class IsPathPart a where

Minimal complete definition

toPathPart

Methods

toPathPart :: a -> Text

Instances

IsPathPart ArchiveFormat

Defined in GitHub.Data.Repos

Methods

toPathPart :: ArchiveFormat -> Text

IsPathPart (Name a)

Defined in GitHub.Data.Request

Methods

toPathPart :: Name a -> Text

IsPathPart (Id a)

Defined in GitHub.Data.Request

Methods

toPathPart :: Id a -> Text

type QueryString = [(ByteString, Maybe ByteString)]

Request query string

type Count = Int

Count of elements